<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-info">
 <refnamediv>
  <refname>maxdb_info</refname>
  <refname>maxdb::info</refname>
  <refpurpose>Retrieves information about the most recently executed query</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type>string</type><methodname>maxdb_info</methodname>
   <methodparam><type>resource</type><parameter>link</parameter></methodparam>
  </methodsynopsis>
  <para>&style.oop;</para>
  <fieldsynopsis><type>string</type><varname>maxdb->info</varname></fieldsynopsis>
  <para>
   The <function>maxdb_info</function> function returns a string providing
   information about the last query executed. The nature of this string is
   provided below:
  </para>
  <para>
   <table>
    <title>Possible maxdb_info return values</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Query type</entry>
       <entry>Example result string</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>INSERT INTO...SELECT...</entry>
       <entry>Records: 100 Duplicates: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>INSERT INTO...VALUES (...),(...),(...)</entry>
       <entry>Records: 3 Duplicates: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>LOAD DATA INFILE ...</entry>
       <entry>Records: 1 Deleted: 0 Skipped: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>ALTER TABLE ...</entry>
       <entry>Records: 3 Duplicates: 0 Warnings: 0</entry>
      </row>
      <row>
       <entry>UPDATE ...</entry>
       <entry>Rows matched: 40 Changed: 40 Warnings: 0</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <note>
   <para>
    Queries which do not fall into one of the above formats are not supported.
    In these situations, <function>maxdb_info</function> will return an empty string.
   </para>
  </note>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A character string representing additional information about the most recently executed query.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>&style.oop;</title>
   <programlisting role="php">
<![CDATA[
<?php
$maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB");

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

$maxdb->query("CREATE TABLE temp.t1 LIKE hotel.city");

/* INSERT INTO .. SELECT */
$maxdb->query("INSERT INTO temp.t1 SELECT * FROM hotel.city");
printf("%s\n", $maxdb->info);

/* close connection */
$maxdb->close();
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>&style.procedural;</title>
   <programlisting role="php">
<![CDATA[
<?php
$link = maxdb_connect("localhost", "MONA", "RED", "DEMODB");

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

maxdb_query($link, "CREATE TABLE temp.t1 LIKE hotel.city");

/* INSERT INTO .. SELECT */
maxdb_query($link, "INSERT INTO temp.t1 SELECT * FROM hotel.city");
printf("%s\n", maxdb_info($link));

/* close connection */
maxdb_close($link);
?>
]]>
   </programlisting>
  </example>
  &example.outputs.similar;
  <screen>
<![CDATA[
Records: 25 Duplicates: 0 Warnings: 0
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>maxdb_affected_rows</function></member>
    <member><function>maxdb_warning_count</function></member>
    <member><function>maxdb_num_rows</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->