<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
  <refentry id="function.mysqli-report">
   <refnamediv>
    <refname>mysqli_report</refname>
    <refpurpose>enables or disables internal report functions</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>mysqli_report</methodname>
      <methodparam><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>mysqli_report</function> is a powerful function to improve your queries
     and code during development and testing phase. Depending on the flags it reports
     errors from mysqli function calls or queries which don't use an index (or use a bad
     index).
    </para>
    <table>
     <title>Supported flags</title>
     <tgroup cols='2'>
     <thead>
      <row>
       <entry>Name</entry>
       <entry>Description</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>MYSQLI_REPORT_OFF</literal></entry>
       <entry>Turns reporting off</entry>
      </row>
      <row>
       <entry><literal>MYSQLI_REPORT_ERROR</literal></entry>
       <entry>Report errors from mysqli function calls</entry>
      </row>
      <row>
       <entry><literal>MYSQLI_REPORT_INDEX</literal></entry>
       <entry>Report if no index or bad index was used in a query</entry>
      </row>
      <row>
       <entry><literal>MYSQLI_REPORT_ALL</literal></entry>
       <entry>Set all options (report all)</entry>
      </row>
     </tbody>
    </tgroup>
    </table>
   </refsect1>
   <refsect1>
    <title>Return values</title>
    <para>&return.success;</para>
   </refsect1>
   <refsect1>
    <title>See also</title>
    <para>
     <function>mysqli_debug</function>,
     <function>mysqli_dump_debug_info</function>
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <para>
     <example>
      <title>Object oriented style</title>
      <programlisting role="php">
<![CDATA[
<?php
/* activate reporting */
mysqli_report(MYSQLI_REPORT_ALL);

$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

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

/* this query should report an error */
$result = $mysqli->query("SELECT Name FROM Nonexistingtable WHERE population > 50000");

/* this query should report a warning */
$result = $mysqli->query("SELECT Name FROM City WHERE population > 50000");
$result->close();

$mysqli->close();
?>
]]>
      </programlisting>
     </example>
    </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:"../../../../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
-->