Author: paul
Date: 2006-01-21 00:51:00 +0100 (Sat, 21 Jan 2006)
New Revision: 958
Log:
r6500@frost: paul | 2006-01-20 17:45:26 -0600
General revisions.
Modified:
trunk/
trunk/refman-4.1/client-utility-programs.xml
trunk/refman-4.1/functions.xml
trunk/refman-5.0/client-utility-programs.xml
trunk/refman-5.0/functions.xml
trunk/refman-5.1/client-utility-programs.xml
trunk/refman-5.1/functions.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6499
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2396
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:6500
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:2396
Modified: trunk/refman-4.1/client-utility-programs.xml
===================================================================
--- trunk/refman-4.1/client-utility-programs.xml 2006-01-20 23:46:33 UTC (rev 957)
+++ trunk/refman-4.1/client-utility-programs.xml 2006-01-20 23:51:00 UTC (rev 958)
@@ -709,8 +709,8 @@
<para>
When the table is used later, the server reads into memory the
information needed to decompress columns. This results in much
- better performance when accessing individual records, because
- you only have to uncompress exactly one record.
+ better performance when accessing individual rows, because you
+ only have to uncompress exactly one row.
</para>
<para>
@@ -878,16 +878,16 @@
</para>
<para>
- Specify the record length storage size, in bytes. The
- value should be 1, 2, or 3. <command>myisampack</command>
- stores all rows with length pointers of 1, 2, or 3 bytes.
- In most normal cases, <command>myisampack</command> can
- determine the correct length value before it begins
- packing the file, but it may notice during the packing
- process that it could have used a shorter length. In this
- case, <command>myisampack</command> prints a note that you
- could use a shorter record length the next time you pack
- the same file.
+ Specify the row length storage size, in bytes. The value
+ should be 1, 2, or 3. <command>myisampack</command> stores
+ all rows with length pointers of 1, 2, or 3 bytes. In most
+ normal cases, <command>myisampack</command> can determine
+ the correct length value before it begins packing the
+ file, but it may notice during the packing process that it
+ could have used a shorter length. In this case,
+ <command>myisampack</command> prints a note that you could
+ use a shorter row length the next time you pack the same
+ file.
</para>
</listitem>
@@ -4189,8 +4189,8 @@
<listitem>
<para>
- <option>--count=<replaceable>num</replaceable></option>,
- <option>-c <replaceable>num</replaceable></option>
+ <option>--count=<replaceable>N</replaceable></option>,
+ <option>-c <replaceable>N</replaceable></option>
</para>
<para>
@@ -5143,10 +5143,9 @@
<title>Description</title>
<para>
- The <command>mysqlcheck</command> client checks and repairs
- <literal>MyISAM</literal> tables. It can also optimize and
- analyze tables. <command>mysqlcheck</command> is available as
- of MySQL 3.23.38.
+ The <command>mysqlcheck</command> client checks, repairs,
+ optimizes, and analyzes tables. <command>mysqlcheck</command>
+ is available as of MySQL 3.23.38.
</para>
<para>
@@ -5166,23 +5165,41 @@
TABLE</literal>, <literal>ANALYZE TABLE</literal>, and
<literal>OPTIMIZE TABLE</literal> in a convenient way for the
user. It determines which statements to use for the operation
- you want to perform, then sends the statements to the server
- to be executed.
+ you want to perform, and then sends the statements to the
+ server to be executed.
</para>
<para>
+ The <literal>MyIAM</literal> storage engine supports all four
+ statements, so <command>mysqlcheck</command> can be used to
+ perform all four operations on <literal>MyISAM</literal>
+ tables. Other storage engines do not necessarily support all
+ operations. In such cases, an error message is displayed. For
+ example, if <literal>test.t</literal> is a
+ <literal>MEMORY</literal> table, an attempt to check it
+ produces this result:
+ </para>
+
+<programlisting>
+shell> <userinput>mysqlcheck test t</userinput>
+test.t
+note : The storage engine for the table doesn't support check
+</programlisting>
+
+ <para>
There are three general ways to invoke
<command>mysqlcheck</command>:
</para>
<programlisting>
shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] <replaceable>db_name</replaceable> [<replaceable>tables</replaceable>]</userinput>
-shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --databases <replaceable>DB1</replaceable> [<replaceable>DB2</replaceable> <replaceable>DB3</replaceable>...]</userinput>
+shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --databases <replaceable>db_name1</replaceable> [<replaceable>db_name2</replaceable> <replaceable>db_name3</replaceable>...]</userinput>
shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --all-databases</userinput>
</programlisting>
<para>
- If you do not name any tables or use the
+ If you do not name any tables following
+ <replaceable>db_name</replaceable> or if you use the
<option>--databases</option> or
<option>--all-databases</option> option, entire databases are
checked.
@@ -5190,9 +5207,9 @@
<para>
<command>mysqlcheck</command> has a special feature compared
- to the other clients. The default behavior of checking tables
- (<option>--check</option>) can be changed by renaming the
- binary. If you want to have a tool that repairs tables by
+ to other client programs. The default behavior of checking
+ tables (<option>--check</option>) can be changed by renaming
+ the binary. If you want to have a tool that repairs tables by
default, you should just make a copy of
<command>mysqlcheck</command> named
<command>mysqlrepair</command>, or make a symbolic link to
@@ -5306,7 +5323,8 @@
</para>
<para>
- Check the tables for errors.
+ Check the tables for errors. This is the default
+ operation.
</para>
</listitem>
@@ -5338,9 +5356,11 @@
</para>
<para>
- Process all tables in the named databases. With this
- option, all name arguments are regarded as database names,
- not as table names.
+ Process all tables in the named databases. Normally,
+ <command>mysqlcheck</command> treats the first name
+ argument on the command line as a database name and
+ following names as table names. With this option, it
+ treats all name arguments as database names.
</para>
</listitem>
@@ -5352,7 +5372,7 @@
</para>
<para>
- Write a debugging log. The
+ Write a debugging log. A typical
<replaceable>debug_options</replaceable> string is often
<literal>'d:t:o,<replaceable>file_name</replaceable>'</literal>.
</para>
@@ -5544,8 +5564,8 @@
<para>
Overrides the <option>--databases</option> or
- <option>-B</option> option. All arguments following the
- option are regarded as table names.
+ <option>-B</option> option. All name arguments following
+ the option are regarded as table names.
</para>
</listitem>
@@ -5661,10 +5681,10 @@
<para>
If you are doing a backup on the server, and your tables all
- are <literal>MyISAM</literal> tables, you could consider using
- the <command>mysqlhotcopy</command> instead because faster
- backups and faster restores can be accomplished with the
- latter. See <xref linkend="mysqlhotcopy"/>.
+ are <literal>MyISAM</literal> tables, consider using the
+ <command>mysqlhotcopy</command> instead because it can
+ accomplish faster backups and faster restores. See
+ <xref linkend="mysqlhotcopy"/>.
</para>
<para>
@@ -5674,12 +5694,13 @@
<programlisting>
shell> <userinput>mysqldump [<replaceable>options</replaceable>] <replaceable>db_name</replaceable> [<replaceable>tables</replaceable>]</userinput>
-shell> <userinput>mysqldump [<replaceable>options</replaceable>] --databases <replaceable>DB1</replaceable> [<replaceable>DB2</replaceable> <replaceable>DB3</replaceable>...]</userinput>
+shell> <userinput>mysqldump [<replaceable>options</replaceable>] --databases <replaceable>db_name1</replaceable> [<replaceable>db_name2</replaceable> <replaceable>db_name3</replaceable>...]</userinput>
shell> <userinput>mysqldump [<replaceable>options</replaceable>] --all-databases</userinput>
</programlisting>
<para>
- If you do not name any tables or use the
+ If you do not name any tables following
+ <replaceable>db_name</replaceable> or if you use the
<option>--databases</option> or
<option>--all-databases</option> option, entire databases are
dumped.
@@ -5695,17 +5716,18 @@
If you run <command>mysqldump</command> without the
<option>--quick</option> or <option>--opt</option> option,
<command>mysqldump</command> loads the whole result set into
- memory before dumping the result. This probably is a problem
- if you are dumping a big database. As of MySQL
- ¤t-series;, <option>--opt</option> is enabled by
- default, but can be disabled with <option>--skip-opt</option>.
+ memory before dumping the result. This can be a problem if you
+ are dumping a big database. As of MySQL ¤t-series;,
+ <option>--opt</option> is enabled by default, but can be
+ disabled with <option>--skip-opt</option>.
</para>
<para>
If you are using a recent copy of the
<command>mysqldump</command> program to generate a dump to be
reloaded into a very old MySQL server, you should not use the
- <option>--opt</option> or <option>-e</option> options.
+ <option>--opt</option> or <option>--extended-insert</option>
+ option. Use <option>--skip-opt</option> instead.
</para>
<para>
@@ -5939,11 +5961,9 @@
argument on the command line as a database name and
following names as table names. With this option, it
treats all name arguments as database names.
- <literal>CREATE DATABASE IF NOT EXISTS
- <replaceable>db_name</replaceable></literal> and
- <literal>USE <replaceable>db_name</replaceable></literal>
- statements are included in the output before each new
- database.
+ <literal>CREATE DATABASE</literal> and
+ <literal>USE</literal> statements are included in the
+ output before each new database.
</para>
</listitem>
@@ -5983,8 +6003,8 @@
</para>
<para>
- Insert rows using <literal>INSERT DELAYED</literal>
- statements.
+ Write <literal>INSERT DELAYED</literal> statements rather
+ than <literal>INSERT</literal> statements.
</para>
</listitem>
@@ -6115,9 +6135,9 @@
</para>
<para>
- Dump binary string columns using hexadecimal notation (for
+ Dump binary columns using hexadecimal notation (for
example, <literal>'abc'</literal> becomes
- <literal>0x616263</literal>). The affected columns are
+ <literal>0x616263</literal>). The affected data types are
<literal>BINARY</literal>, <literal>VARBINARY</literal>,
and <literal>BLOB</literal> in MySQL 4.1 and up, and
<literal>CHAR BINARY</literal>, <literal>VARCHAR
@@ -6173,16 +6193,16 @@
</para>
<para>
- This option causes the binary log position and filename to
- be written to the output. This option requires the
- <literal>RELOAD</literal> privilege and the binary log
- must be enabled. If the option value is equal to 1, the
- position and filename are written to the dump output in
- the form of a <literal>CHANGE MASTER</literal> statement
- that makes a slave server start from the correct position
- in the master's binary logs if you use this SQL dump of
- the master to set up a slave. If the option value is equal
- to 2, the <literal>CHANGE MASTER</literal> statement is
+ Write the binary log filename and position to the output.
+ This option requires the <literal>RELOAD</literal>
+ privilege and the binary log must be enabled. If the
+ option value is equal to 1, the position and filename are
+ written to the dump output in the form of a
+ <literal>CHANGE MASTER</literal> statement that makes a
+ slave server start from the correct position in the
+ master's binary logs if you use this SQL dump of the
+ master to set up a slave. If the option value is equal to
+ 2, the <literal>CHANGE MASTER</literal> statement is
written as an SQL comment. This is the default action if
<replaceable>value</replaceable> is omitted.
<replaceable>value</replaceable> may be given as of MySQL
@@ -6208,10 +6228,9 @@
</para>
<para>
- This option suppresses the <literal>CREATE DATABASE
- /*!32312 IF NOT EXISTS*/ db_name</literal> statements that
- are otherwise included in the output if the
- <option>--databases</option> or
+ This option suppresses the <literal>CREATE
+ DATABASE</literal> statements that are otherwise included
+ in the output if the <option>--databases</option> or
<option>--all-databases</option> option is given.
</para>
</listitem>
@@ -6234,8 +6253,8 @@
<para>
Do not write any row information for the table. This is
- very useful if you want to get a dump of only the
- structure for a table.
+ very useful if you want to dump only the <literal>CREATE
+ TABLE</literal> statement for the table.
</para>
</listitem>
@@ -6250,14 +6269,18 @@
--disable-keys --extended-insert --lock-tables --quick
--set-charset</option>. It should give you a fast dump
operation and produce a dump file that can be reloaded
- into a MySQL server quickly. <emphasis>As of MySQL 4.1,
- <option>--opt</option> is on by default, but can be
- disabled with <option>--skip-opt</option></emphasis>. To
- disable only certain of the options enabled by
- <option>--opt</option>, use their <option>--skip</option>
- forms; for example, <option>--skip-add-drop-table</option>
- or <option>--skip-quick</option>.
+ into a MySQL server quickly.
</para>
+
+ <para>
+ <emphasis>As of MySQL 4.1, <option>--opt</option> is
+ enabled by default, but can be disabled with
+ <option>--skip-opt</option></emphasis>. To disable only
+ certain of the options enabled by <option>--opt</option>,
+ use their <option>--skip</option> forms; for example,
+ <option>--skip-add-drop-table</option> or
+ <option>--skip-quick</option>.
+ </para>
</listitem>
<listitem>
@@ -6329,9 +6352,9 @@
<literal>ANSI_QUOTES</literal> SQL mode is enabled, names
are quoted within ‘<literal>"</literal>’
characters. As of MySQL 4.1.1,
- <option>--quote-names</option> is on by default. It can be
- disabled with <option>--skip-quote-names</option>, but
- this option should be given after any option such as
+ <option>--quote-names</option> is enabled by default. It
+ can be disabled with <option>--skip-quote-names</option>,
+ but this option should be given after any option such as
<option>--compatible</option> that may enable
<option>--quote-names</option>.
</para>
@@ -6345,7 +6368,7 @@
<para>
Direct output to a given file. This option should be used
- on Windows, because it prevents newline
+ on Windows to prevent newline
‘<literal>\n</literal>’ characters from being
converted to ‘<literal>\r\n</literal>’
carriage return/newline sequences.
@@ -6474,8 +6497,8 @@
<para>
Override the <option>--databases</option> or
- <option>-B</option> option. All arguments following the
- option are regarded as table names.
+ <option>-B</option> option. All name arguments following
+ the option are regarded as table names.
</para>
</listitem>
@@ -6513,16 +6536,16 @@
<listitem>
<para>
- <option>--where='<replaceable>where-condition</replaceable>'</option>,
+ <option>--where='<replaceable>where_condition</replaceable>'</option>,
<option>-w
- '<replaceable>where-condition</replaceable>'</option>
+ '<replaceable>where_condition</replaceable>'</option>
</para>
<para>
- Dump only records selected by the given
+ Dump only rows selected by the given
<literal>WHERE</literal> condition. Note that quotes
around the condition are mandatory if it contains spaces
- or characters that are special to your command
+ or other characters that are special to your command
interpreter.
</para>
@@ -6531,9 +6554,9 @@
</para>
<programlisting>
-"--where=user='jimf'"
-"-wuserid>1"
-"-wuserid<1"
+--where="user='jimf'"
+-w"userid>1"
+-w"userid<1"
</programlisting>
</listitem>
@@ -6641,7 +6664,7 @@
</programlisting>
<para>
- If you want to dump all databases, use the
+ To dump all databases, use the
<option>--all-databases</option> option:
</para>
@@ -6650,20 +6673,9 @@
</programlisting>
<para>
- If tables are stored in the <literal>InnoDB</literal> storage
- engine, <literal>mysqldump</literal> provides a way of making
- an online backup of these (see command below). This backup
- just needs to acquire a global read lock on all tables (using
- <literal>FLUSH TABLES WITH READ LOCK</literal>) at the
- beginning of the dump. As soon as this lock has been acquired,
- the binary log coordinates are read and lock is released. So
- if and only if one long updating statement is running when the
- <literal>FLUSH …</literal> is issued, the MySQL server
- may get stalled until that long statement finishes, and then
- the dump becomes lock-free. So if the MySQL server receives
- only short (in the sense of <quote>short execution
- time</quote>) updating statements, even if there are plenty of
- them, the initial lock period should not be noticeable.
+ For <literal>InnoDB</literal> tables,
+ <literal>mysqldump</literal> provides a way of making an
+ online backup:
</para>
<programlisting>
@@ -6671,9 +6683,23 @@
</programlisting>
<para>
+ This backup just needs to acquire a global read lock on all
+ tables (using <literal>FLUSH TABLES WITH READ LOCK</literal>)
+ at the beginning of the dump. As soon as this lock has been
+ acquired, the binary log coordinates are read and the lock is
+ released. If and only if one long updating statement is
+ running when the <literal>FLUSH</literal> statement is issued,
+ the MySQL server may get stalled until that long statement
+ finishes, and then the dump becomes lock-free. If the update
+ statements that the MySQL server receives are short (in terms
+ of execution time), the initial lock period should not be
+ noticeable, even with many updates.
+ </para>
+
+ <para>
For point-in-time recovery (also known as
<quote>roll-forward,</quote> when you need to restore an old
- backup and replay the changes which happened since that
+ backup and replay the changes that happened since that
backup), it is often useful to rotate the binary log (see
<xref linkend="binary-log"/>) or at least know the binary log
coordinates to which the dump corresponds:
@@ -6681,11 +6707,18 @@
<programlisting>
shell> <userinput>mysqldump --all-databases --master-data=2 > all_databases.sql</userinput>
-or
-shell> <userinput>mysqldump --all-databases --flush-logs --master-data=2 > all_databases.sql</userinput>
</programlisting>
<para>
+ Or:
+ </para>
+
+<programlisting>
+shell> <userinput>mysqldump --all-databases --flush-logs --master-data=2</userinput>
+ <userinput>> all_databases.sql</userinput>
+</programlisting>
+
+ <para>
The simultaneous use of <option>--master-data</option> and
<option>--single-transaction</option> works as of MySQL 4.1.8.
It provides a convenient way to make an online backup suitable
@@ -6695,7 +6728,7 @@
<para>
For more information on making backups, see
- <xref linkend="backup"/>.
+ <xref linkend="backup"/>, and <xref linkend="backup-policy"/>.
</para>
</refsection>
@@ -6770,10 +6803,10 @@
originally written and contributed by Tim Bunce. It uses
<literal>LOCK TABLES</literal>, <literal>FLUSH
TABLES</literal>, and <literal>cp</literal> or
- <literal>scp</literal> to make a backup of a database quickly.
- It is the fastest way to make a backup of the database or
- single tables, but it can be run only on the same machine
- where the database directories are located.
+ <literal>scp</literal> to make a database backup quickly. It
+ is the fastest way to make a backup of the database or single
+ tables, but it can be run only on the same machine where the
+ database directories are located.
<command>mysqlhotcopy</command> works only for backing up
<literal>MyISAM</literal> and <literal>ISAM</literal> tables.
It runs on Unix, and as of MySQL 4.0.18 also on NetWare.
@@ -6833,8 +6866,8 @@
</para>
<para>
- Do not abort if target exists (rename it by adding an
- <literal>_old</literal> suffix).
+ Do not abort if a target exists; rename it by adding an
+ <literal>_old</literal> suffix.
</para>
</listitem>
@@ -6895,7 +6928,7 @@
</para>
<para>
- Method for copy (<literal>cp</literal> or
+ The method for copying files (<literal>cp</literal> or
<literal>scp</literal>).
</para>
</listitem>
@@ -6907,10 +6940,11 @@
<para>
Do not include full index files in the backup. This makes
- the backup smaller and faster. The indexes can be
- reconstructed later with <command>myisamchk -rq</command>
- for <literal>MyISAM</literal> tables or <command>isamchk
- -rq</command> for <literal>ISAM</literal> tables.
+ the backup smaller and faster. The indexes for reloaded
+ tables can be reconstructed later with <command>myisamchk
+ -rq</command> for <literal>MyISAM</literal> tables or
+ <command>isamchk -rq</command> for <literal>ISAM</literal>
+ tables.
</para>
</listitem>
@@ -6962,7 +6996,7 @@
</para>
<para>
- Copy all databases with names matching the given regular
+ Copy all databases with names that match the given regular
expression.
</para>
</listitem>
@@ -6994,8 +7028,8 @@
</para>
<para>
- The temporary directory (instead of
- <filename>/tmp</filename>).
+ The temporary directory. The default is
+ <filename>/tmp</filename>.
</para>
</listitem>
@@ -7029,7 +7063,9 @@
<para>
Use <literal>perldoc</literal> for additional
- <command>mysqlhotcopy</command> documentation:
+ <command>mysqlhotcopy</command> documentation, including
+ information about the structure of the table needed for the
+ <option>--checkpoint</option> option.
</para>
<programlisting>
@@ -7103,7 +7139,7 @@
command-line interface to the <literal>LOAD DATA
INFILE</literal> SQL statement. Most options to
<command>mysqlimport</command> correspond directly to clauses
- of <literal>LOAD DATA INFILE</literal>. See
+ of <literal>LOAD DATA INFILE</literal> syntax. See
<xref linkend="load-data"/>.
</para>
@@ -7245,11 +7281,11 @@
<listitem>
<para>
- <option>--ignore-lines=<replaceable>n</replaceable></option>
+ <option>--ignore-lines=<replaceable>N</replaceable></option>
</para>
<para>
- Ignore the first <replaceable>n</replaceable> lines of the
+ Ignore the first <replaceable>N</replaceable> lines of the
data file.
</para>
</listitem>
@@ -7328,8 +7364,8 @@
<para>
The <option>--replace</option> and
<option>--ignore</option> options control handling of
- input records that duplicate existing records on unique
- key values. If you specify <option>--replace</option>, new
+ input rows that duplicate existing rows on unique key
+ values. If you specify <option>--replace</option>, new
rows replace existing rows that have the same unique key
value. If you specify <option>--ignore</option>, input
rows that duplicate an existing row on a unique key value
@@ -7495,17 +7531,16 @@
<para>
The <command>mysqlshow</command> client can be used to quickly
- look at which databases exist, their tables, and a table's
- columns or indexes.
+ see which databases exist, their tables, or a table's columns
+ or indexes.
</para>
<para>
<command>mysqlshow</command> provides a command-line interface
- to several SQL <literal>SHOW</literal> statements. The same
- information can be obtained by using those statements
- directly. For example, you can issue them from the
- <command>mysql</command> client program. See
- <xref linkend="show"/>.
+ to several SQL <literal>SHOW</literal> statements. See
+ <xref linkend="show"/>. The same information can be obtained
+ by using those statements directly. For example, you can issue
+ them from the <command>mysql</command> client program.
</para>
<para>
@@ -7520,7 +7555,8 @@
<listitem>
<para>
- If no database is given, all matching databases are shown.
+ If no database is given, a list of database names is
+ shown.
</para>
</listitem>
@@ -7541,9 +7577,8 @@
</itemizedlist>
<para>
- Note that in newer MySQL versions, you see only those
- database, tables, or columns for which you have some
- privileges.
+ The output displays only the names of those databases, tables,
+ or columns for which you have some privileges.
</para>
<para>
Modified: trunk/refman-4.1/functions.xml
===================================================================
--- trunk/refman-4.1/functions.xml 2006-01-20 23:46:33 UTC (rev 957)
+++ trunk/refman-4.1/functions.xml 2006-01-20 23:51:00 UTC (rev 958)
@@ -12920,8 +12920,9 @@
Returns the <emphasis>first</emphasis> automatically
generated value that was set for an
<literal>AUTO_INCREMENT</literal> column by the
- <emphasis>last</emphasis> <literal>INSERT</literal> or
- <literal>UPDATE</literal> query to affect such a column.
+ <emphasis>most recent</emphasis> <literal>INSERT</literal>
+ or <literal>UPDATE</literal> statement to affect such a
+ column.
</para>
<remark role="help-description-end"/>
@@ -13024,10 +13025,12 @@
</programlisting>
<para>
- Although the second query inserted 3 new rows into
- <literal>t</literal>, the ID generated for the first of
- these rows was <literal>2</literal>, and it is this value
- that is returned by <literal>LAST_INSERT_ID()</literal>.
+ Although the second <literal>INSERT</literal> statement
+ inserted 3 new rows into <literal>t</literal>, the ID
+ generated for the first of these rows was
+ <literal>2</literal>, and it is this value that is returned
+ by <literal>LAST_INSERT_ID()</literal> for the following
+ <literal>SELECT</literal> statement.
</para>
<para>
Modified: trunk/refman-5.0/client-utility-programs.xml
===================================================================
--- trunk/refman-5.0/client-utility-programs.xml 2006-01-20 23:46:33 UTC (rev 957)
+++ trunk/refman-5.0/client-utility-programs.xml 2006-01-20 23:51:00 UTC (rev 958)
@@ -670,8 +670,8 @@
<para>
When the table is used later, the server reads into memory the
information needed to decompress columns. This results in much
- better performance when accessing individual records, because
- you only have to uncompress exactly one record.
+ better performance when accessing individual rows, because you
+ only have to uncompress exactly one row.
</para>
<para>
@@ -827,16 +827,16 @@
</para>
<para>
- Specify the record length storage size, in bytes. The
- value should be 1, 2, or 3. <command>myisampack</command>
- stores all rows with length pointers of 1, 2, or 3 bytes.
- In most normal cases, <command>myisampack</command> can
- determine the correct length value before it begins
- packing the file, but it may notice during the packing
- process that it could have used a shorter length. In this
- case, <command>myisampack</command> prints a note that you
- could use a shorter record length the next time you pack
- the same file.
+ Specify the row length storage size, in bytes. The value
+ should be 1, 2, or 3. <command>myisampack</command> stores
+ all rows with length pointers of 1, 2, or 3 bytes. In most
+ normal cases, <command>myisampack</command> can determine
+ the correct length value before it begins packing the
+ file, but it may notice during the packing process that it
+ could have used a shorter length. In this case,
+ <command>myisampack</command> prints a note that you could
+ use a shorter row length the next time you pack the same
+ file.
</para>
</listitem>
@@ -4141,8 +4141,8 @@
<listitem>
<para>
- <option>--count=<replaceable>num</replaceable></option>,
- <option>-c <replaceable>num</replaceable></option>
+ <option>--count=<replaceable>N</replaceable></option>,
+ <option>-c <replaceable>N</replaceable></option>
</para>
<para>
@@ -5373,9 +5373,8 @@
<title>Description</title>
<para>
- The <command>mysqlcheck</command> client checks and repairs
- <literal>MyISAM</literal> tables. It can also optimize and
- analyze tables.
+ The <command>mysqlcheck</command> client checks, repairs,
+ optimizes, and analyzes tables.
</para>
<para>
@@ -5395,23 +5394,41 @@
TABLE</literal>, <literal>ANALYZE TABLE</literal>, and
<literal>OPTIMIZE TABLE</literal> in a convenient way for the
user. It determines which statements to use for the operation
- you want to perform, then sends the statements to the server
- to be executed.
+ you want to perform, and then sends the statements to the
+ server to be executed.
</para>
<para>
+ The <literal>MyIAM</literal> storage engine supports all four
+ statements, so <command>mysqlcheck</command> can be used to
+ perform all four operations on <literal>MyISAM</literal>
+ tables. Other storage engines do not necessarily support all
+ operations. In such cases, an error message is displayed. For
+ example, if <literal>test.t</literal> is a
+ <literal>MEMORY</literal> table, an attempt to check it
+ produces this result:
+ </para>
+
+<programlisting>
+shell> <userinput>mysqlcheck test t</userinput>
+test.t
+note : The storage engine for the table doesn't support check
+</programlisting>
+
+ <para>
There are three general ways to invoke
<command>mysqlcheck</command>:
</para>
<programlisting>
shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] <replaceable>db_name</replaceable> [<replaceable>tables</replaceable>]</userinput>
-shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --databases <replaceable>DB1</replaceable> [<replaceable>DB2</replaceable> <replaceable>DB3</replaceable>...]</userinput>
+shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --databases <replaceable>db_name1</replaceable> [<replaceable>db_name2</replaceable> <replaceable>db_name3</replaceable>...]</userinput>
shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --all-databases</userinput>
</programlisting>
<para>
- If you do not name any tables or use the
+ If you do not name any tables following
+ <replaceable>db_name</replaceable> or if you use the
<option>--databases</option> or
<option>--all-databases</option> option, entire databases are
checked.
@@ -5419,9 +5436,9 @@
<para>
<command>mysqlcheck</command> has a special feature compared
- to the other clients. The default behavior of checking tables
- (<option>--check</option>) can be changed by renaming the
- binary. If you want to have a tool that repairs tables by
+ to other client programs. The default behavior of checking
+ tables (<option>--check</option>) can be changed by renaming
+ the binary. If you want to have a tool that repairs tables by
default, you should just make a copy of
<command>mysqlcheck</command> named
<command>mysqlrepair</command>, or make a symbolic link to
@@ -5535,7 +5552,8 @@
</para>
<para>
- Check the tables for errors.
+ Check the tables for errors. This is the default
+ operation.
</para>
</listitem>
@@ -5567,9 +5585,11 @@
</para>
<para>
- Process all tables in the named databases. With this
- option, all name arguments are regarded as database names,
- not as table names.
+ Process all tables in the named databases. Normally,
+ <command>mysqlcheck</command> treats the first name
+ argument on the command line as a database name and
+ following names as table names. With this option, it
+ treats all name arguments as database names.
</para>
</listitem>
@@ -5581,7 +5601,7 @@
</para>
<para>
- Write a debugging log. The
+ Write a debugging log. A typical
<replaceable>debug_options</replaceable> string is often
<literal>'d:t:o,<replaceable>file_name</replaceable>'</literal>.
</para>
@@ -5772,8 +5792,8 @@
<para>
Overrides the <option>--databases</option> or
- <option>-B</option> option. All arguments following the
- option are regarded as table names.
+ <option>-B</option> option. All name arguments following
+ the option are regarded as table names.
</para>
</listitem>
@@ -5889,10 +5909,10 @@
<para>
If you are doing a backup on the server, and your tables all
- are <literal>MyISAM</literal> tables, you could consider using
- the <command>mysqlhotcopy</command> instead because faster
- backups and faster restores can be accomplished with the
- latter. See <xref linkend="mysqlhotcopy"/>.
+ are <literal>MyISAM</literal> tables, consider using the
+ <command>mysqlhotcopy</command> instead because it can
+ accomplish faster backups and faster restores. See
+ <xref linkend="mysqlhotcopy"/>.
</para>
<para>
@@ -5902,12 +5922,13 @@
<programlisting>
shell> <userinput>mysqldump [<replaceable>options</replaceable>] <replaceable>db_name</replaceable> [<replaceable>tables</replaceable>]</userinput>
-shell> <userinput>mysqldump [<replaceable>options</replaceable>] --databases <replaceable>DB1</replaceable> [<replaceable>DB2</replaceable> <replaceable>DB3</replaceable>...]</userinput>
+shell> <userinput>mysqldump [<replaceable>options</replaceable>] --databases <replaceable>db_name1</replaceable> [<replaceable>db_name2</replaceable> <replaceable>db_name3</replaceable>...]</userinput>
shell> <userinput>mysqldump [<replaceable>options</replaceable>] --all-databases</userinput>
</programlisting>
<para>
- If you do not name any tables or use the
+ If you do not name any tables following
+ <replaceable>db_name</replaceable> or if you use the
<option>--databases</option> or
<option>--all-databases</option> option, entire databases are
dumped.
@@ -5923,16 +5944,18 @@
If you run <command>mysqldump</command> without the
<option>--quick</option> or <option>--opt</option> option,
<command>mysqldump</command> loads the whole result set into
- memory before dumping the result. This probably is a problem
- if you are dumping a big database. This option is enabled by
- default, but can be disabled with <option>--skip-opt</option>.
+ memory before dumping the result. This can be a problem if you
+ are dumping a big database. The <option>--opt</option> option
+ is enabled by default, but can be disabled with
+ <option>--skip-opt</option>.
</para>
<para>
If you are using a recent copy of the
<command>mysqldump</command> program to generate a dump to be
reloaded into a very old MySQL server, you should not use the
- <option>--opt</option> or <option>-e</option> options.
+ <option>--opt</option> or <option>--extended-insert</option>
+ option. Use <option>--skip-opt</option> instead.
</para>
<para>
@@ -6114,11 +6137,9 @@
argument on the command line as a database name and
following names as table names. With this option, it
treats all name arguments as database names.
- <literal>CREATE DATABASE IF NOT EXISTS
- <replaceable>db_name</replaceable></literal> and
- <literal>USE <replaceable>db_name</replaceable></literal>
- statements are included in the output before each new
- database.
+ <literal>CREATE DATABASE</literal> and
+ <literal>USE</literal> statements are included in the
+ output before each new database.
</para>
</listitem>
@@ -6157,8 +6178,8 @@
</para>
<para>
- Insert rows using <literal>INSERT DELAYED</literal>
- statements.
+ Write <literal>INSERT DELAYED</literal> statements rather
+ than <literal>INSERT</literal> statements.
</para>
</listitem>
@@ -6284,9 +6305,9 @@
</para>
<para>
- Dump binary string columns using hexadecimal notation (for
+ Dump binary columns using hexadecimal notation (for
example, <literal>'abc'</literal> becomes
- <literal>0x616263</literal>). The affected columns are
+ <literal>0x616263</literal>). The affected data types are
<literal>BINARY</literal>, <literal>VARBINARY</literal>,
and <literal>BLOB</literal>. As of MySQL 5.0.13,
<literal>BIT</literal> columns are affected as well.
@@ -6340,16 +6361,16 @@
</para>
<para>
- This option causes the binary log position and filename to
- be written to the output. This option requires the
- <literal>RELOAD</literal> privilege and the binary log
- must be enabled. If the option value is equal to 1, the
- position and filename are written to the dump output in
- the form of a <literal>CHANGE MASTER</literal> statement
- that makes a slave server start from the correct position
- in the master's binary logs if you use this SQL dump of
- the master to set up a slave. If the option value is equal
- to 2, the <literal>CHANGE MASTER</literal> statement is
+ Write the binary log filename and position to the output.
+ This option requires the <literal>RELOAD</literal>
+ privilege and the binary log must be enabled. If the
+ option value is equal to 1, the position and filename are
+ written to the dump output in the form of a
+ <literal>CHANGE MASTER</literal> statement that makes a
+ slave server start from the correct position in the
+ master's binary logs if you use this SQL dump of the
+ master to set up a slave. If the option value is equal to
+ 2, the <literal>CHANGE MASTER</literal> statement is
written as an SQL comment. This is the default action if
<replaceable>value</replaceable> is omitted.
</para>
@@ -6373,10 +6394,9 @@
</para>
<para>
- This option suppresses the <literal>CREATE DATABASE
- /*!32312 IF NOT EXISTS*/ db_name</literal> statements that
- are otherwise included in the output if the
- <option>--databases</option> or
+ This option suppresses the <literal>CREATE
+ DATABASE</literal> statements that are otherwise included
+ in the output if the <option>--databases</option> or
<option>--all-databases</option> option is given.
</para>
</listitem>
@@ -6399,8 +6419,8 @@
<para>
Do not write any row information for the table. This is
- very useful if you want to get a dump of only the
- structure for a table.
+ very useful if you want to dump only the <literal>CREATE
+ TABLE</literal> statement for the table.
</para>
</listitem>
@@ -6415,14 +6435,17 @@
--disable-keys --extended-insert --lock-tables --quick
--set-charset</option>. It should give you a fast dump
operation and produce a dump file that can be reloaded
- into a MySQL server quickly. <emphasis>This option is on
- by default, but can be disabled with
- <option>--skip-opt</option></emphasis>. To disable only
- certain of the options enabled by <option>--opt</option>,
- use their <option>--skip</option> forms; for example,
- <option>--skip-add-drop-table</option> or
- <option>--skip-quick</option>.
+ into a MySQL server quickly.
</para>
+
+ <para>
+ <emphasis>This option is enabled by default, but can be
+ disabled with <option>--skip-opt</option></emphasis>. To
+ disable only certain of the options enabled by
+ <option>--opt</option>, use their <option>--skip</option>
+ forms; for example, <option>--skip-add-drop-table</option>
+ or <option>--skip-quick</option>.
+ </para>
</listitem>
<listitem>
@@ -6493,9 +6516,9 @@
‘<literal>`</literal>’ characters. If the
<literal>ANSI_QUOTES</literal> SQL mode is enabled, names
are quoted within ‘<literal>"</literal>’
- characters. It is on by default. It can be disabled with
- <option>--skip-quote-names</option>, but this option
- should be given after any option such as
+ characters. This option is enabled by default. It can be
+ disabled with <option>--skip-quote-names</option>, but
+ this option should be given after any option such as
<option>--compatible</option> that may enable
<option>--quote-names</option>.
</para>
@@ -6509,7 +6532,7 @@
<para>
Direct output to a given file. This option should be used
- on Windows, because it prevents newline
+ on Windows to prevent newline
‘<literal>\n</literal>’ characters from being
converted to ‘<literal>\r\n</literal>’
carriage return/newline sequences.
@@ -6522,7 +6545,7 @@
</para>
<para>
- Dump stored routines (functions and procedures) in the
+ Dump stored routines (functions and procedures) from the
dumped databases. The output generated by using
<option>---routines</option> contains <literal>CREATE
PROCEDURE</literal> and <literal>CREATE FUNCTION</literal>
@@ -6669,8 +6692,8 @@
<para>
Override the <option>--databases</option> or
- <option>-B</option> option. All arguments following the
- option are regarded as table names.
+ <option>-B</option> option. All name arguments following
+ the option are regarded as table names.
</para>
</listitem>
@@ -6680,10 +6703,10 @@
</para>
<para>
- Dump triggers for each dumped table. This option is on by
- default; disable it with <option>--skip-triggers</option>.
- This option was added in MySQL 5.0.11. Before that,
- triggers are not dumped.
+ Dump triggers for each dumped table. This option is
+ enabled by default; disable it with
+ <option>--skip-triggers</option>. This option was added in
+ MySQL 5.0.11. Before that, triggers are not dumped.
</para>
</listitem>
@@ -6696,14 +6719,14 @@
Add <literal>SET TIME_ZONE='+00:00'</literal> to the dump
file so that <literal>TIMESTAMP</literal> columns can be
dumped and reloaded between servers in different time
- zones. (Without this option, <literal>TIMESTAMP</literal>
- columns are dumped and reloaded in the local time zones of
- the source and destination servers.)
- <option>--tz-utc</option> also protects against changes
- due to daylight saving time. <option>--tz-utc</option> is
- enabled by default. To disable it, use
- <option>--skip-tz-utc</option>. This option was added in
- MySQL 5.0.15.
+ zones. Without this option, <literal>TIMESTAMP</literal>
+ columns are dumped and reloaded in the time zones local to
+ the source and destination servers, which can cause the
+ values to change. <option>--tz-utc</option> also protects
+ against changes due to daylight saving time.
+ <option>--tz-utc</option> is enabled by default. To
+ disable it, use <option>--skip-tz-utc</option>. This
+ option was added in MySQL 5.0.15.
</para>
</listitem>
@@ -6741,16 +6764,16 @@
<listitem>
<para>
- <option>--where='<replaceable>where-condition</replaceable>'</option>,
+ <option>--where='<replaceable>where_condition</replaceable>'</option>,
<option>-w
- '<replaceable>where-condition</replaceable>'</option>
+ '<replaceable>where_condition</replaceable>'</option>
</para>
<para>
- Dump only records selected by the given
+ Dump only rows selected by the given
<literal>WHERE</literal> condition. Note that quotes
around the condition are mandatory if it contains spaces
- or characters that are special to your command
+ or other characters that are special to your command
interpreter.
</para>
@@ -6759,9 +6782,9 @@
</para>
<programlisting>
-"--where=user='jimf'"
-"-wuserid>1"
-"-wuserid<1"
+--where="user='jimf'"
+-w"userid>1"
+-w"userid<1"
</programlisting>
</listitem>
@@ -6868,7 +6891,7 @@
</programlisting>
<para>
- If you want to dump all databases, use the
+ To dump all databases, use the
<option>--all-databases</option> option:
</para>
@@ -6877,20 +6900,9 @@
</programlisting>
<para>
- If tables are stored in the <literal>InnoDB</literal> storage
- engine, <literal>mysqldump</literal> provides a way of making
- an online backup of these (see command below). This backup
- just needs to acquire a global read lock on all tables (using
- <literal>FLUSH TABLES WITH READ LOCK</literal>) at the
- beginning of the dump. As soon as this lock has been acquired,
- the binary log coordinates are read and lock is released. So
- if and only if one long updating statement is running when the
- <literal>FLUSH …</literal> is issued, the MySQL server
- may get stalled until that long statement finishes, and then
- the dump becomes lock-free. So if the MySQL server receives
- only short (in the sense of <quote>short execution
- time</quote>) updating statements, even if there are plenty of
- them, the initial lock period should not be noticeable.
+ For <literal>InnoDB</literal> tables,
+ <literal>mysqldump</literal> provides a way of making an
+ online backup:
</para>
<programlisting>
@@ -6898,9 +6910,23 @@
</programlisting>
<para>
+ This backup just needs to acquire a global read lock on all
+ tables (using <literal>FLUSH TABLES WITH READ LOCK</literal>)
+ at the beginning of the dump. As soon as this lock has been
+ acquired, the binary log coordinates are read and the lock is
+ released. If and only if one long updating statement is
+ running when the <literal>FLUSH</literal> statement is issued,
+ the MySQL server may get stalled until that long statement
+ finishes, and then the dump becomes lock-free. If the update
+ statements that the MySQL server receives are short (in terms
+ of execution time), the initial lock period should not be
+ noticeable, even with many updates.
+ </para>
+
+ <para>
For point-in-time recovery (also known as
<quote>roll-forward,</quote> when you need to restore an old
- backup and replay the changes which happened since that
+ backup and replay the changes that happened since that
backup), it is often useful to rotate the binary log (see
<xref linkend="binary-log"/>) or at least know the binary log
coordinates to which the dump corresponds:
@@ -6908,11 +6934,18 @@
<programlisting>
shell> <userinput>mysqldump --all-databases --master-data=2 > all_databases.sql</userinput>
-or
-shell> <userinput>mysqldump --all-databases --flush-logs --master-data=2 > all_databases.sql</userinput>
</programlisting>
<para>
+ Or:
+ </para>
+
+<programlisting>
+shell> <userinput>mysqldump --all-databases --flush-logs --master-data=2</userinput>
+ <userinput>> all_databases.sql</userinput>
+</programlisting>
+
+ <para>
The simultaneous use of <option>--master-data</option> and
<option>--single-transaction</option> provides a convenient
way to make an online backup suitable for point-in-time
@@ -6922,7 +6955,7 @@
<para>
For more information on making backups, see
- <xref linkend="backup"/>.
+ <xref linkend="backup"/>, and <xref linkend="backup-policy"/>.
</para>
</refsection>
@@ -6997,12 +7030,12 @@
originally written and contributed by Tim Bunce. It uses
<literal>LOCK TABLES</literal>, <literal>FLUSH
TABLES</literal>, and <literal>cp</literal> or
- <literal>scp</literal> to make a backup of a database quickly.
- It is the fastest way to make a backup of the database or
- single tables, but it can be run only on the same machine
- where the database directories are located.
+ <literal>scp</literal> to make a database backup quickly. It
+ is the fastest way to make a backup of the database or single
+ tables, but it can be run only on the same machine where the
+ database directories are located.
<command>mysqlhotcopy</command> works only for backing up
- <literal>MyISAM</literal>. It runs on Unix and NetWare.
+ <literal>MyISAM</literal> tables. It runs on Unix and NetWare.
</para>
<remark role="todo">
@@ -7059,8 +7092,8 @@
</para>
<para>
- Do not abort if target exists (rename it by adding an
- <literal>_old</literal> suffix).
+ Do not abort if a target exists; rename it by adding an
+ <literal>_old</literal> suffix.
</para>
</listitem>
@@ -7121,7 +7154,7 @@
</para>
<para>
- Method for copy (<literal>cp</literal> or
+ The method for copying files (<literal>cp</literal> or
<literal>scp</literal>).
</para>
</listitem>
@@ -7133,8 +7166,9 @@
<para>
Do not include full index files in the backup. This makes
- the backup smaller and faster. The indexes can be
- reconstructed later with <command>myisamchk -rq</command>.
+ the backup smaller and faster. The indexes for reloaded
+ tables can be reconstructed later with <command>myisamchk
+ -rq</command>.
</para>
</listitem>
@@ -7186,7 +7220,7 @@
</para>
<para>
- Copy all databases with names matching the given regular
+ Copy all databases with names that match the given regular
expression.
</para>
</listitem>
@@ -7218,8 +7252,8 @@
</para>
<para>
- The temporary directory (instead of
- <filename>/tmp</filename>).
+ The temporary directory. The default is
+ <filename>/tmp</filename>.
</para>
</listitem>
@@ -7253,7 +7287,9 @@
<para>
Use <literal>perldoc</literal> for additional
- <command>mysqlhotcopy</command> documentation:
+ <command>mysqlhotcopy</command> documentation, including
+ information about the structure of the table needed for the
+ <option>--checkpoint</option> option.
</para>
<programlisting>
@@ -7327,7 +7363,7 @@
command-line interface to the <literal>LOAD DATA
INFILE</literal> SQL statement. Most options to
<command>mysqlimport</command> correspond directly to clauses
- of <literal>LOAD DATA INFILE</literal>. See
+ of <literal>LOAD DATA INFILE</literal> syntax. See
<xref linkend="load-data"/>.
</para>
@@ -7469,11 +7505,11 @@
<listitem>
<para>
- <option>--ignore-lines=<replaceable>n</replaceable></option>
+ <option>--ignore-lines=<replaceable>N</replaceable></option>
</para>
<para>
- Ignore the first <replaceable>n</replaceable> lines of the
+ Ignore the first <replaceable>N</replaceable> lines of the
data file.
</para>
</listitem>
@@ -7552,8 +7588,8 @@
<para>
The <option>--replace</option> and
<option>--ignore</option> options control handling of
- input records that duplicate existing records on unique
- key values. If you specify <option>--replace</option>, new
+ input rows that duplicate existing rows on unique key
+ values. If you specify <option>--replace</option>, new
rows replace existing rows that have the same unique key
value. If you specify <option>--ignore</option>, input
rows that duplicate an existing row on a unique key value
@@ -7719,17 +7755,16 @@
<para>
The <command>mysqlshow</command> client can be used to quickly
- look at which databases exist, their tables, and a table's
- columns or indexes.
+ see which databases exist, their tables, or a table's columns
+ or indexes.
</para>
<para>
<command>mysqlshow</command> provides a command-line interface
- to several SQL <literal>SHOW</literal> statements. The same
- information can be obtained by using those statements
- directly. For example, you can issue them from the
- <command>mysql</command> client program. See
- <xref linkend="show"/>.
+ to several SQL <literal>SHOW</literal> statements. See
+ <xref linkend="show"/>. The same information can be obtained
+ by using those statements directly. For example, you can issue
+ them from the <command>mysql</command> client program.
</para>
<para>
@@ -7744,7 +7779,8 @@
<listitem>
<para>
- If no database is given, all matching databases are shown.
+ If no database is given, a list of database names is
+ shown.
</para>
</listitem>
@@ -7765,9 +7801,8 @@
</itemizedlist>
<para>
- Note that in newer MySQL versions, you see only those
- database, tables, or columns for which you have some
- privileges.
+ The output displays only the names of those databases, tables,
+ or columns for which you have some privileges.
</para>
<para>
Modified: trunk/refman-5.0/functions.xml
===================================================================
--- trunk/refman-5.0/functions.xml 2006-01-20 23:46:33 UTC (rev 957)
+++ trunk/refman-5.0/functions.xml 2006-01-20 23:51:00 UTC (rev 958)
@@ -12885,8 +12885,9 @@
Returns the <emphasis>first</emphasis> automatically
generated value that was set for an
<literal>AUTO_INCREMENT</literal> column by the
- <emphasis>last</emphasis> <literal>INSERT</literal> or
- <literal>UPDATE</literal> query to affect such a column.
+ <emphasis>most recent</emphasis> <literal>INSERT</literal>
+ or <literal>UPDATE</literal> statement to affect such a
+ column.
</para>
<remark role="help-description-end"/>
@@ -12989,10 +12990,12 @@
</programlisting>
<para>
- Although the second query inserted 3 new rows into
- <literal>t</literal>, the ID generated for the first of
- these rows was <literal>2</literal>, and it is this value
- that is returned by <literal>LAST_INSERT_ID()</literal>.
+ Although the second <literal>INSERT</literal> statement
+ inserted 3 new rows into <literal>t</literal>, the ID
+ generated for the first of these rows was
+ <literal>2</literal>, and it is this value that is returned
+ by <literal>LAST_INSERT_ID()</literal> for the following
+ <literal>SELECT</literal> statement.
</para>
<para>
Modified: trunk/refman-5.1/client-utility-programs.xml
===================================================================
--- trunk/refman-5.1/client-utility-programs.xml 2006-01-20 23:46:33 UTC (rev 957)
+++ trunk/refman-5.1/client-utility-programs.xml 2006-01-20 23:51:00 UTC (rev 958)
@@ -686,8 +686,8 @@
<para>
When the table is used later, the server reads into memory the
information needed to decompress columns. This results in much
- better performance when accessing individual records, because
- you only have to uncompress exactly one record.
+ better performance when accessing individual rows, because you
+ only have to uncompress exactly one row.
</para>
<para>
@@ -843,16 +843,16 @@
</para>
<para>
- Specify the record length storage size, in bytes. The
- value should be 1, 2, or 3. <command>myisampack</command>
- stores all rows with length pointers of 1, 2, or 3 bytes.
- In most normal cases, <command>myisampack</command> can
- determine the correct length value before it begins
- packing the file, but it may notice during the packing
- process that it could have used a shorter length. In this
- case, <command>myisampack</command> prints a note that you
- could use a shorter record length the next time you pack
- the same file.
+ Specify the row length storage size, in bytes. The value
+ should be 1, 2, or 3. <command>myisampack</command> stores
+ all rows with length pointers of 1, 2, or 3 bytes. In most
+ normal cases, <command>myisampack</command> can determine
+ the correct length value before it begins packing the
+ file, but it may notice during the packing process that it
+ could have used a shorter length. In this case,
+ <command>myisampack</command> prints a note that you could
+ use a shorter row length the next time you pack the same
+ file.
</para>
</listitem>
@@ -4157,8 +4157,8 @@
<listitem>
<para>
- <option>--count=<replaceable>num</replaceable></option>,
- <option>-c <replaceable>num</replaceable></option>
+ <option>--count=<replaceable>N</replaceable></option>,
+ <option>-c <replaceable>N</replaceable></option>
</para>
<para>
@@ -5414,9 +5414,8 @@
<title>Description</title>
<para>
- The <command>mysqlcheck</command> client checks and repairs
- <literal>MyISAM</literal> tables. It can also optimize and
- analyze tables.
+ The <command>mysqlcheck</command> client checks, repairs,
+ optimizes, and analyzes tables.
</para>
<para>
@@ -5436,23 +5435,41 @@
TABLE</literal>, <literal>ANALYZE TABLE</literal>, and
<literal>OPTIMIZE TABLE</literal> in a convenient way for the
user. It determines which statements to use for the operation
- you want to perform, then sends the statements to the server
- to be executed.
+ you want to perform, and then sends the statements to the
+ server to be executed.
</para>
<para>
+ The <literal>MyIAM</literal> storage engine supports all four
+ statements, so <command>mysqlcheck</command> can be used to
+ perform all four operations on <literal>MyISAM</literal>
+ tables. Other storage engines do not necessarily support all
+ operations. In such cases, an error message is displayed. For
+ example, if <literal>test.t</literal> is a
+ <literal>MEMORY</literal> table, an attempt to check it
+ produces this result:
+ </para>
+
+<programlisting>
+shell> <userinput>mysqlcheck test t</userinput>
+test.t
+note : The storage engine for the table doesn't support check
+</programlisting>
+
+ <para>
There are three general ways to invoke
<command>mysqlcheck</command>:
</para>
<programlisting>
shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] <replaceable>db_name</replaceable> [<replaceable>tables</replaceable>]</userinput>
-shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --databases <replaceable>DB1</replaceable> [<replaceable>DB2</replaceable> <replaceable>DB3</replaceable>...]</userinput>
+shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --databases <replaceable>db_name1</replaceable> [<replaceable>db_name2</replaceable> <replaceable>db_name3</replaceable>...]</userinput>
shell> <userinput>mysqlcheck [<replaceable>options</replaceable>] --all-databases</userinput>
</programlisting>
<para>
- If you do not name any tables or use the
+ If you do not name any tables following
+ <replaceable>db_name</replaceable> or if you use the
<option>--databases</option> or
<option>--all-databases</option> option, entire databases are
checked.
@@ -5460,9 +5477,9 @@
<para>
<command>mysqlcheck</command> has a special feature compared
- to the other clients. The default behavior of checking tables
- (<option>--check</option>) can be changed by renaming the
- binary. If you want to have a tool that repairs tables by
+ to other client programs. The default behavior of checking
+ tables (<option>--check</option>) can be changed by renaming
+ the binary. If you want to have a tool that repairs tables by
default, you should just make a copy of
<command>mysqlcheck</command> named
<command>mysqlrepair</command>, or make a symbolic link to
@@ -5576,7 +5593,8 @@
</para>
<para>
- Check the tables for errors.
+ Check the tables for errors. This is the default
+ operation.
</para>
</listitem>
@@ -5608,9 +5626,11 @@
</para>
<para>
- Process all tables in the named databases. With this
- option, all name arguments are regarded as database names,
- not as table names.
+ Process all tables in the named databases. Normally,
+ <command>mysqlcheck</command> treats the first name
+ argument on the command line as a database name and
+ following names as table names. With this option, it
+ treats all name arguments as database names.
</para>
</listitem>
@@ -5622,7 +5642,7 @@
</para>
<para>
- Write a debugging log. The
+ Write a debugging log. A typical
<replaceable>debug_options</replaceable> string is often
<literal>'d:t:o,<replaceable>file_name</replaceable>'</literal>.
</para>
@@ -5813,8 +5833,8 @@
<para>
Overrides the <option>--databases</option> or
- <option>-B</option> option. All arguments following the
- option are regarded as table names.
+ <option>-B</option> option. All name arguments following
+ the option are regarded as table names.
</para>
</listitem>
@@ -5930,10 +5950,10 @@
<para>
If you are doing a backup on the server, and your tables all
- are <literal>MyISAM</literal> tables, you could consider using
- the <command>mysqlhotcopy</command> instead because faster
- backups and faster restores can be accomplished with the
- latter. See <xref linkend="mysqlhotcopy"/>.
+ are <literal>MyISAM</literal> tables, consider using the
+ <command>mysqlhotcopy</command> instead because it can
+ accomplish faster backups and faster restores. See
+ <xref linkend="mysqlhotcopy"/>.
</para>
<para>
@@ -5943,12 +5963,13 @@
<programlisting>
shell> <userinput>mysqldump [<replaceable>options</replaceable>] <replaceable>db_name</replaceable> [<replaceable>tables</replaceable>]</userinput>
-shell> <userinput>mysqldump [<replaceable>options</replaceable>] --databases <replaceable>DB1</replaceable> [<replaceable>DB2</replaceable> <replaceable>DB3</replaceable>...]</userinput>
+shell> <userinput>mysqldump [<replaceable>options</replaceable>] --databases <replaceable>db_name1</replaceable> [<replaceable>db_name2</replaceable> <replaceable>db_name3</replaceable>...]</userinput>
shell> <userinput>mysqldump [<replaceable>options</replaceable>] --all-databases</userinput>
</programlisting>
<para>
- If you do not name any tables or use the
+ If you do not name any tables following
+ <replaceable>db_name</replaceable> or if you use the
<option>--databases</option> or
<option>--all-databases</option> option, entire databases are
dumped.
@@ -5964,16 +5985,18 @@
If you run <command>mysqldump</command> without the
<option>--quick</option> or <option>--opt</option> option,
<command>mysqldump</command> loads the whole result set into
- memory before dumping the result. This probably is a problem
- if you are dumping a big database. This option is enabled by
- default, but can be disabled with <option>--skip-opt</option>.
+ memory before dumping the result. This can be a problem if you
+ are dumping a big database. The <option>--opt</option> option
+ is enabled by default, but can be disabled with
+ <option>--skip-opt</option>.
</para>
<para>
If you are using a recent copy of the
<command>mysqldump</command> program to generate a dump to be
reloaded into a very old MySQL server, you should not use the
- <option>--opt</option> or <option>-e</option> options.
+ <option>--opt</option> or <option>--extended-insert</option>
+ option. Use <option>--skip-opt</option> instead.
</para>
<para>
@@ -6155,11 +6178,9 @@
argument on the command line as a database name and
following names as table names. With this option, it
treats all name arguments as database names.
- <literal>CREATE DATABASE IF NOT EXISTS
- <replaceable>db_name</replaceable></literal> and
- <literal>USE <replaceable>db_name</replaceable></literal>
- statements are included in the output before each new
- database.
+ <literal>CREATE DATABASE</literal> and
+ <literal>USE</literal> statements are included in the
+ output before each new database.
</para>
</listitem>
@@ -6198,8 +6219,8 @@
</para>
<para>
- Insert rows using <literal>INSERT DELAYED</literal>
- statements.
+ Write <literal>INSERT DELAYED</literal> statements rather
+ than <literal>INSERT</literal> statements.
</para>
</listitem>
@@ -6325,9 +6346,9 @@
</para>
<para>
- Dump binary string columns using hexadecimal notation (for
+ Dump binary columns using hexadecimal notation (for
example, <literal>'abc'</literal> becomes
- <literal>0x616263</literal>). The affected columns are
+ <literal>0x616263</literal>). The affected data types are
<literal>BINARY</literal>, <literal>VARBINARY</literal>,
<literal>BLOB</literal>, and <literal>BIT</literal>.
</para>
@@ -6380,16 +6401,16 @@
</para>
<para>
- This option causes the binary log position and filename to
- be written to the output. This option requires the
- <literal>RELOAD</literal> privilege and the binary log
- must be enabled. If the option value is equal to 1, the
- position and filename are written to the dump output in
- the form of a <literal>CHANGE MASTER</literal> statement
- that makes a slave server start from the correct position
- in the master's binary logs if you use this SQL dump of
- the master to set up a slave. If the option value is equal
- to 2, the <literal>CHANGE MASTER</literal> statement is
+ Write the binary log filename and position to the output.
+ This option requires the <literal>RELOAD</literal>
+ privilege and the binary log must be enabled. If the
+ option value is equal to 1, the position and filename are
+ written to the dump output in the form of a
+ <literal>CHANGE MASTER</literal> statement that makes a
+ slave server start from the correct position in the
+ master's binary logs if you use this SQL dump of the
+ master to set up a slave. If the option value is equal to
+ 2, the <literal>CHANGE MASTER</literal> statement is
written as an SQL comment. This is the default action if
<replaceable>value</replaceable> is omitted.
</para>
@@ -6413,10 +6434,9 @@
</para>
<para>
- This option suppresses the <literal>CREATE DATABASE
- /*!32312 IF NOT EXISTS*/ db_name</literal> statements that
- are otherwise included in the output if the
- <option>--databases</option> or
+ This option suppresses the <literal>CREATE
+ DATABASE</literal> statements that are otherwise included
+ in the output if the <option>--databases</option> or
<option>--all-databases</option> option is given.
</para>
</listitem>
@@ -6439,8 +6459,8 @@
<para>
Do not write any row information for the table. This is
- very useful if you want to get a dump of only the
- structure for a table.
+ very useful if you want to dump only the <literal>CREATE
+ TABLE</literal> statement for the table.
</para>
</listitem>
@@ -6455,14 +6475,17 @@
--disable-keys --extended-insert --lock-tables --quick
--set-charset</option>. It should give you a fast dump
operation and produce a dump file that can be reloaded
- into a MySQL server quickly. <emphasis>This option is on
- by default, but can be disabled with
- <option>--skip-opt</option></emphasis>. To disable only
- certain of the options enabled by <option>--opt</option>,
- use their <option>--skip</option> forms; for example,
- <option>--skip-add-drop-table</option> or
- <option>--skip-quick</option>.
+ into a MySQL server quickly.
</para>
+
+ <para>
+ <emphasis>This option is enabled by default, but can be
+ disabled with <option>--skip-opt</option></emphasis>. To
+ disable only certain of the options enabled by
+ <option>--opt</option>, use their <option>--skip</option>
+ forms; for example, <option>--skip-add-drop-table</option>
+ or <option>--skip-quick</option>.
+ </para>
</listitem>
<listitem>
@@ -6533,9 +6556,9 @@
‘<literal>`</literal>’ characters. If the
<literal>ANSI_QUOTES</literal> SQL mode is enabled, names
are quoted within ‘<literal>"</literal>’
- characters. It is on by default. It can be disabled with
- <option>--skip-quote-names</option>, but this option
- should be given after any option such as
+ characters. This option is enabled by default. It can be
+ disabled with <option>--skip-quote-names</option>, but
+ this option should be given after any option such as
<option>--compatible</option> that may enable
<option>--quote-names</option>.
</para>
@@ -6547,9 +6570,9 @@
</para>
<para>
- Uses <literal>REPLACE INTO</literal>, rather than
- <literal>INSERT INTO</literal>, when writing the dumpfile.
- Available as of MySQL 5.1.3.
+ Write <literal>REPLACE</literal> statements rather than
+ <literal>INSERT</literal> statements. Available as of
+ MySQL 5.1.3.
</para>
</listitem>
@@ -6561,7 +6584,7 @@
<para>
Direct output to a given file. This option should be used
- on Windows, because it prevents newline
+ on Windows to prevent newline
‘<literal>\n</literal>’ characters from being
converted to ‘<literal>\r\n</literal>’
carriage return/newline sequences.
@@ -6574,7 +6597,7 @@
</para>
<para>
- Dump stored routines (functions and procedures) in the
+ Dump stored routines (functions and procedures) from the
dumped databases. The output generated by using
<option>---routines</option> contains <literal>CREATE
PROCEDURE</literal> and <literal>CREATE FUNCTION</literal>
@@ -6721,8 +6744,8 @@
<para>
Override the <option>--databases</option> or
- <option>-B</option> option. All arguments following the
- option are regarded as table names.
+ <option>-B</option> option. All name arguments following
+ the option are regarded as table names.
</para>
</listitem>
@@ -6732,8 +6755,9 @@
</para>
<para>
- Dump triggers for each dumped table. This option is on by
- default; disable it with <option>--skip-triggers</option>.
+ Dump triggers for each dumped table. This option is
+ enabled by default; disable it with
+ <option>--skip-triggers</option>.
</para>
</listitem>
@@ -6746,14 +6770,14 @@
Add <literal>SET TIME_ZONE='+00:00'</literal> to the dump
file so that <literal>TIMESTAMP</literal> columns can be
dumped and reloaded between servers in different time
- zones. (Without this option, <literal>TIMESTAMP</literal>
- columns are dumped and reloaded in the local time zones of
- the source and destination servers.)
- <option>--tz-utc</option> also protects against changes
- due to daylight saving time. <option>--tz-utc</option> is
- enabled by default. To disable it, use
- <option>--skip-tz-utc</option>. This option was added in
- MySQL 5.1.2.
+ zones. Without this option, <literal>TIMESTAMP</literal>
+ columns are dumped and reloaded in the time zones local to
+ the source and destination servers, which can cause the
+ values to change. <option>--tz-utc</option> also protects
+ against changes due to daylight saving time.
+ <option>--tz-utc</option> is enabled by default. To
+ disable it, use <option>--skip-tz-utc</option>. This
+ option was added in MySQL 5.1.2.
</para>
</listitem>
@@ -6791,16 +6815,16 @@
<listitem>
<para>
- <option>--where='<replaceable>where-condition</replaceable>'</option>,
+ <option>--where='<replaceable>where_condition</replaceable>'</option>,
<option>-w
- '<replaceable>where-condition</replaceable>'</option>
+ '<replaceable>where_condition</replaceable>'</option>
</para>
<para>
- Dump only records selected by the given
+ Dump only rows selected by the given
<literal>WHERE</literal> condition. Note that quotes
around the condition are mandatory if it contains spaces
- or characters that are special to your command
+ or other characters that are special to your command
interpreter.
</para>
@@ -6809,9 +6833,9 @@
</para>
<programlisting>
-"--where=user='jimf'"
-"-wuserid>1"
-"-wuserid<1"
+--where="user='jimf'"
+-w"userid>1"
+-w"userid<1"
</programlisting>
</listitem>
@@ -6918,7 +6942,7 @@
</programlisting>
<para>
- If you want to dump all databases, use the
+ To dump all databases, use the
<option>--all-databases</option> option:
</para>
@@ -6927,20 +6951,9 @@
</programlisting>
<para>
- If tables are stored in the <literal>InnoDB</literal> storage
- engine, <literal>mysqldump</literal> provides a way of making
- an online backup of these (see command below). This backup
- just needs to acquire a global read lock on all tables (using
- <literal>FLUSH TABLES WITH READ LOCK</literal>) at the
- beginning of the dump. As soon as this lock has been acquired,
- the binary log coordinates are read and lock is released. So
- if and only if one long updating statement is running when the
- <literal>FLUSH …</literal> is issued, the MySQL server
- may get stalled until that long statement finishes, and then
- the dump becomes lock-free. So if the MySQL server receives
- only short (in the sense of <quote>short execution
- time</quote>) updating statements, even if there are plenty of
- them, the initial lock period should not be noticeable.
+ For <literal>InnoDB</literal> tables,
+ <literal>mysqldump</literal> provides a way of making an
+ online backup:
</para>
<programlisting>
@@ -6948,9 +6961,23 @@
</programlisting>
<para>
+ This backup just needs to acquire a global read lock on all
+ tables (using <literal>FLUSH TABLES WITH READ LOCK</literal>)
+ at the beginning of the dump. As soon as this lock has been
+ acquired, the binary log coordinates are read and the lock is
+ released. If and only if one long updating statement is
+ running when the <literal>FLUSH</literal> statement is issued,
+ the MySQL server may get stalled until that long statement
+ finishes, and then the dump becomes lock-free. If the update
+ statements that the MySQL server receives are short (in terms
+ of execution time), the initial lock period should not be
+ noticeable, even with many updates.
+ </para>
+
+ <para>
For point-in-time recovery (also known as
<quote>roll-forward,</quote> when you need to restore an old
- backup and replay the changes which happened since that
+ backup and replay the changes that happened since that
backup), it is often useful to rotate the binary log (see
<xref linkend="binary-log"/>) or at least know the binary log
coordinates to which the dump corresponds:
@@ -6958,11 +6985,18 @@
<programlisting>
shell> <userinput>mysqldump --all-databases --master-data=2 > all_databases.sql</userinput>
-or
-shell> <userinput>mysqldump --all-databases --flush-logs --master-data=2 > all_databases.sql</userinput>
</programlisting>
<para>
+ Or:
+ </para>
+
+<programlisting>
+shell> <userinput>mysqldump --all-databases --flush-logs --master-data=2</userinput>
+ <userinput>> all_databases.sql</userinput>
+</programlisting>
+
+ <para>
The simultaneous use of <option>--master-data</option> and
<option>--single-transaction</option> provides a convenient
way to make an online backup suitable for point-in-time
@@ -6972,7 +7006,7 @@
<para>
For more information on making backups, see
- <xref linkend="backup"/>.
+ <xref linkend="backup"/>, and <xref linkend="backup-policy"/>.
</para>
</refsection>
@@ -7047,12 +7081,12 @@
originally written and contributed by Tim Bunce. It uses
<literal>LOCK TABLES</literal>, <literal>FLUSH
TABLES</literal>, and <literal>cp</literal> or
- <literal>scp</literal> to make a backup of a database quickly.
- It is the fastest way to make a backup of the database or
- single tables, but it can be run only on the same machine
- where the database directories are located.
+ <literal>scp</literal> to make a database backup quickly. It
+ is the fastest way to make a backup of the database or single
+ tables, but it can be run only on the same machine where the
+ database directories are located.
<command>mysqlhotcopy</command> works only for backing up
- <literal>MyISAM</literal>. It runs on Unix and NetWare.
+ <literal>MyISAM</literal> tables. It runs on Unix and NetWare.
</para>
<remark role="todo">
@@ -7109,8 +7143,8 @@
</para>
<para>
- Do not abort if target exists (rename it by adding an
- <literal>_old</literal> suffix).
+ Do not abort if a target exists; rename it by adding an
+ <literal>_old</literal> suffix.
</para>
</listitem>
@@ -7171,7 +7205,7 @@
</para>
<para>
- Method for copy (<literal>cp</literal> or
+ The method for copying files (<literal>cp</literal> or
<literal>scp</literal>).
</para>
</listitem>
@@ -7183,8 +7217,9 @@
<para>
Do not include full index files in the backup. This makes
- the backup smaller and faster. The indexes can be
- reconstructed later with <command>myisamchk -rq</command>.
+ the backup smaller and faster. The indexes for reloaded
+ tables can be reconstructed later with <command>myisamchk
+ -rq</command>.
</para>
</listitem>
@@ -7236,7 +7271,7 @@
</para>
<para>
- Copy all databases with names matching the given regular
+ Copy all databases with names that match the given regular
expression.
</para>
</listitem>
@@ -7268,8 +7303,8 @@
</para>
<para>
- The temporary directory (instead of
- <filename>/tmp</filename>).
+ The temporary directory. The default is
+ <filename>/tmp</filename>.
</para>
</listitem>
@@ -7303,7 +7338,9 @@
<para>
Use <literal>perldoc</literal> for additional
- <command>mysqlhotcopy</command> documentation:
+ <command>mysqlhotcopy</command> documentation, including
+ information about the structure of the table needed for the
+ <option>--checkpoint</option> option.
</para>
<programlisting>
@@ -7377,7 +7414,7 @@
command-line interface to the <literal>LOAD DATA
INFILE</literal> SQL statement. Most options to
<command>mysqlimport</command> correspond directly to clauses
- of <literal>LOAD DATA INFILE</literal>. See
+ of <literal>LOAD DATA INFILE</literal> syntax. See
<xref linkend="load-data"/>.
</para>
@@ -7519,11 +7556,11 @@
<listitem>
<para>
- <option>--ignore-lines=<replaceable>n</replaceable></option>
+ <option>--ignore-lines=<replaceable>N</replaceable></option>
</para>
<para>
- Ignore the first <replaceable>n</replaceable> lines of the
+ Ignore the first <replaceable>N</replaceable> lines of the
data file.
</para>
</listitem>
@@ -7602,8 +7639,8 @@
<para>
The <option>--replace</option> and
<option>--ignore</option> options control handling of
- input records that duplicate existing records on unique
- key values. If you specify <option>--replace</option>, new
+ input rows that duplicate existing rows on unique key
+ values. If you specify <option>--replace</option>, new
rows replace existing rows that have the same unique key
value. If you specify <option>--ignore</option>, input
rows that duplicate an existing row on a unique key value
@@ -7769,17 +7806,16 @@
<para>
The <command>mysqlshow</command> client can be used to quickly
- look at which databases exist, their tables, and a table's
- columns or indexes.
+ see which databases exist, their tables, or a table's columns
+ or indexes.
</para>
<para>
<command>mysqlshow</command> provides a command-line interface
- to several SQL <literal>SHOW</literal> statements. The same
- information can be obtained by using those statements
- directly. For example, you can issue them from the
- <command>mysql</command> client program. See
- <xref linkend="show"/>.
+ to several SQL <literal>SHOW</literal> statements. See
+ <xref linkend="show"/>. The same information can be obtained
+ by using those statements directly. For example, you can issue
+ them from the <command>mysql</command> client program.
</para>
<para>
@@ -7794,7 +7830,8 @@
<listitem>
<para>
- If no database is given, all matching databases are shown.
+ If no database is given, a list of database names is
+ shown.
</para>
</listitem>
@@ -7815,9 +7852,8 @@
</itemizedlist>
<para>
- Note that in newer MySQL versions, you see only those
- database, tables, or columns for which you have some
- privileges.
+ The output displays only the names of those databases, tables,
+ or columns for which you have some privileges.
</para>
<para>
@@ -8087,10 +8123,11 @@
<title>Description</title>
<para>
- <command>mysqlslap</command> is designed to emulate client
- load for a MySQL server and report the timing of each stage.
- It works as if multiple clients are accessing the server.
- <command>mysqlslap</command> is available as of MySQL 5.1.4.
+ <command>mysqlslap</command> is a diagnostic program designed
+ to emulate client load for a MySQL server and to report the
+ timing of each stage. It works as if multiple clients are
+ accessing the server. <command>mysqlslap</command> is
+ available as of MySQL 5.1.4.
</para>
<remark role="todo">
@@ -8128,7 +8165,7 @@
<para>
Generate SQL statements automatically when they are not
- supplied in files or command options.
+ supplied in files or via command options.
</para>
</listitem>
@@ -8149,8 +8186,8 @@
</para>
<para>
- The number of clients to simulate when issuing the select
- query.
+ The number of clients to simulate when issuing the
+ <literal>SELECT</literal> statement.
</para>
</listitem>
@@ -8208,8 +8245,8 @@
</para>
<para>
- Delimiter to use in SQL statements supplied in files or by
- command options.
+ The delimiter to use in SQL statements supplied in files
+ or via command options.
</para>
</listitem>
@@ -8237,12 +8274,12 @@
<listitem>
<para>
- <option>--iterations=<replaceable>num</replaceable></option>,
- <option>-i <replaceable>num</replaceable></option>
+ <option>--iterations=<replaceable>N</replaceable></option>,
+ <option>-i <replaceable>N</replaceable></option>
</para>
<para>
- The number of iterations.
+ The number of times to run the tests.
</para>
</listitem>
@@ -8259,8 +8296,8 @@
<listitem>
<para>
- <option>--number-char-cols=<replaceable>num</replaceable></option>,
- <option>-x <replaceable>num</replaceable></option>
+ <option>--number-char-cols=<replaceable>N</replaceable></option>,
+ <option>-x <replaceable>N</replaceable></option>
</para>
<para>
@@ -8271,8 +8308,8 @@
<listitem>
<para>
- <option>--number-int-cols=<replaceable>num</replaceable></option>,
- <option>-y <replaceable>num</replaceable></option>
+ <option>--number-int-cols=<replaceable>N</replaceable></option>,
+ <option>-y <replaceable>N</replaceable></option>
</para>
<para>
@@ -8283,7 +8320,7 @@
<listitem>
<para>
- <option>--number-of-queries=<replaceable>num</replaceable></option>
+ <option>--number-of-queries=<replaceable>N</replaceable></option>
</para>
<para>
Modified: trunk/refman-5.1/functions.xml
===================================================================
--- trunk/refman-5.1/functions.xml 2006-01-20 23:46:33 UTC (rev 957)
+++ trunk/refman-5.1/functions.xml 2006-01-20 23:51:00 UTC (rev 958)
@@ -13279,8 +13279,9 @@
Returns the <emphasis>first</emphasis> automatically
generated value that was set for an
<literal>AUTO_INCREMENT</literal> column by the
- <emphasis>last</emphasis> <literal>INSERT</literal> or
- <literal>UPDATE</literal> query to affect such a column.
+ <emphasis>most recent</emphasis> <literal>INSERT</literal>
+ or <literal>UPDATE</literal> statement to affect such a
+ column.
</para>
<remark role="help-description-end"/>
@@ -13383,10 +13384,12 @@
</programlisting>
<para>
- Although the second query inserted 3 new rows into
- <literal>t</literal>, the ID generated for the first of
- these rows was <literal>2</literal>, and it is this value
- that is returned by <literal>LAST_INSERT_ID()</literal>.
+ Although the second <literal>INSERT</literal> statement
+ inserted 3 new rows into <literal>t</literal>, the ID
+ generated for the first of these rows was
+ <literal>2</literal>, and it is this value that is returned
+ by <literal>LAST_INSERT_ID()</literal> for the following
+ <literal>SELECT</literal> statement.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r958 - in trunk: . refman-4.1 refman-5.0 refman-5.1 | paul | 21 Jan |
