cvs: phpdoc /en/functions mysql.xml

jan Fri Mar 29 07:47:31 2002 EDT Modified files: /phpdoc/en/functions mysql.xml Log: - documenting mysql_info Index: phpdoc/en/functions/mysql.xml diff -u phpdoc/en/functions/mysql.xml:1.101 phpdoc/en/functions/mysql.xml:1.102 --- phpdoc/en/functions/mysql.xml:1.101 Mon Mar 25 15:26:03 2002 +++ phpdoc/en/functions/mysql.xml Fri Mar 29 07:47:31 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.101 $ --> +<!-- $Revision: 1.102 $ --> <reference id="ref.mysql"> <title>MySQL Functions</title> <titleabbrev>MySQL</titleabbrev> @@ -1558,6 +1558,61 @@ For downward compatibility <function>mysql_freeresult</function> can also be used. This is deprecated, however. </para> + </refsect1> + </refentry> + + <refentry id="function.mysql-info"> + <refnamediv> + <refname>mysql_info</refname> + <refpurpose> + Get information about the most recent query + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>mysql_info</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> + <para> + <function>mysql_info</function> returns detailed information about + the last query using the given <parameter>link_identifier</parameter>. + If <parameter>link_identifier</parameter> isn't specified, the last + opened link is assumed. + </para> + <para> + <function>mysql_info</function> returns a string for all statements + listed below. For all other &false;. The string format depends on the + given statement. + <example> + <title>Relevant MySQL Statements</title> + <programlisting role="mysql"> +<![CDATA[ +INSERT INTO ... SELECT ... +String format: Records: 23 Duplicates: 0 Warnings: 0 +INSERT INTO ... VALUES (...),(...),(...)... +String format: Records: 37 Duplicates: 0 Warnings: 0 +LOAD DATA INFILE ... +String format: Records: 42 Deleted: 0 Skipped: 0 Warnings: 0 +ALTER TABLE +String format: Records: 60 Duplicates: 0 Warnings: 0 +UPDATE +String format: Rows matched: 65 Changed: 65 Warnings: 0 +]]> + </programlisting> + </example> + The numbers are only for illustrating purpose; their values will + correspond to the query. + </para> + <note> + <para> + <function>mysql_info</function> returns a non-&false; value for the + INSERT ... VALUES statement only if multiple value lists are + specified in the statement. + </para> + </note> </refsect1> </refentry>