From 8120ed889535a518bc416b30c8f0f2a217edd344 Mon Sep 17 00:00:00 2001
From: Jan Lehnardt <jan@php.net>
Date: Fri, 29 Mar 2002 12:47:31 +0000
Subject: [PATCH]  - documenting mysql_info

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@75773 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/mysql.xml | 57 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/functions/mysql.xml b/functions/mysql.xml
index 82dceba070..761cd21e99 100644
--- a/functions/mysql.xml
+++ b/functions/mysql.xml
@@ -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>
@@ -1561,6 +1561,61 @@ mysql_close();
    </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>
+
   <refentry id="function.mysql-insert-id">
    <refnamediv>
     <refname>mysql_insert_id</refname>