Author: paul
Date: 2006-03-23 19:07:05 +0100 (Thu, 23 Mar 2006)
New Revision: 1654
Log:
r8917@frost: paul | 2006-03-23 12:05:58 -0600
Fold in proof corrections.
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:8916
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:4044
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:8917
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:4044
Modified: trunk/refman-4.1/database-administration.xml
===================================================================
--- trunk/refman-4.1/database-administration.xml 2006-03-23 18:06:29 UTC (rev 1653)
+++ trunk/refman-4.1/database-administration.xml 2006-03-23 18:07:05 UTC (rev 1654)
@@ -953,7 +953,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--delay-key-write[= OFF | ON | ALL]</option>
+ <option>--delay-key-write[={OFF|ON|ALL}]</option>
</para>
<para>
@@ -1178,7 +1178,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--init-file=<replaceable>file</replaceable></option>
+ <option>--init-file=<replaceable>file_name</replaceable></option>
</para>
<para>
@@ -1283,7 +1283,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--log-bin=[<replaceable>base_name</replaceable>]</option>
+ <option>--log-bin[=<replaceable>base_name</replaceable>]</option>
</para>
<para>
@@ -1549,7 +1549,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--log-warnings=[<replaceable>level</replaceable>]</option>,
+ <option>--log-warnings[=<replaceable>level</replaceable>]</option>,
<option>-W [<replaceable>level</replaceable>]</option>
</para>
@@ -2142,6 +2142,7 @@
Turn off the ability to select and insert at the same time
on <literal>MyISAM</literal> tables. (This is to be used
only if you think you have found a bug in this feature.)
+ See <xref linkend="concurrent-inserts"/>.
</para>
</listitem>
@@ -2772,10 +2773,9 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--user={<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>, <option>-u
- {<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>
+ <option>--user={<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>,
+ <option>-u
+ {<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>
</para>
<para>
@@ -2861,7 +2861,7 @@
If you want to restrict the maximum value to which a variable
can be set at runtime with <literal>SET</literal>, you can
define this by using the
- <option>--maximum-<replaceable>var_name</replaceable></option>
+ <option>--maximum-<replaceable>var_name</replaceable>=<replaceable>value</replaceable></option>
command-line option.
</para>
@@ -3651,9 +3651,9 @@
</para>
<para>
- The default variable value is <literal>'+
- -><()~*:""&|'</literal>. The rules for changing
- the value are as follows:
+ The default variable value is
+ <literal>'+ -><()~*:""&|'</literal>. The
+ rules for changing the value are as follows:
</para>
<itemizedlist>
@@ -3948,7 +3948,7 @@
<para>
<literal>YES</literal> if <command>mysqld</command>
- supports SSL (encryption) of the client/server protocol,
+ supports SSL (encryption) connections,
<literal>NO</literal> if not. This variable was added in
MySQL 3.23.43.
</para>
@@ -4409,9 +4409,9 @@
<para>
Whether updates received by a slave server from a master
server should be logged to the slave's own binary log.
- Binary logging must be enabled on the slave for this to
- have any effect. This variable was added in MySQL 3.23.17.
- See <xref linkend="replication-options"/>.
+ Binary logging must be enabled on the slave for this
+ variable to have any effect. This variable was added in
+ MySQL 3.23.17. See <xref linkend="replication-options"/>.
</para>
</listitem>
@@ -4471,7 +4471,7 @@
in real time, not CPU time, so a query that is under the
threshold on a lightly loaded system might be above the
threshold on a heavily loaded one. The minimum value is 1.
- See <xref linkend="slow-query-log"/>.
+ The default is 10. See <xref linkend="slow-query-log"/>.
</para>
</listitem>
@@ -4562,7 +4562,7 @@
<para>
You must increase this value if you are using large
<literal>BLOB</literal> columns or long strings. It should
- be as big as the biggest <literal>BLOB</literal> you want
+ be as big as the largest <literal>BLOB</literal> you want
to use. The protocol limit for
<literal>max_allowed_packet</literal> is 16MB before MySQL
4.0 and 1GB thereafter.
@@ -4897,13 +4897,14 @@
</para>
<para>
- The maximum size of the temporary file MySQL is allowed to
- use while re-creating a <literal>MyISAM</literal> index
- (during <literal>REPAIR TABLE</literal>, <literal>ALTER
- TABLE</literal>, or <literal>LOAD DATA INFILE</literal>).
- If the file size would be larger than this value, the
- index is created using the key cache instead, which is
- slower. This variable was added in MySQL 3.23.37.
+ The maximum size of the temporary file that MySQL is
+ allowed to use while re-creating a
+ <literal>MyISAM</literal> index (during <literal>REPAIR
+ TABLE</literal>, <literal>ALTER TABLE</literal>, or
+ <literal>LOAD DATA INFILE</literal>). If the file size
+ would be larger than this value, the index is created
+ using the key cache instead, which is slower. This
+ variable was added in MySQL 3.23.37.
<emphasis role="bold">Note</emphasis>: The value is given
in megabytes before 4.0.3 and in bytes thereafter.
</para>
@@ -4931,6 +4932,9 @@
table indexes are created in parallel (each index in its
own thread) during the <literal>Repair by
sorting</literal> process. The default value is 1.
+ </para>
+
+ <para>
<emphasis role="bold">Note</emphasis>: Multi-threaded
repair is still <emphasis>beta-quality</emphasis> code.
This variable was added in MySQL 4.0.13.
@@ -5209,9 +5213,10 @@
<para>
The amount of memory allocated for caching query results.
The default value is <literal>0</literal>, which disables
- the query cache. Note that this amount of memory is
- allocated even if <literal>query_cache_type</literal> is
- set to <literal>0</literal>. This variable was added in
+ the query cache. Note that
+ <literal>query_cache_size</literal> bytes of memory are
+ allocated even if if <literal>query_cache_type</literal>
+ is set to <literal>0</literal>. This variable was added in
MySQL 4.0.1.
</para>
</listitem>
@@ -5240,8 +5245,9 @@
</row>
<row>
<entry><literal>0</literal> or <literal>OFF</literal></entry>
- <entry>do not cache or retrieve results. Note that this does not deallocate the
- query cache buffer. To do that, you should set
+ <entry>Don't cache results in or retrieve results from the query cache. Note
+ that this does not deallocate the query cache
+ buffer. To do that, you should set
<literal>query_cache_size</literal> to
<literal>0</literal>.</entry>
</row>
@@ -5991,7 +5997,7 @@
The <literal>system_time_zone</literal> variable differs
from <literal>time_zone</literal>. Although they might
have the same value, the latter variable is used to
- initialize the tome zone for each client that connects.
+ initialize the time zone for each client that connects.
See <xref linkend="time-zone-support"/>.
</para>
</listitem>
@@ -6230,7 +6236,7 @@
variable can be set at runtime with the <literal>SET</literal>
statement, you can specify this maximum by using an option of
the form
- <option>--maximum-<replaceable>var_name</replaceable></option>
+ <option>--maximum-<replaceable>var_name</replaceable>=<replaceable>value</replaceable></option>
at server startup. For example, to prevent the value of
<literal>query_cache_size</literal> from being increased to
more than 32MB at runtime, use the option
@@ -8235,7 +8241,7 @@
</para>
<para>
- The status of failsafe replication (not yet implemented).
+ The status of fail-safe replication (not yet implemented).
</para>
</listitem>
@@ -8598,7 +8604,7 @@
‘<literal>`</literal>’ to quote identifiers
with this mode enabled. With
<literal>ANSI_QUOTES</literal> enabled, you cannot use
- double quotes to quote a literal string, because it is
+ double quotes to quote literal strings, because it is
interpreted as an identifier. (New in MySQL 4.0.0)
</para>
</listitem>
@@ -9628,9 +9634,9 @@
<emphasis role="bold">Note</emphasis>: Before MySQL 4.0,
<command>mysqld_safe</command> is named
<command>safe_mysqld</command>. To preserve backward
- compatibility, MySQL binary distributions for some time will
- include <command>safe_mysqld</command> as a symbolic link to
- <command>mysqld_safe</command>.
+ compatibility, MySQL binary distributions include
+ <command>safe_mysqld</command> as a symbolic link to
+ <command>mysqld_safe</command> until MySQL 5.1.
</para>
<para>
@@ -10133,8 +10139,7 @@
<secondary>mysqld_safe</secondary>
</indexterm>
- <option>--user={<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>
+ <option>--user={<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>
</para>
<para>
@@ -10588,7 +10593,7 @@
<secondary>mysqld_multi</secondary>
</indexterm>
- <option>--config-file=<replaceable>name</replaceable></option>
+ <option>--config-file=<replaceable>file_name</replaceable></option>
</para>
<para>
@@ -22400,13 +22405,16 @@
</para>
<para>
- Before MySQL 4.1, if you also use <option>--log-long-format</option> when logging slow queries,
- queries that are not using indexes are logged as well. Starting with MySQL 4.1
- logging of queries not using indexes is enabled using the
- <option>--log-queries-not-using-indexes</option> option instead. The <option>--log-long-format</option> is deprecated
- as of MySQL 4.1, when <option>--log-short-format</option> was introduced. (The long log format
- is the default setting since version 4.1.).
- See <xref linkend="server-options"/>.
+ Before MySQL 4.1, if you also use
+ <option>--log-long-format</option> when logging slow queries,
+ queries that are not using indexes are logged as well. Starting
+ with MySQL 4.1 logging of queries not using indexes is enabled
+ using the <option>--log-queries-not-using-indexes</option>
+ option instead. The <option>--log-long-format</option> is
+ deprecated as of MySQL 4.1, when
+ <option>--log-short-format</option> was introduced. (The long
+ log format is the default setting since version 4.1.). See
+ <xref linkend="server-options"/>.
</para>
<para>
Modified: trunk/refman-5.0/database-administration.xml
===================================================================
--- trunk/refman-5.0/database-administration.xml 2006-03-23 18:06:29 UTC (rev 1653)
+++ trunk/refman-5.0/database-administration.xml 2006-03-23 18:07:05 UTC (rev 1654)
@@ -182,8 +182,7 @@
systems) or 5.0.13 (Windows), an alternative to
<command>mysqld_multi</command> is
<literal>mysqlmanager</literal>, the MySQL Instance Manager.
- instead of <literal>mysqld_multi</literal>. See
- <xref linkend="instance-manager"/>.
+ See <xref linkend="instance-manager"/>.
</para>
</listitem>
@@ -425,8 +424,9 @@
<para>
<command>mysqld</command> accepts many command options. For a
- brief list, execute <command>mysqld --help</command>. To see
- the full list, use <command>mysqld --verbose --help</command>.
+ brief summary, execute <command>mysqld --help</command>. To
+ see the full list, use <command>mysqld --verbose
+ --help</command>.
</para>
<para>
@@ -1005,7 +1005,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--delay-key-write[= OFF | ON | ALL]</option>
+ <option>--delay-key-write[={OFF|ON|ALL}]</option>
</para>
<para>
@@ -1207,7 +1207,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--init-file=<replaceable>file</replaceable></option>
+ <option>--init-file=<replaceable>file_name</replaceable></option>
</para>
<para>
@@ -1359,7 +1359,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--log-bin=[<replaceable>base_name</replaceable>]</option>
+ <option>--log-bin[=<replaceable>base_name</replaceable>]</option>
</para>
<para>
@@ -1646,7 +1646,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--log-warnings=[<replaceable>level</replaceable>]</option>,
+ <option>--log-warnings[=<replaceable>level</replaceable>]</option>,
<option>-W [<replaceable>level</replaceable>]</option>
</para>
@@ -2188,6 +2188,7 @@
Turn off the ability to select and insert at the same time
on <literal>MyISAM</literal> tables. (This is to be used
only if you think you have found a bug in this feature.)
+ See <xref linkend="concurrent-inserts"/>.
</para>
</listitem>
@@ -2722,10 +2723,9 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--user={<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>, <option>-u
- {<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>
+ <option>--user={<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>,
+ <option>-u
+ {<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>
</para>
<para>
@@ -2810,7 +2810,7 @@
If you want to restrict the maximum value to which a variable
can be set at runtime with <literal>SET</literal>, you can
define this by using the
- <option>--maximum-<replaceable>var_name</replaceable></option>
+ <option>--maximum-<replaceable>var_name</replaceable>=<replaceable>value</replaceable></option>
command-line option.
</para>
@@ -3016,7 +3016,7 @@
</para>
<para>
- These two variables effect
+ These two variables affect
<literal>AUTO_INCREMENT</literal> column behavior as
follows:
</para>
@@ -3221,15 +3221,15 @@
sequences offered by some other database management
systems; these variables control the behavior of all
<literal>AUTO_INCREMENT</literal> columns in
- <emphasis role="bold">all</emphasis> tables on the MySQL
- server. If one of these variables is set globally, its
- effects persist until the global value is changed or
- overridden by setting them locally, or until
- <command>mysqld</command> is restarted. If set locally,
- the new value affects <literal>AUTO_INCREMENT</literal>
- columns for all tables into which new rows are inserted by
- the current user for the duration of the session, unless
- the values are changed during that session.
+ <emphasis>all</emphasis> tables on the MySQL server. If
+ one of these variables is set globally, its effects
+ persist until the global value is changed or overridden by
+ setting them locally, or until <command>mysqld</command>
+ is restarted. If set locally, the new value affects
+ <literal>AUTO_INCREMENT</literal> columns for all tables
+ into which new rows are inserted by the current user for
+ the duration of the session, unless the values are changed
+ during that session.
</para>
<para>
@@ -3656,8 +3656,8 @@
<entry>Enables concurrent inserts for all <literal>MyISAM</literal> tables. If
table has a hole and is in use by another thread
the new row will be inserted at end of table. If
- table is not in use then MySQL does a normal read
- lock and inserts the new row into the hole.</entry>
+ table is not in use, MySQL does a normal read lock
+ and inserts the new row into the hole.</entry>
</row>
</tbody>
</tgroup>
@@ -3950,9 +3950,9 @@
</para>
<para>
- The default variable value is <literal>'+
- -><()~*:""&|'</literal>. The rules for changing
- the value are as follows:
+ The default variable value is
+ <literal>'+ -><()~*:""&|'</literal>. The
+ rules for changing the value are as follows:
</para>
<itemizedlist>
@@ -4244,8 +4244,7 @@
<para>
<literal>YES</literal> if <command>mysqld</command>
- supports SSL (encryption) of the client/server protocol,
- <literal>NO</literal> if not.
+ supports SSL connections, <literal>NO</literal> if not.
</para>
</listitem>
@@ -4710,8 +4709,8 @@
<para>
Whether updates received by a slave server from a master
server should be logged to the slave's own binary log.
- Binary logging must be enabled on the slave for this to
- have any effect. See
+ Binary logging must be enabled on the slave for this
+ variable to have any effect. See
<xref linkend="replication-options"/>.
</para>
</listitem>
@@ -4755,7 +4754,7 @@
in real time, not CPU time, so a query that is under the
threshold on a lightly loaded system might be above the
threshold on a heavily loaded one. The minimum value is 1.
- See <xref linkend="slow-query-log"/>.
+ The default is 10. See <xref linkend="slow-query-log"/>.
</para>
</listitem>
@@ -4841,7 +4840,7 @@
<para>
You must increase this value if you are using large
<literal>BLOB</literal> columns or long strings. It should
- be as big as the biggest <literal>BLOB</literal> you want
+ be as big as the largest <literal>BLOB</literal> you want
to use. The protocol limit for
<literal>max_allowed_packet</literal> is 1GB.
</para>
@@ -5172,13 +5171,14 @@
</para>
<para>
- The maximum size of the temporary file MySQL is allowed to
- use while re-creating a <literal>MyISAM</literal> index
- (during <literal>REPAIR TABLE</literal>, <literal>ALTER
- TABLE</literal>, or <literal>LOAD DATA INFILE</literal>).
- If the file size would be larger than this value, the
- index is created using the key cache instead, which is
- slower. The value is given in bytes.
+ The maximum size of the temporary file that MySQL is
+ allowed to use while re-creating a
+ <literal>MyISAM</literal> index (during <literal>REPAIR
+ TABLE</literal>, <literal>ALTER TABLE</literal>, or
+ <literal>LOAD DATA INFILE</literal>). If the file size
+ would be larger than this value, the index is created
+ using the key cache instead, which is slower. The value is
+ given in bytes.
</para>
</listitem>
@@ -5203,6 +5203,9 @@
table indexes are created in parallel (each index in its
own thread) during the <literal>Repair by
sorting</literal> process. The default value is 1.
+ </para>
+
+ <para>
<emphasis role="bold">Note</emphasis>: Multi-threaded
repair is still <emphasis>beta-quality</emphasis> code.
</para>
@@ -5532,7 +5535,8 @@
<para>
The amount of memory allocated for caching query results.
The default value is 0, which disables the query cache.
- Note that this amount of memory is allocated even if
+ Note that <literal>query_cache_size</literal> bytes of
+ memory are allocated even if
<literal>query_cache_type</literal> is set to 0. See
<xref linkend="query-cache-configuration"/>, for more
information.
@@ -5564,8 +5568,9 @@
</row>
<row>
<entry><literal>0</literal> or <literal>OFF</literal></entry>
- <entry>Don't cache or retrieve results. Note that this does not deallocate the
- query cache buffer. To do that, you should set
+ <entry>Don't cache results in or retrieve results from the query cache. Note
+ that this does not deallocate the query cache
+ buffer. To do that, you should set
<literal>query_cache_size</literal> to 0.</entry>
</row>
<row>
@@ -6042,7 +6047,7 @@
The <literal>system_time_zone</literal> variable differs
from <literal>time_zone</literal>. Although they might
have the same value, the latter variable is used to
- initialize the tome zone for each client that connects.
+ initialize the time zone for each client that connects.
See <xref linkend="time-zone-support"/>.
</para>
</listitem>
@@ -6060,7 +6065,7 @@
<literal>Opened_tables</literal> status variable. See
<xref linkend="server-status-variables"/>. If the value of
<literal>Opened_tables</literal> is large and you don't do
- <literal>FLUSH TABLES</literal> a lot (which just forces
+ <literal>FLUSH TABLES</literal> often (which just forces
all tables to be closed and reopened), then you should
increase the value of the <literal>table_cache</literal>
variable. For more information about the table cache, see
@@ -6503,7 +6508,7 @@
variable can be set at runtime with the <literal>SET</literal>
statement, you can specify this maximum by using an option of
the form
- <option>--maximum-<replaceable>var_name</replaceable></option>
+ <option>--maximum-<replaceable>var_name</replaceable>=<replaceable>value</replaceable></option>
at server startup. For example, to prevent the value of
<literal>query_cache_size</literal> from being increased to
more than 32MB at runtime, use the option
@@ -7961,6 +7966,16 @@
</para>
<para>
+ All of the
+ <literal>Com_stmt_<replaceable>xxx</replaceable></literal>
+ variables are increased even if a prepared statement
+ argument is unknown or an error occurred during execution.
+ In other words, their values correspond to the number of
+ requests issued, not to the number of requests
+ successfully completed.
+ </para>
+
+ <para>
The
<literal>Com_stmt_<replaceable>xxx</replaceable></literal>
status variables were added in 5.0.8:
@@ -8030,16 +8045,6 @@
number of network round-trips issued when fetching from
cursors.
</para>
-
- <para>
- All of the
- <literal>Com_stmt_<replaceable>xxx</replaceable></literal>
- variables are increased even if a prepared statement
- argument is unknown or an error occurred during execution.
- In other words, their values correspond to the number of
- requests issued, not to the number of requests
- successfully completed.
- </para>
</listitem>
<listitem>
@@ -9055,7 +9060,7 @@
</para>
<para>
- The status of failsafe replication (not yet implemented).
+ The status of fail-safe replication (not yet implemented).
</para>
</listitem>
@@ -9510,7 +9515,7 @@
‘<literal>`</literal>’ to quote identifiers
with this mode enabled. With
<literal>ANSI_QUOTES</literal> enabled, you cannot use
- double quotes to quote a literal string, because it is
+ double quotes to quote literal strings, because it is
interpreted as an identifier.
</para>
</listitem>
@@ -9526,15 +9531,15 @@
<para>
Produce an error in strict mode (otherwise a warning) when
- we encounter a division by zero (or
- <literal>MOD(X,0)</literal>) during an
- <literal>INSERT</literal> or <literal>UPDATE</literal>. If
- this mode is not enabled, MySQL instead returns
- <literal>NULL</literal> for divisions by zero. If used in
- <literal>INSERT IGNORE</literal> or <literal>UPDATE
- IGNORE</literal>, MySQL generates a warning for divisions
- by zero, but the result of the operation is
- <literal>NULL</literal>. (Implemented in MySQL 5.0.2)
+ a division by zero (or <literal>MOD(X,0)</literal>) occurs
+ during an <literal>INSERT</literal> or
+ <literal>UPDATE</literal>. If this mode is not enabled,
+ MySQL instead returns <literal>NULL</literal> for
+ divisions by zero. For <literal>INSERT IGNORE</literal> or
+ <literal>UPDATE IGNORE</literal>, MySQL generates a
+ warning for divisions by zero, but the result of the
+ operation is <literal>NULL</literal>. (Implemented in
+ MySQL 5.0.2)
</para>
</listitem>
@@ -10775,8 +10780,8 @@
compatibility with older versions of MySQL, MySQL binary
distributions still include <command>safe_mysqld</command>
as a symbolic link to <command>mysqld_safe</command>.
- However, you should not rely on this as it almost certainly
- will be removed in the future.
+ However, you should not rely on this because it is removed
+ as of MySQL 5.1.
</para>
<para>
@@ -11287,8 +11292,7 @@
<secondary>mysqld_safe</secondary>
</indexterm>
- <option>--user={<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>
+ <option>--user={<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>
</para>
<para>
@@ -11743,7 +11747,7 @@
<secondary>mysqld_multi</secondary>
</indexterm>
- <option>--config-file=<replaceable>name</replaceable></option>
+ <option>--config-file=<replaceable>file_name</replaceable></option>
</para>
<para>
@@ -12785,9 +12789,9 @@
<para>
Daemonize and start the angel process (for UNIX-like
- systems). The angel process
- is simple and unlikely to crash. It will restart the
- Instance Manager itself in case of a failure.
+ systems). The angel process is simple and unlikely to
+ crash. It will restart the Instance Manager itself in case
+ of a failure.
</para>
</listitem>
@@ -12852,8 +12856,8 @@
<para>
Username to start and run the
<command>mysqlmanager</command> under (for UNIX-like
- systems). It is recommended
- to run <command>mysqlmanager</command> under the same user
+ systems). It is recommended to run
+ <command>mysqlmanager</command> under the same user
account used to run the <command>mysqld</command> server.
(<quote>User</quote> in this context refers to a system
login account, not a MySQL user listed in the grant
Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml 2006-03-23 18:06:29 UTC (rev 1653)
+++ trunk/refman-5.1/database-administration.xml 2006-03-23 18:07:05 UTC (rev 1654)
@@ -165,8 +165,7 @@
<xref linkend="mysqld-multi"/>. An alternative to
<command>mysqld_multi</command> is
<literal>mysqlmanager</literal>, the MySQL Instance Manager.
- instead of <literal>mysqld_multi</literal>. See
- <xref linkend="instance-manager"/>.
+ See <xref linkend="instance-manager"/>.
</para>
</listitem>
@@ -613,8 +612,9 @@
<para>
<command>mysqld</command> accepts many command options. For a
- brief list, execute <command>mysqld --help</command>. To see
- the full list, use <command>mysqld --verbose --help</command>.
+ brief summary, execute <command>mysqld --help</command>. To
+ see the full list, use <command>mysqld --verbose
+ --help</command>.
</para>
<para>
@@ -1240,7 +1240,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--delay-key-write[= OFF | ON | ALL]</option>
+ <option>--delay-key-write[={OFF|ON|ALL}]</option>
</para>
<para>
@@ -1462,7 +1462,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--init-file=<replaceable>file</replaceable></option>
+ <option>--init-file=<replaceable>file_name</replaceable></option>
</para>
<para>
@@ -1594,7 +1594,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--log-bin=[<replaceable>base_name</replaceable>]</option>
+ <option>--log-bin[=<replaceable>base_name</replaceable>]</option>
</para>
<para>
@@ -1907,7 +1907,7 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--log-warnings=[<replaceable>level</replaceable>]</option>,
+ <option>--log-warnings[=<replaceable>level</replaceable>]</option>,
<option>-W [<replaceable>level</replaceable>]</option>
</para>
@@ -2449,6 +2449,7 @@
Turn off the ability to select and insert at the same time
on <literal>MyISAM</literal> tables. (This is to be used
only if you think you have found a bug in this feature.)
+ See <xref linkend="concurrent-inserts"/>.
</para>
</listitem>
@@ -2983,10 +2984,9 @@
<secondary>mysqld</secondary>
</indexterm>
- <option>--user={<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>, <option>-u
- {<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>
+ <option>--user={<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>,
+ <option>-u
+ {<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>
</para>
<para>
@@ -3071,7 +3071,7 @@
If you want to restrict the maximum value to which a variable
can be set at runtime with <literal>SET</literal>, you can
define this by using the
- <option>--maximum-<replaceable>var_name</replaceable></option>
+ <option>--maximum-<replaceable>var_name</replaceable>=<replaceable>value</replaceable></option>
command-line option.
</para>
@@ -3278,7 +3278,7 @@
</para>
<para>
- These two variables effect
+ These two variables affect
<literal>AUTO_INCREMENT</literal> column behavior as
follows:
</para>
@@ -3483,15 +3483,15 @@
sequences offered by some other database management
systems; these variables control the behavior of all
<literal>AUTO_INCREMENT</literal> columns in
- <emphasis role="bold">all</emphasis> tables on the MySQL
- server. If one of these variables is set globally, its
- effects persist until the global value is changed or
- overridden by setting them locally, or until
- <command>mysqld</command> is restarted. If set locally,
- the new value affects <literal>AUTO_INCREMENT</literal>
- columns for all tables into which new rows are inserted by
- the current user for the duration of the session, unless
- the values are changed during that session.
+ <emphasis>all</emphasis> tables on the MySQL server. If
+ one of these variables is set globally, its effects
+ persist until the global value is changed or overridden by
+ setting them locally, or until <command>mysqld</command>
+ is restarted. If set locally, the new value affects
+ <literal>AUTO_INCREMENT</literal> columns for all tables
+ into which new rows are inserted by the current user for
+ the duration of the session, unless the values are changed
+ during that session.
</para>
<para>
@@ -4011,8 +4011,8 @@
<entry>Enables concurrent inserts for all <literal>MyISAM</literal> tables. If
table has a hole and is in use by another thread
the new row will be inserted at end of table. If
- table is not in use then MySQL does a normal read
- lock and inserts the new row into the hole.</entry>
+ table is not in use, MySQL does a normal read lock
+ and inserts the new row into the hole.</entry>
</row>
</tbody>
</tgroup>
@@ -4307,9 +4307,9 @@
</para>
<para>
- The default variable value is <literal>'+
- -><()~*:""&|'</literal>. The rules for changing
- the value are as follows:
+ The default variable value is
+ <literal>'+ -><()~*:""&|'</literal>. The
+ rules for changing the value are as follows:
</para>
<itemizedlist>
@@ -4600,8 +4600,7 @@
<para>
<literal>YES</literal> if <command>mysqld</command>
- supports SSL (encryption) of the client/server protocol,
- <literal>NO</literal> if not.
+ supports SSL connections, <literal>NO</literal> if not.
</para>
</listitem>
@@ -5044,8 +5043,8 @@
<para>
Whether updates received by a slave server from a master
server should be logged to the slave's own binary log.
- Binary logging must be enabled on the slave for this to
- have any effect. See
+ Binary logging must be enabled on the slave for this
+ variable to have any effect. See
<xref linkend="replication-options"/>.
</para>
</listitem>
@@ -5089,7 +5088,7 @@
in real time, not CPU time, so a query that is under the
threshold on a lightly loaded system might be above the
threshold on a heavily loaded one. The minimum value is 1.
- See <xref linkend="slow-query-log"/>.
+ The default is 10. See <xref linkend="slow-query-log"/>.
</para>
</listitem>
@@ -5175,7 +5174,7 @@
<para>
You must increase this value if you are using large
<literal>BLOB</literal> columns or long strings. It should
- be as big as the biggest <literal>BLOB</literal> you want
+ be as big as the largest <literal>BLOB</literal> you want
to use. The protocol limit for
<literal>max_allowed_packet</literal> is 1GB.
</para>
@@ -5495,13 +5494,14 @@
</para>
<para>
- The maximum size of the temporary file MySQL is allowed to
- use while re-creating a <literal>MyISAM</literal> index
- (during <literal>REPAIR TABLE</literal>, <literal>ALTER
- TABLE</literal>, or <literal>LOAD DATA INFILE</literal>).
- If the file size would be larger than this value, the
- index is created using the key cache instead, which is
- slower. The value is given in bytes.
+ The maximum size of the temporary file that MySQL is
+ allowed to use while re-creating a
+ <literal>MyISAM</literal> index (during <literal>REPAIR
+ TABLE</literal>, <literal>ALTER TABLE</literal>, or
+ <literal>LOAD DATA INFILE</literal>). If the file size
+ would be larger than this value, the index is created
+ using the key cache instead, which is slower. The value is
+ given in bytes.
</para>
</listitem>
@@ -5526,6 +5526,9 @@
table indexes are created in parallel (each index in its
own thread) during the <literal>Repair by
sorting</literal> process. The default value is 1.
+ </para>
+
+ <para>
<emphasis role="bold">Note</emphasis>: Multi-threaded
repair is still <emphasis>beta-quality</emphasis> code.
</para>
@@ -5881,7 +5884,8 @@
<para>
The amount of memory allocated for caching query results.
The default value is 0, which disables the query cache.
- Note that this amount of memory is allocated even if
+ Note that <literal>query_cache_size</literal> bytes of
+ memory are allocated even if
<literal>query_cache_type</literal> is set to 0. See
<xref linkend="query-cache-configuration"/>, for more
information.
@@ -5913,8 +5917,9 @@
</row>
<row>
<entry><literal>0</literal> or <literal>OFF</literal></entry>
- <entry>Don't cache or retrieve results. Note that this does not deallocate the
- query cache buffer. To do that, you should set
+ <entry>Don't cache results in or retrieve results from the query cache. Note
+ that this does not deallocate the query cache
+ buffer. To do that, you should set
<literal>query_cache_size</literal> to 0.</entry>
</row>
<row>
@@ -6386,7 +6391,7 @@
The <literal>system_time_zone</literal> variable differs
from <literal>time_zone</literal>. Although they might
have the same value, the latter variable is used to
- initialize the tome zone for each client that connects.
+ initialize the time zone for each client that connects.
See <xref linkend="time-zone-support"/>.
</para>
</listitem>
@@ -6432,7 +6437,7 @@
<literal>Opened_tables</literal> status variable. See
<xref linkend="server-status-variables"/>. If the value of
<literal>Opened_tables</literal> is large and you don't do
- <literal>FLUSH TABLES</literal> a lot (which just forces
+ <literal>FLUSH TABLES</literal> often (which just forces
all tables to be closed and reopened), then you should
increase the value of the
<literal>table_open_cache</literal> variable. For more
@@ -6873,7 +6878,7 @@
variable can be set at runtime with the <literal>SET</literal>
statement, you can specify this maximum by using an option of
the form
- <option>--maximum-<replaceable>var_name</replaceable></option>
+ <option>--maximum-<replaceable>var_name</replaceable>=<replaceable>value</replaceable></option>
at server startup. For example, to prevent the value of
<literal>query_cache_size</literal> from being increased to
more than 32MB at runtime, use the option
@@ -8349,6 +8354,16 @@
</para>
<para>
+ All of the
+ <literal>Com_stmt_<replaceable>xxx</replaceable></literal>
+ variables are increased even if a prepared statement
+ argument is unknown or an error occurred during execution.
+ In other words, their values correspond to the number of
+ requests issued, not to the number of requests
+ successfully completed.
+ </para>
+
+ <para>
The
<literal>Com_stmt_<replaceable>xxx</replaceable></literal>
status variables are as follows:
@@ -8418,16 +8433,6 @@
number of network round-trips issued when fetching from
cursors.
</para>
-
- <para>
- All of the
- <literal>Com_stmt_<replaceable>xxx</replaceable></literal>
- variables are increased even if a prepared statement
- argument is unknown or an error occurred during execution.
- In other words, their values correspond to the number of
- requests issued, not to the number of requests
- successfully completed.
- </para>
</listitem>
<listitem>
@@ -9418,7 +9423,7 @@
</para>
<para>
- The status of failsafe replication (not yet implemented).
+ The status of fail-safe replication (not yet implemented).
</para>
</listitem>
@@ -9870,7 +9875,7 @@
‘<literal>`</literal>’ to quote identifiers
with this mode enabled. With
<literal>ANSI_QUOTES</literal> enabled, you cannot use
- double quotes to quote a literal string, because it is
+ double quotes to quote literal strings, because it is
interpreted as an identifier.
</para>
</listitem>
@@ -9886,15 +9891,14 @@
<para>
Produce an error in strict mode (otherwise a warning) when
- we encounter a division by zero (or
- <literal>MOD(X,0)</literal>) during an
- <literal>INSERT</literal> or <literal>UPDATE</literal>. If
- this mode is not enabled, MySQL instead returns
- <literal>NULL</literal> for divisions by zero. If used in
- <literal>INSERT IGNORE</literal> or <literal>UPDATE
- IGNORE</literal>, MySQL generates a warning for divisions
- by zero, but the result of the operation is
- <literal>NULL</literal>.
+ a division by zero (or <literal>MOD(X,0)</literal>) occurs
+ during an <literal>INSERT</literal> or
+ <literal>UPDATE</literal>. If this mode is not enabled,
+ MySQL instead returns <literal>NULL</literal> for
+ divisions by zero. For <literal>INSERT IGNORE</literal> or
+ <literal>UPDATE IGNORE</literal>, MySQL generates a
+ warning for divisions by zero, but the result of the
+ operation is <literal>NULL</literal>.
</para>
</listitem>
@@ -11193,8 +11197,7 @@
<secondary>mysqld_safe</secondary>
</indexterm>
- <option>--user={<replaceable>user_name</replaceable> |
- <replaceable>user_id</replaceable>}</option>
+ <option>--user={<replaceable>user_name</replaceable>|<replaceable>user_id</replaceable>}</option>
</para>
<para>
@@ -11649,7 +11652,7 @@
<secondary>mysqld_multi</secondary>
</indexterm>
- <option>--config-file=<replaceable>name</replaceable></option>
+ <option>--config-file=<replaceable>file_name</replaceable></option>
</para>
<para>
@@ -12682,9 +12685,9 @@
<para>
Daemonize and start the angel process (for UNIX-like
- systems). The angel process
- is simple and unlikely to crash. It will restart the
- Instance Manager itself in case of a failure.
+ systems). The angel process is simple and unlikely to
+ crash. It will restart the Instance Manager itself in case
+ of a failure.
</para>
</listitem>
@@ -12748,8 +12751,8 @@
<para>
Username to start and run the
<command>mysqlmanager</command> under (for UNIX-like
- systems). It is recommended
- to run <command>mysqlmanager</command> under the same user
+ systems). It is recommended to run
+ <command>mysqlmanager</command> under the same user
account used to run the <command>mysqld</command> server.
(<quote>User</quote> in this context refers to a system
login account, not a MySQL user listed in the grant
Modified: trunk/refman-common/titles.en.ent
===================================================================
--- trunk/refman-common/titles.en.ent 2006-03-23 18:06:29 UTC (rev 1653)
+++ trunk/refman-common/titles.en.ent 2006-03-23 18:07:05 UTC (rev 1654)
@@ -557,7 +557,7 @@
<!ENTITY title-innodb-contact-information "<literal>InnoDB</literal> Contact Information">
<!ENTITY title-innodb-deadlock-detection "Deadlock Detection and Rollback">
<!ENTITY title-innodb-deadlocks "How to Cope with Deadlocks">
-<!ENTITY title-innodb-disk-io "Disk I/O">
+<!ENTITY title-innodb-disk-io "<literal>InnoDB</literal> Disk I/O">
<!ENTITY title-innodb-error-codes "<literal>InnoDB</literal> Error Codes">
<!ENTITY title-innodb-error-handling "<literal>InnoDB</literal> Error Handling">
<!ENTITY title-innodb-file-defragmenting "Defragmenting a Table">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1654 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-common | paul | 23 Mar |