debug.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli.debug" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysqli::debug</refname>
  <refname>mysqli_debug</refname>
  <refpurpose>Performs debugging operations</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="oop">
   <modifier>public</modifier> <type>bool</type><methodname>mysqli::debug</methodname>
   <methodparam><type>string</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis role="procedural">
   <type>bool</type><methodname>mysqli_debug</methodname>
   <methodparam><type>string</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Performs debugging operations using the Fred Fish debugging library.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       A string representing the debugging operation to perform
      </para>
      <para>
        The debug control string is a sequence of colon separated fields as follows:
        <literal><![CDATA[<field_1>:<field_2>:<field_N>]]></literal>
        Each field consists of a mandatory flag character followed by an optional <literal>,</literal> and comma separated list of modifiers:
        <literal>flag[,modifier,modifier,...,modifier]</literal>
      </para>
      <para>
       <table>
        <title>Recognized Flag Characters</title>
          <tgroup cols="2">
            <thead>
              <row>
                <entry><parameter>option</parameter> character</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>O</entry>
                <entry><constant>MYSQLND_DEBUG_FLUSH</constant></entry>
              </row>
              <row>
                <entry>A/a</entry>
                <entry><constant>MYSQLND_DEBUG_APPEND</constant></entry>
              </row>
              <row>
                <entry>F</entry>
                <entry><constant>MYSQLND_DEBUG_DUMP_FILE</constant></entry>
              </row>
              <row>
                <entry>i</entry>
                <entry><constant>MYSQLND_DEBUG_DUMP_PID</constant></entry>
              </row>
              <row>
                <entry>L</entry>
                <entry><constant>MYSQLND_DEBUG_DUMP_LINE</constant></entry>
              </row>
              <row>
                <entry>m</entry>
                <entry><constant>MYSQLND_DEBUG_TRACE_MEMORY_CALLS</constant></entry>
              </row>
              <row>
                <entry>n</entry>
                <entry><constant>MYSQLND_DEBUG_DUMP_LEVEL</constant></entry>
              </row>
              <row>
                <entry>o</entry>
                <entry>output to file</entry>
              </row>
              <row>
                <entry>T</entry>
                <entry><constant>MYSQLND_DEBUG_DUMP_TIME</constant></entry>
              </row>
              <row>
                <entry>t</entry>
                <entry><constant>MYSQLND_DEBUG_DUMP_TRACE</constant></entry>
              </row>
              <row>
                <entry>x</entry>
                <entry><constant>MYSQLND_DEBUG_PROFILE_CALLS</constant></entry>
              </row>
            </tbody>
          </tgroup>
        </table>
       </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Generating a Trace File</title>
    <programlisting role="php">
<![CDATA[
<?php

/* Create a trace file in '/tmp/client.trace' on the local (client) machine: */
mysqli_debug("d:t:o,/tmp/client.trace");

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    To use the <function>mysqli_debug</function> function you must compile
    the MySQL client library to support debugging.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysqli_dump_debug_info</function></member>
    <member><function>mysqli_report</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
-->