Author: paul
Date: 2006-02-14 16:22:05 +0100 (Tue, 14 Feb 2006)
New Revision: 1313
Log:
r7473@frost: paul | 2006-02-14 09:21:03 -0600
Beginning of documentation for log tables: Now that we have log tables,
avoid saying log _file_ unless we actually mean a file.
Modified:
trunk/
trunk/refman-4.1/database-administration.xml
trunk/refman-5.0/database-administration.xml
trunk/refman-5.1/database-administration.xml
trunk/refman-common/titles.en.ent
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:7459
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3045
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:7473
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3045
Modified: trunk/refman-4.1/database-administration.xml
===================================================================
--- trunk/refman-4.1/database-administration.xml 2006-02-14 15:09:29 UTC (rev 1312)
+++ trunk/refman-4.1/database-administration.xml 2006-02-14 15:22:05 UTC (rev 1313)
@@ -20455,12 +20455,12 @@
<informaltable>
<tgroup cols="2">
- <colspec colwidth="20*"/>
- <colspec colwidth="80*"/>
+ <colspec colwidth="30*"/>
+ <colspec colwidth="70*"/>
<tbody>
<row>
- <entry><emphasis role="bold">Log
File</emphasis></entry>
- <entry><emphasis role="bold">Types of Information Logged to
File</emphasis></entry>
+ <entry><emphasis role="bold">Log
Type</emphasis></entry>
+ <entry><emphasis role="bold">Information Written to
Log</emphasis></entry>
</row>
<row>
<entry>The error log</entry>
@@ -20473,8 +20473,8 @@
debugging the <literal>ISAM</literal> code)</entry>
</row>
<row>
- <entry>The query log</entry>
- <entry>Established client connections and executed
statements</entry>
+ <entry>The general query log</entry>
+ <entry>Established client connections and statements received from
clients</entry>
</row>
<row>
<entry>The update log</entry>
@@ -20581,25 +20581,21 @@
<title>&title-query-log;</title>
<indexterm>
- <primary>query log</primary>
+ <primary>general query log</primary>
</indexterm>
<indexterm>
<primary>files</primary>
- <secondary>query log</secondary>
+ <secondary>general query log</secondary>
</indexterm>
<para>
- If you want to know what happens within
- <command>mysqld</command>, you should start it with the
-
<option>--log[=<replaceable>file_name</replaceable>]</option> or
- <option>-l
[<replaceable>file_name</replaceable>]</option>
- option. If no <replaceable>file_name</replaceable> value is
- given, the default name is
-
<filename><replaceable>host_name</replaceable>.log</filename>
- This logs all connections and statements to the log file. This
- log can be very useful when you suspect an error in a client and
- want to know exactly what the client sent to
+ The general query log is a general record of what
+ <command>mysqld</command> is doing. The server writes
+ information to this log when clients connect or disconnect, and
+ it logs each SQL statement received from clients. The general
+ query log can be very useful when you suspect an error in a
+ client and want to know exactly what the client sent to
<command>mysqld</command>.
</para>
@@ -20631,6 +20627,17 @@
</para>
<para>
+ To enable the general query log, start <command>mysqld</command>
+ with the
+
<option>--log[=<replaceable>file_name</replaceable>]</option> or
+ <option>-l
[<replaceable>file_name</replaceable>]</option>
+ option. If no <replaceable>file_name</replaceable> value is
+ given, the default name is
+
<filename><replaceable>host_name</replaceable>.log</filename> in
+ the data directory.
+ </para>
+
+ <para>
Server restarts and log flushing do not cause a new general
query log file to be generated (although flushing closes and
reopens it). On Unix, you can rename the file and create a new
@@ -20646,8 +20653,8 @@
<para>
On Windows, you cannot rename the log file while the server has
- it open. You must stop the server and rename it, and then
- restart the server to create a new log.
+ it open. You must stop the server and rename the file, and then
+ restart the server to create a new log file.
</para>
</section>
@@ -21275,14 +21282,24 @@
</indexterm>
<para>
- When started with the
+ The slow query log consists of all SQL statements that took more
+ than <literal>long_query_time</literal> seconds to execute. The
+ time to acquire the initial table locks is not counted as
+ execution time. The minimum and default values of
+ <literal>long_query_time</literal> are 1 and 10, respectively.
+ </para>
+
+ <para>
+ <command>mysqld</command> writes a statement to the slow query
+ log after it has been executed and after all locks have been
+ released. Log order may be different from execution order.
+ </para>
+
+ <para>
+ To enable the slow query log, start <command>mysqld</command>
+ with the
<option>--log-slow-queries[=<replaceable>file_name</replaceable>]</option>
- option, <command>mysqld</command> writes a log file containing
- all SQL statements that took more than
- <literal>long_query_time</literal> seconds to execute. The time
- to acquire the initial table locks is not counted as execution
- time. The minimum value of <literal>long_query_time</literal> is
- 1.
+ option.
</para>
<para>
@@ -21294,18 +21311,13 @@
</para>
<para>
- A statement is logged to the slow query log after it has been
- executed and after all locks have been released. Log order may
- be different from execution order.
- </para>
-
- <para>
The slow query log can be used to find queries that take a long
time to execute and are therefore candidates for optimization.
However, examining a long slow query log can become a difficult
task. To make this easier, you can process the slow query log
using the <command>mysqldumpslow</command> command to summarize
- the queries that appear in the log.
+ the queries that appear in the log. Use <command>mysqldumpslow
+ --help</command> to see the options that this command supports.
</para>
<para>
Modified: trunk/refman-5.0/database-administration.xml
===================================================================
--- trunk/refman-5.0/database-administration.xml 2006-02-14 15:09:29 UTC (rev 1312)
+++ trunk/refman-5.0/database-administration.xml 2006-02-14 15:22:05 UTC (rev 1313)
@@ -22562,12 +22562,12 @@
<informaltable>
<tgroup cols="2">
- <colspec colwidth="20*"/>
- <colspec colwidth="80*"/>
+ <colspec colwidth="30*"/>
+ <colspec colwidth="70*"/>
<tbody>
<row>
- <entry><emphasis role="bold">Log
File</emphasis></entry>
- <entry><emphasis role="bold">Types of Information Logged to
File</emphasis></entry>
+ <entry><emphasis role="bold">Log
Type</emphasis></entry>
+ <entry><emphasis role="bold">Information Written to
Log</emphasis></entry>
</row>
<row>
<entry>The error log</entry>
@@ -22575,8 +22575,8 @@
<command>mysqld</command></entry>
</row>
<row>
- <entry>The query log</entry>
- <entry>Established client connections and executed
statements</entry>
+ <entry>The general query log</entry>
+ <entry>Established client connections and statements received from
clients</entry>
</row>
<row>
<entry>The binary log</entry>
@@ -22668,25 +22668,21 @@
<title>&title-query-log;</title>
<indexterm>
- <primary>query log</primary>
+ <primary>general query log</primary>
</indexterm>
<indexterm>
<primary>files</primary>
- <secondary>query log</secondary>
+ <secondary>general query log</secondary>
</indexterm>
<para>
- If you want to know what happens within
- <command>mysqld</command>, you should start it with the
-
<option>--log[=<replaceable>file_name</replaceable>]</option> or
- <option>-l
[<replaceable>file_name</replaceable>]</option>
- option. If no <replaceable>file_name</replaceable> value is
- given, the default name is
-
<filename><replaceable>host_name</replaceable>.log</filename>
- This logs all connections and statements to the log file. This
- log can be very useful when you suspect an error in a client and
- want to know exactly what the client sent to
+ The general query log is a general record of what
+ <command>mysqld</command> is doing. The server writes
+ information to this log when clients connect or disconnect, and
+ it logs each SQL statement received from clients. The general
+ query log can be very useful when you suspect an error in a
+ client and want to know exactly what the client sent to
<command>mysqld</command>.
</para>
@@ -22701,6 +22697,17 @@
</para>
<para>
+ To enable the general query log, start <command>mysqld</command>
+ with the
+
<option>--log[=<replaceable>file_name</replaceable>]</option> or
+ <option>-l
[<replaceable>file_name</replaceable>]</option>
+ option. If no <replaceable>file_name</replaceable> value is
+ given, the default name is
+
<filename><replaceable>host_name</replaceable>.log</filename> in
+ the data directory.
+ </para>
+
+ <para>
Server restarts and log flushing do not cause a new general
query log file to be generated (although flushing closes and
reopens it). On Unix, you can rename the file and create a new
@@ -22716,8 +22723,8 @@
<para>
On Windows, you cannot rename the log file while the server has
- it open. You must stop the server and rename it, and then
- restart the server to create a new log.
+ it open. You must stop the server and rename the file, and then
+ restart the server to create a new log file.
</para>
</section>
@@ -23265,14 +23272,24 @@
</indexterm>
<para>
- When started with the
+ The slow query log consists of all SQL statements that took more
+ than <literal>long_query_time</literal> seconds to execute. The
+ time to acquire the initial table locks is not counted as
+ execution time. The minimum and default values of
+ <literal>long_query_time</literal> are 1 and 10, respectively.
+ </para>
+
+ <para>
+ <command>mysqld</command> writes a statement to the slow query
+ log after it has been executed and after all locks have been
+ released. Log order may be different from execution order.
+ </para>
+
+ <para>
+ To enable the slow query log, start <command>mysqld</command>
+ with the
<option>--log-slow-queries[=<replaceable>file_name</replaceable>]</option>
- option, <command>mysqld</command> writes a log file containing
- all SQL statements that took more than
- <literal>long_query_time</literal> seconds to execute. The time
- to acquire the initial table locks is not counted as execution
- time. The minimum value of <literal>long_query_time</literal> is
- 1.
+ option.
</para>
<para>
@@ -23284,18 +23301,13 @@
</para>
<para>
- A statement is logged to the slow query log after it has been
- executed and after all locks have been released. Log order may
- be different from execution order.
- </para>
-
- <para>
The slow query log can be used to find queries that take a long
time to execute and are therefore candidates for optimization.
However, examining a long slow query log can become a difficult
task. To make this easier, you can process the slow query log
using the <command>mysqldumpslow</command> command to summarize
- the queries that appear in the log.
+ the queries that appear in the log. Use <command>mysqldumpslow
+ --help</command> to see the options that this command supports.
</para>
<para>
Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml 2006-02-14 15:09:29 UTC (rev 1312)
+++ trunk/refman-5.1/database-administration.xml 2006-02-14 15:22:05 UTC (rev 1313)
@@ -22377,12 +22377,12 @@
<informaltable>
<tgroup cols="2">
- <colspec colwidth="20*"/>
- <colspec colwidth="80*"/>
+ <colspec colwidth="30*"/>
+ <colspec colwidth="70*"/>
<tbody>
<row>
- <entry><emphasis role="bold">Log
File</emphasis></entry>
- <entry><emphasis role="bold">Types of Information Logged to
File</emphasis></entry>
+ <entry><emphasis role="bold">Log
Type</emphasis></entry>
+ <entry><emphasis role="bold">Information Written to
Log</emphasis></entry>
</row>
<row>
<entry>The error log</entry>
@@ -22390,8 +22390,8 @@
<command>mysqld</command></entry>
</row>
<row>
- <entry>The query log</entry>
- <entry>Established client connections and executed
statements</entry>
+ <entry>The general query log</entry>
+ <entry>Established client connections and statements received from
clients</entry>
</row>
<row>
<entry>The binary log</entry>
@@ -22483,25 +22483,21 @@
<title>&title-query-log;</title>
<indexterm>
- <primary>query log</primary>
+ <primary>general query log</primary>
</indexterm>
<indexterm>
<primary>files</primary>
- <secondary>query log</secondary>
+ <secondary>general query log</secondary>
</indexterm>
<para>
- If you want to know what happens within
- <command>mysqld</command>, you should start it with the
-
<option>--log[=<replaceable>file_name</replaceable>]</option> or
- <option>-l
[<replaceable>file_name</replaceable>]</option>
- option. If no <replaceable>file_name</replaceable> value is
- given, the default name is
-
<filename><replaceable>host_name</replaceable>.log</filename>
- This logs all connections and statements to the log file. This
- log can be very useful when you suspect an error in a client and
- want to know exactly what the client sent to
+ The general query log is a general record of what
+ <command>mysqld</command> is doing. The server writes
+ information to this log when clients connect or disconnect, and
+ it logs each SQL statement received from clients. The general
+ query log can be very useful when you suspect an error in a
+ client and want to know exactly what the client sent to
<command>mysqld</command>.
</para>
@@ -22516,6 +22512,17 @@
</para>
<para>
+ To enable the general query log, start <command>mysqld</command>
+ with the
+
<option>--log[=<replaceable>file_name</replaceable>]</option> or
+ <option>-l
[<replaceable>file_name</replaceable>]</option>
+ option. If no <replaceable>file_name</replaceable> value is
+ given, the default name is
+
<filename><replaceable>host_name</replaceable>.log</filename> in
+ the data directory.
+ </para>
+
+ <para>
Server restarts and log flushing do not cause a new general
query log file to be generated (although flushing closes and
reopens it). On Unix, you can rename the file and create a new
@@ -22531,8 +22538,8 @@
<para>
On Windows, you cannot rename the log file while the server has
- it open. You must stop the server and rename it, and then
- restart the server to create a new log.
+ it open. You must stop the server and rename the file, and then
+ restart the server to create a new log file.
</para>
</section>
@@ -23080,14 +23087,24 @@
</indexterm>
<para>
- When started with the
+ The slow query log consists of all SQL statements that took more
+ than <literal>long_query_time</literal> seconds to execute. The
+ time to acquire the initial table locks is not counted as
+ execution time. The minimum and default values of
+ <literal>long_query_time</literal> are 1 and 10, respectively.
+ </para>
+
+ <para>
+ <command>mysqld</command> writes a statement to the slow query
+ log after it has been executed and after all locks have been
+ released. Log order may be different from execution order.
+ </para>
+
+ <para>
+ To enable the slow query log, start <command>mysqld</command>
+ with the
<option>--log-slow-queries[=<replaceable>file_name</replaceable>]</option>
- option, <command>mysqld</command> writes a log file containing
- all SQL statements that took more than
- <literal>long_query_time</literal> seconds to execute. The time
- to acquire the initial table locks is not counted as execution
- time. The minimum value of <literal>long_query_time</literal> is
- 1.
+ option.
</para>
<para>
@@ -23099,18 +23116,13 @@
</para>
<para>
- A statement is logged to the slow query log after it has been
- executed and after all locks have been released. Log order may
- be different from execution order.
- </para>
-
- <para>
The slow query log can be used to find queries that take a long
time to execute and are therefore candidates for optimization.
However, examining a long slow query log can become a difficult
task. To make this easier, you can process the slow query log
using the <command>mysqldumpslow</command> command to summarize
- the queries that appear in the log.
+ the queries that appear in the log. Use <command>mysqldumpslow
+ --help</command> to see the options that this command supports.
</para>
<para>
Modified: trunk/refman-common/titles.en.ent
===================================================================
--- trunk/refman-common/titles.en.ent 2006-02-14 15:09:29 UTC (rev 1312)
+++ trunk/refman-common/titles.en.ent 2006-02-14 15:22:05 UTC (rev 1313)
@@ -640,8 +640,8 @@
<!ENTITY title-localization "MySQL Localization and International Usage">
<!ENTITY title-lock-tables "<literal>LOCK TABLES</literal> and
<literal>UNLOCK TABLES</literal> Syntax">
<!ENTITY title-locking-issues "Locking Issues">
-<!ENTITY title-log-file-maintenance "Log File Maintenance">
-<!ENTITY title-log-files "The MySQL Log Files">
+<!ENTITY title-log-file-maintenance "Server Log Maintenance">
+<!ENTITY title-log-files "MySQL Server Logs">
<!ENTITY title-logical-operators "Logical Operators">
<!ENTITY title-loop-statement "<literal>LOOP</literal> Statement">
<!ENTITY title-loose-index-scan "Loose index scan">
@@ -1682,7 +1682,7 @@
<!ENTITY title-using-date "Problems Using <literal>DATE</literal>
Columns">
<!ENTITY title-using-gdb-on-mysqld "Debugging <command>mysqld</command>
under <command>gdb</command>">
<!ENTITY title-using-innodb-tables "Creating and Using
<literal>InnoDB</literal> Tables">
-<!ENTITY title-using-log-files "Using Log Files to Find Cause of Errors in
<command>mysqld</command>">
+<!ENTITY title-using-log-files "Using Server Logs to Find Causes of Errors in
<command>mysqld</command>">
<!ENTITY title-using-mysql-programs "Using MySQL Programs">
<!ENTITY title-using-stack-trace "Using a Stack Trace">
<!ENTITY title-using-system-variables "Using System Variables">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1313 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-common | paul | 14 Feb |