php-doc-en/reference/mysqli/functions/mysqli-info.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
  <refentry id="function.mysqli-info">
   <refnamediv>
    <refname>mysqli_info</refname>
    <refname>mysqli->info</refname>
    <refpurpose>Retrieves information about the most recently executed query</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <para>Procedural style:</para>
     <methodsynopsis>
      <type>string</type><methodname>mysqli_info</methodname>
      <methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
     <para>Object oriented style (property)</para>
     <classsynopsis>
      <ooclass><classname>mysqli</classname></ooclass>
       <fieldsynopsis><type>string</type><varname>info</varname></fieldsynopsis>
     </classsynopsis>
    <para>
     The <function>mysqli_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 mysqli_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>mysqli_info</function> will return an empty string. 
     </para>
    </note>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
     A character string representing additional information about the most recently executed query. 
    </para>
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <para>
     <function>mysqli_affected_rows</function>,
     <function>mysqli_warning_count</function>&listendand;
     <function>mysqli_num_rows</function>.
    </para>
   </refsect1>
   <refsect1>
    &reftitle.examples;
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

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

$mysqli->query("CREATE TEMPORARY TABLE t1 LIKE City");

/* INSERT INTO .. SELECT */
$mysqli->query("INSERT INTO t1 SELECT * FROM City ORDER BY ID LIMIT 150");
printf("%s\n", $mysqli->info);

/* close connection */
$mysqli->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

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

mysqli_query($link, "CREATE TEMPORARY TABLE t1 LIKE City");

/* INSERT INTO .. SELECT */
mysqli_query($link, "INSERT INTO t1 SELECT * FROM City ORDER BY ID LIMIT 150");
printf("%s\n", mysqli_info($link));

/* close connection */
mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    &example.outputs;
    <screen>
<![CDATA[
Records: 150  Duplicates: 0  Warnings: 0
]]>
    </screen>
   </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:"../../../../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
-->