svn commit - mysqldoc@docsrva: r5256 - in trunk: . refman-5.0

[paul]

Author: paul
Date: 2007-03-08 19:42:51 +0100 (Thu, 08 Mar 2007)
New Revision: 5256

Log:
 r17415@frost:  paul | 2007-03-08 12:40:53 -0600
 Fix error in SHOW PROFILE syntax.
 Add information describing the optional SHOW PROFILE clauses.


Modified:
   trunk/refman-5.0/sql-syntax.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:21154
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:17402
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:14593
   + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:21154
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:17415
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:14593


Modified: trunk/refman-5.0/sql-syntax.xml
===================================================================
--- trunk/refman-5.0/sql-syntax.xml	2007-03-08 17:15:26 UTC (rev 5255)
+++ trunk/refman-5.0/sql-syntax.xml	2007-03-08 18:42:51 UTC (rev 5256)
Changed blocks: 5, Lines Added: 102, Lines Deleted: 10; 5281 bytes

@@ -18791,8 +18791,7 @@
 
 SHOW PROFILE [<replaceable>type</replaceable> [,
<replaceable>type</replaceable>] ... ]
     [FOR QUERY <replaceable>n</replaceable>]
-    [OFFSET <replaceable>n</replaceable>]
-    [LIMIT <replaceable>n</replaceable>]
+    [LIMIT <replaceable>n</replaceable> [OFFSET
<replaceable>n</replaceable>]]
 
 <replaceable>type</replaceable>:
     ALL

@@ -18816,8 +18815,10 @@
         </para>
 
         <para>
-          Profiling is disabled by default. It can be enabled using the
-          <literal>profiling</literal> session variable:
+          Profiling is controlled by the <literal>profiling</literal>
+          session variable, which has a default value of 0
+          (<literal>OFF</literal>). Profiling is enabled by setting
+          <literal>profiling</literal> to 1 or
<literal>ON</literal>:
         </para>
 
 <programlisting>

@@ -18826,7 +18827,7 @@
 
         <para>
           <literal>SHOW PROFILES</literal> displays a list of the most
-          recent queries sent to the master. The size of the list is
+          recent statements sent to the master. The size of the list is
           controlled by the <literal>profiling_history_size</literal>
           session variable, which has a default value of 15. The maximum
           value is 100. Setting the value to 0 has the practical effect

@@ -18834,11 +18835,6 @@
         </para>
 
         <para>
-          <literal>SHOW PROFILE</literal> without options refers to the
-          last statement executed.
-        </para>
-
-        <para>
           All statements are profiled except <literal>SHOW
           PROFILES</literal> and <literal>SHOW PROFILE</literal>, so
you
           will find neither of those statements in the profile list.

@@ -18849,6 +18845,102 @@
         </para>
 
         <para>
+          <literal>SHOW PROFILE</literal> displays detailed information
+          about a single statement. Without the <literal>FOR QUERY
+          <replaceable>n</replaceable></literal> clause, the output
+          pertains to the most recently executed statement. If
+          <literal>FOR QUERY
<replaceable>n</replaceable></literal> is
+          included, <literal>SHOW PROFILE</literal> displays information
+          for statement <replaceable>n</replaceable>. The values of
+          <replaceable>n</replaceable> correspond to the
+          <literal>Query_ID</literal> values displayed by <literal>SHOW
+          PROFILES</literal>.
+        </para>
+
+        <para>
+          The <literal>LIMIT
<replaceable>n</replaceable></literal>
+          clause may be given to limit the output to
+          <replaceable>n</replaceable> rows. If
<literal>LIMIT</literal>
+          is given, <literal>OFFSET
+          <replaceable>n</replaceable></literal> may be added to begin
+          the output <replaceable>n</replaceable> rows into the full set
+          of rows.
+        </para>
+
+        <para>
+          By default, <literal>SHOW PROFILE</literal> displays
+          <literal>Status</literal> and
<literal>Duration</literal>
+          columns. Optional <replaceable>type</replaceable> values may
+          be specified to display specific additional types of
+          information:
+        </para>
+
+        <itemizedlist>
+
+          <listitem>
+            <para>
+              <literal>ALL</literal> displays all information
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>BLOCK IO</literal> displays counts for block
+              input and output operations
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>CONTEXT SWITCHES</literal> displays counts for
+              voluntary and involuntary context switches
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>CPU</literal> displays user and system CPU usage
+              times
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>IPC</literal> displays counts for messages sent
+              and received
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>MEMORY</literal> is not currently implemented
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>PAGE FAULTS</literal> displays counts for major
+              and minor page faults
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>SOURCE</literal> displays the names of functions
+              from the source code, together with the name and line
+              number of the file in which the function occurs
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <literal>SWAPS</literal> displays swap counts
+            </para>
+          </listitem>
+
+        </itemizedlist>
+
+        <para>
           Profiling is enabled per session. When a session ends, its
           profiling information is lost.
         </para>