Author: paul
Date: 2007-03-28 00:24:01 +0200 (Wed, 28 Mar 2007)
New Revision: 5582
Log:
r18242@frost: paul | 2007-03-27 16:28:23 -0500
Move a section.
Modified:
trunk/refman-4.1/client-utility-programs.xml
trunk/refman-5.0/client-utility-programs.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:22309
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:18240
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:22309
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:18242
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:14593
Modified: trunk/refman-4.1/client-utility-programs.xml
===================================================================
--- trunk/refman-4.1/client-utility-programs.xml 2007-03-27 21:23:43 UTC (rev 5581)
+++ trunk/refman-4.1/client-utility-programs.xml 2007-03-27 22:24:01 UTC (rev 5582)
Changed blocks: 6, Lines Added: 239, Lines Deleted: 239; 17134 bytes
@@ -177,22 +177,6 @@
<listitem>
<para>
<indexterm>
- <primary>mysql_explain_log</primary>
- </indexterm>
-
- <command>mysql_explain_log</command>
- </para>
-
- <para>
- A utility that analyzes queries in the MySQL query log using
- <literal>EXPLAIN</literal> See
- <xref linkend="mysql-explain-log"/>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
<primary>mysqlaccess</primary>
</indexterm>
@@ -339,6 +323,22 @@
<listitem>
<para>
<indexterm>
+ <primary>mysql_explain_log</primary>
+ </indexterm>
+
+ <command>mysql_explain_log</command>
+ </para>
+
+ <para>
+ A utility that analyzes queries in the MySQL query log using
+ <literal>EXPLAIN</literal> See
+ <xref linkend="mysql-explain-log"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
<primary>mysql_setpermission</primary>
</indexterm>
@@ -1207,7 +1207,7 @@
<command>myisamchk</command>, see
<xref linkend="myisamchk-memory"/>.
</para>
-
+
<important>
<para>
<emphasis>You must ensure that no other program is using the
@@ -1217,38 +1217,38 @@
running <command>myisamchk</command>, or to lock all tables
that <command>myisamchk</command> is being used on.
</para>
-
+
<para>
Otherwise, when you run <command>myisamchk</command>, it may
- display the following error message:
+ display the following error message:
</para>
-
+
<programlisting>
warning: clients are using or haven't closed the table properly
</programlisting>
-
+
<para>
- This means that you are trying to check a table that has been
- updated by another program (such as the
+ This means that you are trying to check a table that has
+ been updated by another program (such as the
<command>mysqld</command> server) that hasn't yet closed the
file or that has died without closing the file properly,
which can sometimes lead to the corruption of one or more
<literal>MyISAM</literal> tables.
</para>
-
+
<para>
If <command>mysqld</command> is running, you must force it
to flush any table modifications that are still buffered in
memory by using <literal>FLUSH TABLES</literal>. You should
then ensure that no one is using the tables while you are
- running <command>myisamchk</command>
+ running <command>myisamchk</command>
</para>
-
+
<para>
However, the easiest way to avoid this problem is to use
<literal>CHECK TABLE</literal> instead of
- <command>myisamchk</command> to check tables. See
- <xref linkend="check-table"/>.
+ <command>myisamchk</command> to check tables. See
+ <xref linkend="check-table"/>.
</para>
</important>
@@ -6217,217 +6217,6 @@
</section>
- <section id="fake-id-for-mysql-explain-log-manpage-section-wrapper">
-
- <title>fake title for mysql_explain_log manpage section wrapper</title>
-
- <refentry id="mysql-explain-log">
-
- <indexterm>
- <primary>mysql_explain_log</primary>
- </indexterm>
-
- <refmeta>
-
<refentrytitle><command>mysql_explain_log</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Use EXPLAIN on Statements in Query
Log</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>mysql_explain_log</refname>
-
- <refpurpose>use EXPLAIN on statements in query log</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsection id="mysql-explain-log-description">
-
- <title>Description</title>
-
- <para>
- <command>mysql_explain_log</command> reads its standard input
- for query log contents. It uses <literal>EXPLAIN</literal> to
- analyze <literal>SELECT</literal> statements found in the
- input. <literal>UPDATE</literal> statements are rewritten to
- <literal>SELECT</literal> statements and also analyzed with
- <literal>EXPLAIN</literal>.
- <command>mysql_explain_log</command> then displays a summary
- of its results.
- </para>
-
- <para>
- The results may assist you in determining which queries result
- in table scans and where it would be beneficial to add indexes
- to your tables.
- </para>
-
- <para>
- Invoke <command>mysql_explain_log</command> like this, where
- <replaceable>log_file</replaceable> contains all or part of a
- MySQL query log:
- </para>
-
-<programlisting>
-shell> <userinput>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></userinput>
-</programlisting>
-
- <para>
- <command>mysql_explain_log</command> understands the following
- options:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>date option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>date option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--date=<replaceable>YYMMDD</replaceable></option>,
- <option>-d
<replaceable>YYMMDD</replaceable></option>
- </para>
-
- <para>
- Select entries from the log only for the given date.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>host option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>host option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--host=<replaceable>host_name</replaceable></option>,
- <option>-h
<replaceable>host_name</replaceable></option>
- </para>
-
- <para>
- Connect to the MySQL server on the given host.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>password option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>password option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--password=<replaceable>password</replaceable></option>,
- <option>-p
<replaceable>password</replaceable></option>
- </para>
-
- <para>
- The password to use when connecting to the server.
- </para>
-
- <para>
- Specifying a password on the command line should be
- considered insecure. See
- <xref linkend="password-security"/>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>printerror option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>printerror option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
- <option>--printerror=1</option>, <option>-e
1</option>
- </para>
-
- <para>
- Enable error output.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>socket option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>socket option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--socket=<replaceable>path</replaceable></option>,
- <option>-S <replaceable>path</replaceable></option>
- </para>
-
- <para>
- For connections to <literal>localhost</literal>, the Unix
- socket file to use, or, on Windows, the name of the named
- pipe to use.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>user option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>user option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--user=<replaceable>user_name</replaceable></option>,
- <option>-u
<replaceable>user_name</replaceable></option>
- </para>
-
- <para>
- The MySQL username to use when connecting to the server.
- </para>
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
- </refentry>
-
- </section>
-
<section id="fake-id-for-mysqlaccess-manpage-section-wrapper">
<title>fake title for mysqlaccess manpage section wrapper</title>
@@ -13896,6 +13685,217 @@
</section>
+ <section id="fake-id-for-mysql-explain-log-manpage-section-wrapper">
+
+ <title>fake title for mysql_explain_log manpage section wrapper</title>
+
+ <refentry id="mysql-explain-log">
+
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ </indexterm>
+
+ <refmeta>
+
<refentrytitle><command>mysql_explain_log</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Use EXPLAIN on Statements in Query
Log</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>mysql_explain_log</refname>
+
+ <refpurpose>use EXPLAIN on statements in query log</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection id="mysql-explain-log-description">
+
+ <title>Description</title>
+
+ <para>
+ <command>mysql_explain_log</command> reads its standard input
+ for query log contents. It uses <literal>EXPLAIN</literal> to
+ analyze <literal>SELECT</literal> statements found in the
+ input. <literal>UPDATE</literal> statements are rewritten to
+ <literal>SELECT</literal> statements and also analyzed with
+ <literal>EXPLAIN</literal>.
+ <command>mysql_explain_log</command> then displays a summary
+ of its results.
+ </para>
+
+ <para>
+ The results may assist you in determining which queries result
+ in table scans and where it would be beneficial to add indexes
+ to your tables.
+ </para>
+
+ <para>
+ Invoke <command>mysql_explain_log</command> like this, where
+ <replaceable>log_file</replaceable> contains all or part of a
+ MySQL query log:
+ </para>
+
+<programlisting>
+shell> <userinput>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></userinput>
+</programlisting>
+
+ <para>
+ <command>mysql_explain_log</command> understands the following
+ options:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>date option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>date option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--date=<replaceable>YYMMDD</replaceable></option>,
+ <option>-d
<replaceable>YYMMDD</replaceable></option>
+ </para>
+
+ <para>
+ Select entries from the log only for the given date.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>host option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>host option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--host=<replaceable>host_name</replaceable></option>,
+ <option>-h
<replaceable>host_name</replaceable></option>
+ </para>
+
+ <para>
+ Connect to the MySQL server on the given host.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>password option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>password option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--password=<replaceable>password</replaceable></option>,
+ <option>-p
<replaceable>password</replaceable></option>
+ </para>
+
+ <para>
+ The password to use when connecting to the server.
+ </para>
+
+ <para>
+ Specifying a password on the command line should be
+ considered insecure. See
+ <xref linkend="password-security"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>printerror option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>printerror option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+ <option>--printerror=1</option>, <option>-e
1</option>
+ </para>
+
+ <para>
+ Enable error output.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>socket option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>socket option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--socket=<replaceable>path</replaceable></option>,
+ <option>-S <replaceable>path</replaceable></option>
+ </para>
+
+ <para>
+ For connections to <literal>localhost</literal>, the Unix
+ socket file to use, or, on Windows, the name of the named
+ pipe to use.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>user option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>user option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--user=<replaceable>user_name</replaceable></option>,
+ <option>-u
<replaceable>user_name</replaceable></option>
+ </para>
+
+ <para>
+ The MySQL username to use when connecting to the server.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </refsection>
+
+ </refentry>
+
+ </section>
+
<section id="fake-id-for-mysql-setpermission-manpage-section-wrapper">
<title>fake title for mysql_setpermission manpage section wrapper</title>
Modified: trunk/refman-5.0/client-utility-programs.xml
===================================================================
--- trunk/refman-5.0/client-utility-programs.xml 2007-03-27 21:23:43 UTC (rev 5581)
+++ trunk/refman-5.0/client-utility-programs.xml 2007-03-27 22:24:01 UTC (rev 5582)
Changed blocks: 4, Lines Added: 247, Lines Deleted: 247; 16067 bytes
@@ -179,22 +179,6 @@
<listitem>
<para>
<indexterm>
- <primary>mysql_explain_log</primary>
- </indexterm>
-
- <command>mysql_explain_log</command>
- </para>
-
- <para>
- A utility that analyzes queries in the MySQL query log using
- <literal>EXPLAIN</literal> See
- <xref linkend="mysql-explain-log"/>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
<primary>mysqlaccess</primary>
</indexterm>
@@ -340,6 +324,22 @@
<listitem>
<para>
<indexterm>
+ <primary>mysql_explain_log</primary>
+ </indexterm>
+
+ <command>mysql_explain_log</command>
+ </para>
+
+ <para>
+ A utility that analyzes queries in the MySQL query log using
+ <literal>EXPLAIN</literal> See
+ <xref linkend="mysql-explain-log"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
<primary>mysql_setpermission</primary>
</indexterm>
@@ -6267,237 +6267,6 @@
</section>
- <section id="fake-id-for-mysql-explain-log-manpage-section-wrapper">
-
- <title>fake title for mysql_explain_log manpage section wrapper</title>
-
- <refentry id="mysql-explain-log">
-
- <indexterm>
- <primary>mysql_explain_log</primary>
- </indexterm>
-
- <refmeta>
-
<refentrytitle><command>mysql_explain_log</command></refentrytitle>
-
- <manvolnum>1</manvolnum>
- <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
- <refmiscinfo class="source">MySQL</refmiscinfo>
- <refmiscinfo class="version">¤t-series;</refmiscinfo>
- <refmiscinfo class="refman">Use EXPLAIN on Statements in Query
Log</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>mysql_explain_log</refname>
-
- <refpurpose>use EXPLAIN on statements in query log</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></command>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsection id="mysql-explain-log-description">
-
- <title>Description</title>
-
- <para>
- <command>mysql_explain_log</command> reads its standard input
- for query log contents. It uses <literal>EXPLAIN</literal> to
- analyze <literal>SELECT</literal> statements found in the
- input. <literal>UPDATE</literal> statements are rewritten to
- <literal>SELECT</literal> statements and also analyzed with
- <literal>EXPLAIN</literal>.
- <command>mysql_explain_log</command> then displays a summary
- of its results.
- </para>
-
- <para>
- The results may assist you in determining which queries result
- in table scans and where it would be beneficial to add indexes
- to your tables.
- </para>
-
- <para>
- Invoke <command>mysql_explain_log</command> like this, where
- <replaceable>log_file</replaceable> contains all or part of a
- MySQL query log:
- </para>
-
-<programlisting>
-shell> <userinput>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></userinput>
-</programlisting>
-
- <para>
- <command>mysql_explain_log</command> understands the following
- options:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>help option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>help option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
- <option>--help</option>, <option>-?</option>
- </para>
-
- <para>
- Display a help message and exit.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>date option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>date option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--date=<replaceable>YYMMDD</replaceable></option>,
- <option>-d
<replaceable>YYMMDD</replaceable></option>
- </para>
-
- <para>
- Select entries from the log only for the given date.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>host option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>host option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--host=<replaceable>host_name</replaceable></option>,
- <option>-h
<replaceable>host_name</replaceable></option>
- </para>
-
- <para>
- Connect to the MySQL server on the given host.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>password option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>password option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--password=<replaceable>password</replaceable></option>,
- <option>-p
<replaceable>password</replaceable></option>
- </para>
-
- <para>
- The password to use when connecting to the server.
- </para>
-
- <para>
- Specifying a password on the command line should be
- considered insecure. See
- <xref linkend="password-security"/>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>printerror option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>printerror option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
- <option>--printerror=1</option>, <option>-e
1</option>
- </para>
-
- <para>
- Enable error output.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>socket option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>socket option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--socket=<replaceable>path</replaceable></option>,
- <option>-S <replaceable>path</replaceable></option>
- </para>
-
- <para>
- For connections to <literal>localhost</literal>, the Unix
- socket file to use, or, on Windows, the name of the named
- pipe to use.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <indexterm>
- <primary>mysql_explain_log</primary>
- <secondary>user option</secondary>
- </indexterm>
-
- <indexterm>
- <primary>user option</primary>
- <secondary>mysql_explain_log</secondary>
- </indexterm>
-
-
<option>--user=<replaceable>user_name</replaceable></option>,
- <option>-u
<replaceable>user_name</replaceable></option>
- </para>
-
- <para>
- The MySQL username to use when connecting to the server.
- </para>
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
- </refentry>
-
- </section>
-
<section id="fake-id-for-mysqlaccess-manpage-section-wrapper">
<title>fake title for mysqlaccess manpage section wrapper</title>
@@ -14365,6 +14134,237 @@
</section>
+ <section id="fake-id-for-mysql-explain-log-manpage-section-wrapper">
+
+ <title>fake title for mysql_explain_log manpage section wrapper</title>
+
+ <refentry id="mysql-explain-log">
+
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ </indexterm>
+
+ <refmeta>
+
<refentrytitle><command>mysql_explain_log</command></refentrytitle>
+
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">MySQL Database System</refmiscinfo>
+ <refmiscinfo class="source">MySQL</refmiscinfo>
+ <refmiscinfo class="version">¤t-series;</refmiscinfo>
+ <refmiscinfo class="refman">Use EXPLAIN on Statements in Query
Log</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>mysql_explain_log</refname>
+
+ <refpurpose>use EXPLAIN on statements in query log</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection id="mysql-explain-log-description">
+
+ <title>Description</title>
+
+ <para>
+ <command>mysql_explain_log</command> reads its standard input
+ for query log contents. It uses <literal>EXPLAIN</literal> to
+ analyze <literal>SELECT</literal> statements found in the
+ input. <literal>UPDATE</literal> statements are rewritten to
+ <literal>SELECT</literal> statements and also analyzed with
+ <literal>EXPLAIN</literal>.
+ <command>mysql_explain_log</command> then displays a summary
+ of its results.
+ </para>
+
+ <para>
+ The results may assist you in determining which queries result
+ in table scans and where it would be beneficial to add indexes
+ to your tables.
+ </para>
+
+ <para>
+ Invoke <command>mysql_explain_log</command> like this, where
+ <replaceable>log_file</replaceable> contains all or part of a
+ MySQL query log:
+ </para>
+
+<programlisting>
+shell> <userinput>mysql_explain_log
[<replaceable>options</replaceable>] <
<replaceable>log_file</replaceable></userinput>
+</programlisting>
+
+ <para>
+ <command>mysql_explain_log</command> understands the following
+ options:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>help option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>help option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+ <option>--help</option>, <option>-?</option>
+ </para>
+
+ <para>
+ Display a help message and exit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>date option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>date option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--date=<replaceable>YYMMDD</replaceable></option>,
+ <option>-d
<replaceable>YYMMDD</replaceable></option>
+ </para>
+
+ <para>
+ Select entries from the log only for the given date.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>host option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>host option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--host=<replaceable>host_name</replaceable></option>,
+ <option>-h
<replaceable>host_name</replaceable></option>
+ </para>
+
+ <para>
+ Connect to the MySQL server on the given host.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>password option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>password option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--password=<replaceable>password</replaceable></option>,
+ <option>-p
<replaceable>password</replaceable></option>
+ </para>
+
+ <para>
+ The password to use when connecting to the server.
+ </para>
+
+ <para>
+ Specifying a password on the command line should be
+ considered insecure. See
+ <xref linkend="password-security"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>printerror option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>printerror option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+ <option>--printerror=1</option>, <option>-e
1</option>
+ </para>
+
+ <para>
+ Enable error output.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>socket option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>socket option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--socket=<replaceable>path</replaceable></option>,
+ <option>-S <replaceable>path</replaceable></option>
+ </para>
+
+ <para>
+ For connections to <literal>localhost</literal>, the Unix
+ socket file to use, or, on Windows, the name of the named
+ pipe to use.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <indexterm>
+ <primary>mysql_explain_log</primary>
+ <secondary>user option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>user option</primary>
+ <secondary>mysql_explain_log</secondary>
+ </indexterm>
+
+
<option>--user=<replaceable>user_name</replaceable></option>,
+ <option>-u
<replaceable>user_name</replaceable></option>
+ </para>
+
+ <para>
+ The MySQL username to use when connecting to the server.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </refsection>
+
+ </refentry>
+
+ </section>
+
<section id="fake-id-for-mysql-setpermission-manpage-section-wrapper">
<title>fake title for mysql_setpermission manpage section wrapper</title>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5582 - in trunk: . refman-4.1 refman-5.0 | paul | 28 Mar |