supports the options described in the following list\&.
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -254,7 +254,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
supports the options described in the following list\&. For options that refer to page numbers, the numbers are zero\-based\&.
supports the following options\&. For options that refer to page numbers, the numbers are zero\-based\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -141,7 +141,7 @@ Verbose mode; print a progress indicator every five seconds\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
If you specify a directory, the entire directory will be copied\&.
.PP
\fBmake_win_bin_dist\fR
supports the following options:
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -169,7 +169,7 @@ directories)\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -60,7 +60,7 @@ utility to make the function name substitutions\&. See
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
The output consists of options, one per line, in the form that they would be specified on the command line\&.
.PP
\fBmy_print_defaults\fR
supports the following options:
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -195,7 +195,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
index file directly, so it must be run on the server host where the table is located
index file directly, so it must be run on the server host where the table is located\&. Before using
\fBmyisam_ftdump\fR, be sure to issue a
FLUSH TABLES
statement first if the server is running\&.
.PP
\fBmyisam_ftdump\fR
scans and dumps the entire index, which is not particularly fast\&. On the other hand, the distribution of words changes infrequently, so it need not be run often\&.
@@ -222,7 +242,7 @@ Verbose mode\&. Print more output about what the program does\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -2238,7 +2235,7 @@ What percentage of the data file is unused\&.
Blocks/Record
.sp
Average number of blocks per row (that is, how many links a fragmented row is composed of)\&. This is always 1\&.0 for fixed\-format tables\&. This value should stay as close to 1\&.0 as possible\&. If it gets too large, you can reorganize the table\&. See
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -225,7 +225,7 @@ Display version information\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
supports the following options\&. It also reads option files and supports the options for processing them described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -149,7 +149,7 @@ Make a backup of each table\'s data file using the name
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -832,7 +832,7 @@ option to
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
is the location of the file that contains the list of tests\&. If missing, the default file is
is the location of the file that contains the list of tests to be run once to initialize the database for the testing\&. If missing, the default file is
stress_init\&.txt
in the test suite directory\&.
.RE
...
...
@@ -464,21 +465,6 @@ The duration of stress testing in seconds\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-stress-test.pl: test-suffix option
.\" test-suffix option: mysql-stress-test.pl
\fB\-\-test\-suffix=\fR\fB\fIstr\fR\fR
.sp
Unknown\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-stress-test.pl: threads option
.\" threads option: mysql-stress-test.pl
\fB\-\-threads=\fR\fB\fIN\fR\fR
...
...
@@ -503,7 +489,7 @@ Verbose mode\&. Print more information about what the program does\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright \(co 2007, 2010, Oracle and/or its affiliates. All rights reserved.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
As of MySQL 5\&.1\&.23, a suite name can be given as part of the test name\&. That is, the syntax for naming a test is:
A suite name can be given as part of the test name\&. That is, the syntax for naming a test is:
.sp
.if n \{\
.RS 4
...
...
@@ -98,7 +97,14 @@ As of MySQL 5\&.1\&.23, a suite name can be given as part of the test name\&. Th
.PP
If a suite name is given,
\fBmysql\-test\-run\&.pl\fR
looks in that suite for the test\&. With no suite name,
looks in that suite for the test\&. The test file corresponding to a test named
\fIsuite_name\&.test_name\fR
is found in
suite/\fIsuite_name\fR/t/\fItest_name\fR\&.test\&. There is also an implicit suite name
main
for the tests in the top
t
directory\&. With no suite name,
\fBmysql\-test\-run\&.pl\fR
looks in the default list of suites for a match and runs the test in any suites where it finds the test\&. Suppose that the default suite list is
main,
...
...
@@ -131,11 +137,11 @@ rpl)\&.
\fB\-\-skip\-test\fR
has the opposite effect of skipping test cases for which the names share a common prefix\&.
.PP
As of MySQL 5\&.0\&.54/5\&.1\&.23/6\&.0\&.5, the argument for the
The argument for the
\fB\-\-do\-test\fR
and
\fB\-\-skip\-test\fR
options allows more flexible specification of which tests to perform or skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example,
options also allows more flexible specification of which tests to perform or skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example,
\fB\-\-do\-test=testa\fR
matches tests that begin with
testa,
...
...
@@ -150,7 +156,7 @@ main
followed by
testa
with anything in between\&. In the latter case, the pattern match is not anchored to the beginning of the test name, so it also matches names such as
xmainytestz\&.
xmainytesta\&.
.PP
To perform setup prior to running tests,
\fBmysql\-test\-run\&.pl\fR
...
...
@@ -160,8 +166,7 @@ with the
\fB\-\-bootstrap\fR
and
\fB\-\-skip\-grant\-tables\fR
options (see
\m[blue]\fBTypical \fBconfigure\fR Options\fR\m[]\&\s-2\u[1]\d\s+2)\&. If MySQL was configured with the
running on the machine where you want to run the test suite, you do not have to stop it, as long as it is not using ports
9306
or
9307\&. If either of those ports is taken, you should set the
MTR_BUILD_THREAD
environment variable to an appropriate value, and the test suite will use a different set of ports for master, slave, NDB, and Instance Manager)\&. For example:
defines several environment variables\&. Some of them are listed in the following table\&.
uses several environment variables\&. Some of them are listed in the following table\&. Some of these are set from the outside and used by
\fBmysql\-test\-run\&.pl\fR, others are set by
\fBmysql\-test\-run\&.pl\fR
instead, and may be referred to in tests\&.
.TS
allbox tab(:);
l l
...
...
@@ -246,6 +234,12 @@ l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l.
T{
\fBVariable\fR
...
...
@@ -253,15 +247,52 @@ T}:T{
\fBMeaning\fR
T}
T{
MYSQL_TEST
MTR_VERSION
T}:T{
Path name to \fBmysqltest\fR binary
If set to 1, will run the older version 1 of
\fBmysql\-test\-run\&.pl\fR\&. This will affect
what functionailty is available and what command line
options are supported\&.
T}
T{
MYSQLTEST_VARDIR
MTR_MEM
T}:T{
Path name to the var directory that is used for
logs, temporary files, and so forth
If set to anything, will run tests with files in "memory" using tmpfs or
ramdisk\&. Not available on Windows\&. Same as
\fB\-\-mem\fR option
T}
T{
MTR_PARALLEL
T}:T{
If set, defines number of parallel threads executing tests\&. Same as
\fB\-\-parallel\fR option
T}
T{
MTR_BUILD_THREAD
T}:T{
If set, defines which port number range is used for the server
T}
T{
MTR_PORT_BASE
T}:T{
If set, defines which port number range is used for the server
T}
T{
MTR_\fINAME\fR_TIMEOUT
T}:T{
Setting of a timeout in minutes or seconds, corresponding to command
line option
\fB\-\-\fR\fB\fIname\fR\fR\fB\-timeout\fR\&.
Avaliable timeout names are TESTCASE,
SUITE (both in minutes) and
START, SHUTDOWN
(both in seconds)\&. These variables are supported from
MySQL 5\&.1\&.44\&.
T}
T{
MYSQL_TEST
T}:T{
Path name to \fBmysqltest\fR binary
T}
T{
MYSQLD_BOOTSTRAP
...
...
@@ -269,18 +300,31 @@ T}:T{
Full path name to \fBmysqld\fR that has all options enabled
T}
T{
MASTER_MYPORT
MYSQLTEST_VARDIR
T}:T{
Path name to the var directory that is used for
logs, temporary files, and so forth
T}
T{
MYSQL_TEST_DIR
T}:T{
???
Full path to the mysql\-test directory where tests
are being run from
T}
T{
MASTER_MYSOCK
MYSQL_TMP_DIR
T}:T{
???
Path to temp directory used for temporary files during tests
T}
.TE
.sp 1
.PP
The variable
MTR_PORT_BASE
was added in MySQL 5\&.1\&.45 as a more logical replacement for
MTR_BUILD_THREAD\&. It gives the actual port number directly (will be rounded down to a multiple of 10)\&. If you use
MTR_BUILD_THREAD, the port number is found by multiplying this by 10 and adding 10000\&.
.PP
Tests sometimes rely on certain environment variables being defined\&. For example, certain tests assume that
MYSQL_TEST
is defined so that
...
...
@@ -288,16 +332,23 @@ is defined so that
can invoke itself with
exec $MYSQL_TEST\&.
.PP
Other tests may refer to the last three variables listed in the preceeding table, to locate files to read or write\&. For example, tests that need to create files will typically put them in
$MYSQL_TMP_DIR/\fIfile_name\fR\&.
.PP
If you are running
\fBmysql\-test\-run\&.pl\fR
version 1 by setting
MTR_VERSION, note that this only affects the test driver, not the test client (and its language) or the tests themselves\&.
.PP
A few tests might not run with version 1 because they depend on some feature of version 2\&. You may have those tests skipped by adding the test name to the file
lib/v1/incompatible\&.tests\&. This feature is available from MySQL 5\&.1\&.40\&.
.PP
\fBmysql\-test\-run\&.pl\fR
supports the options in the following list\&. An argument of
\fB\-\-\fR
tells
\fBmysql\-test\-run\&.pl\fR
not to process any following arguments as options\&. (A description of differences between the options supported by
\fBmysql\-test\-run\&.pl\fR
and
\fBmysql\-test\-run\fR
appears following the list\&.)
not to process any following arguments as options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -323,11 +374,16 @@ Display a help message and exit\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: bench option
.\" bench option: mysql-test-run.pl
\fB\-\-bench\fR
.\" mysql-test-run.pl: big-test option
.\" big-test option: mysql-test-run.pl
\fB\-\-big\-test\fR
.sp
Run the benchmark suite\&.
Allow tests marked as "big" to run\&. Tests can be thus marked by including the line
\fB\-\-source include/big_test\&.inc\fR, and they will only be run if this option is given, or if the environment variable
BIG_TEST
is set to 1\&.
.sp
This is typically done for tests that take very long to run, or that use very much resources, so that they are not suitable for running as part of a normal test suite run\&.
.RE
.sp
.RS 4
...
...
@@ -338,12 +394,25 @@ Run the benchmark suite\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: benchdir option
.\" benchdir option: mysql-test-run.pl
\fB\-\-benchdir=\fR\fB\fIpath\fR\fR
.\" mysql-test-run.pl: build-thread option
.\" build-thread option: mysql-test-run.pl
\fB\-\-build\-thread=\fR\fB\fInumber\fR\fR
.sp
Specify a number to calculate port numbers from\&. The formula is 10 *
\fIbuild_thread\fR
+ 10000\&. Instead of a number, it can be set to
auto, which is also the default value, in which case
\fBmysql\-test\-run\&.pl\fR
will allocate a number unique to this host\&.
.sp
The value (number or
auto) can also be set with the
MTR_BUILD_THREAD
environment variable\&.
.sp
The directory where the benchmark suite is located\&. The default path is
\&.\&./\&.\&./mysql\-bench\&.
From MySQL 5\&.1\&.45, the more logical
\fB\-\-port\-base\fR
is supported as an alternative\&.
.RE
.sp
.RS 4
...
...
@@ -354,14 +423,14 @@ The directory where the benchmark suite is located\&. The default path is
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: big option
.\" big option: mysql-test-run.pl
\fB\-\-big\-test\fR
.\" mysql-test-run.pl: callgrind option
.\" callgrind option: mysql-test-run.pl
\fB\-\-callgrind\fR
.sp
Pass the
\fB\-\-big\-test\fR
option to
\fBmysqltest\fR\&.
Instructs
\fBvalgrind\fR
to use
\fBcallgrind\fR\&.
.RE
.sp
.RS 4
...
...
@@ -376,7 +445,7 @@ option to
.\" check-testcases option: mysql-test-run.pl
\fB\-\-check\-testcases\fR
.sp
Check test cases for side effects\&.
Check test cases for side effects\&. This is done by checking system state before and after each test case; if there is any difference, a warning to that effect will be written, but the test case will not be marked as failed because of it\&. This check is enabled by default\&.
.RE
.sp
.RS 4
...
...
@@ -389,9 +458,9 @@ Check test cases for side effects\&.
.\}
.\" mysql-test-run.pl: client-bindir option
.\" client-bindir option: mysql-test-run.pl
\fB\-\-client\-bindir\fR
\fB\-\-client\-bindir=\fR\fB\fIpath\fR\fR
.sp
The path to the directory where client binaries are located\&. This option was added in MySQL 5\&.0\&.66/5\&.1\&.27\&.
The path to the directory where client binaries are located\&.
.RE
.sp
.RS 4
...
...
@@ -423,7 +492,7 @@ debugger\&.
.\}
.\" mysql-test-run.pl: client-debugger option
.\" client-debugger option: mysql-test-run.pl
\fB\-\-client\-debugger\fR
\fB\-\-client\-debugger=\fR\fB\fIdebugger\fR\fR
.sp
Start
\fBmysqltest\fR
...
...
@@ -459,9 +528,9 @@ debugger\&.
.\}
.\" mysql-test-run.pl: client-libdir option
.\" client-libdir option: mysql-test-run.pl
\fB\-\-client\-libdir\fR
\fB\-\-client\-libdir=\fR\fB\fIpath\fR\fR
.sp
The path to the directory where client libraries are located\&. This option was added in MySQL 5\&.0\&.66/5\&.1\&.27\&.
The path to the directory where client libraries are located\&.
.RE
.sp
.RS 4
...
...
@@ -493,8 +562,6 @@ is to create a
combinations
file in the suite directory\&. The file should contain a section of options for each test run\&. See
Section\ \&4.9, \(lqPassing Options from mysql-test-run.pl to mysqld or mysqltest\(rq\&.
.sp
This option was added in MySQL 5\&.1\&.23/6\&.0\&.4\&.
.RE
.sp
.RS 4
...
...
@@ -511,7 +578,8 @@ This option was added in MySQL 5\&.1\&.23/6\&.0\&.4\&.
.sp
Write
\fIstr\fR
to the output\&.
to the output within lines filled with
#, as a form of banner\&.
.RE
.sp
.RS 4
...
...
@@ -593,7 +661,7 @@ Dump trace output for all clients and servers\&.
.\}
.\" mysql-test-run.pl: debugger option
.\" debugger option: mysql-test-run.pl
\fB\-\-debugger\fR
\fB\-\-debugger=\fR\fB\fIdebugger\fR\fR
.sp
Start
\fBmysqld\fR
...
...
@@ -627,7 +695,37 @@ does not fail if Debug Sync is not compiled in\&.
For information about using the Debug Sync facility for testing, see
Section\ \&4.14, \(lqThread Synchronization in Test Cases\(rq\&.
.sp
This option was added in MySQL 5\&.4\&.4/6\&.0\&.6\&.
This option was added in MySQL 5\&.1\&.41/5\&.5\&.0/6\&.0\&.6\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: defaults-file option
.\" default-file option: mysql-test-run.pl
\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR
.sp
Use the named file as fixed config file template for all tests\&.
Add setting from the named file to all generated configs\&.
.RE
.sp
.RS 4
...
...
@@ -646,9 +744,9 @@ Run all test cases having a name that begins with the given
\fIprefix\fR
value\&. This option provides a convenient way to run a family of similarly named tests\&.
.sp
As of MySQL 5\&.0\&.54/5\&.1\&.23/6\&.0\&.5, the argument for the
The argument for the
\fB\-\-do\-test\fR
option allows more flexible specification of which tests to perform\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example,
option also allows more flexible specification of which tests to perform\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. If the argument contains a lone period or does not contain any pattern metacharacters, it is interpreted the same way as previously and matches test names that begin with the argument value\&. For example,
\fB\-\-do\-test=testa\fR
matches tests that begin with
testa,
...
...
@@ -691,6 +789,23 @@ built with the embedded server\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: enable-disabled option
.\" enable-disabled option: mysql-test-run.pl
\fB\-\-enable\-disabled\fR
.sp
Ignore any
disabled\&.def
file, and run also tests marked as disbaled\&. Success or failure of those tests will be reported the same way as other tests\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: experimental option
.\" experimental option: mysql-test-run.pl
\fB\-\-experimental=\fR\fB\fIfile_name\fR\fR
...
...
@@ -699,7 +814,7 @@ Specify a file that contains a list of test cases that should be displayed with
[ exp\-fail ]
code rather than
[ fail ]
if they fail\&. This option was added in MySQL 5\&.1\&.33/6\&.0\&.11\&.
if they fail\&. This option was added in MySQL 5\&.1\&.33\&.
.sp
For an example of a file that might be specified via this option, see
Use an already running server\&. The option/value pair is what is needed by the
\fBmysql\fR
client to connect to the server\&. Each
\fB\-\-extern\fR
can only take one option/value pair as argument, so it you need more you need to repeat
\fB\-\-extern\fR
for each of them\&. Example:
.sp
Use an already running server\&.
.if n \{\
.RS 4
.\}
.nf
\&./mysql\-test\-run\&.pl \-\-extern socket=var/tmp/mysqld\&.1\&.sock alias
.fi
.if n \{\
.RE
.\}
.sp
Note: If a test case has an
\&.opt
...
...
@@ -736,7 +868,8 @@ file that requires the server to be restarted with specific options, the file wi
.\" fast option: mysql-test-run.pl
\fB\-\-fast\fR
.sp
Do not clean up from earlier test runs\&.
Do not perform controlled shutdown when servers need to be restarted or at the end of the test run\&. This is equivalent to using
\-\-shutdown\-timeout=0\&.
.RE
.sp
.RS 4
...
...
@@ -809,6 +942,8 @@ debugger\&.
Run tests with the
\fBgprof\fR
profiling tool\&.
\fB\-\-gprof\fR
was added in 5\&.1\&.45\&.
.RE
.sp
.RS 4
...
...
@@ -819,12 +954,13 @@ profiling tool\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: im-mysqld1-port option
.\" im-mysqld1-port option: mysql-test-run.pl
\fB\-\-im\-mysqld1\-port\fR
.\" mysql-test-run.pl: manual-ddd option
.\" manual-ddd option: mysql-test-run.pl
\fB\-\-manual\-ddd\fR
.sp
TCP/IP port number to use for the first
\fBmysqld\fR, controlled by Instance Manager\&.
Use a server that has already been started by the user in the
\fBddd\fR
debugger\&.
.RE
.sp
.RS 4
...
...
@@ -835,12 +971,11 @@ TCP/IP port number to use for the first
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: im-mysqld2-port option
.\" im-mysqld2-port option: mysql-test-run.pl
\fB\-\-im\-mysqld2\-port\fR
.\" mysql-test-run.pl: manual-debug option
.\" manual-debug option: mysql-test-run.pl
\fB\-\-manual\-debug\fR
.sp
TCP/IP port number to use for the second
\fBmysqld\fR, controlled by Instance Manager\&.
Use a server that has already been started by the user in a debugger\&.
.RE
.sp
.RS 4
...
...
@@ -851,12 +986,13 @@ TCP/IP port number to use for the second
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: im-port option
.\" im-port option: mysql-test-run.pl
\fB\-\-im\-port\fR
.\" mysql-test-run.pl: manual-gdb option
.\" manual-gdb option: mysql-test-run.pl
\fB\-\-manual\-gdb\fR
.sp
TCP/IP port number to use for
\fBmysqld\fR, controlled by Instance Manager\&.
Use a server that has already been started by the user in the
\fBgdb\fR
debugger\&.
.RE
.sp
.RS 4
...
...
@@ -867,14 +1003,12 @@ TCP/IP port number to use for
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: log-warnings option
.\" log-warnings option: mysql-test-run.pl
\fB\-\-log\-warnings\fR
.\" mysql-test-run.pl: mark-progress option
.\" mark-progress option: mysql-test-run.pl
\fB\-\-mark\-progress\fR
.sp
Pass the
\fB\-\-log\-warnings\fR
option to
\fBmysqld\fR\&.
Marks progress with timing (in milliseconds) and line number in
var/log/\fItestname\fR\&.progress\&.
.RE
.sp
.RS 4
...
...
@@ -885,11 +1019,14 @@ option to
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: manual-debug option
.\" manual-debug option: mysql-test-run.pl
\fB\-\-manual\-debug\fR
.\" mysql-test-run.pl: max-connections option
.\" max-connections option: mysql-test-run.pl
\fB\-\-max\-connections=\fR\fB\fInum\fR\fR
.sp
Use a server that has already been started by the user in a debugger\&.
The maximum number of simultaneous server connections that may be used per test\&. If not set, the maximum is 128\&. Minimum allowed limit is 8, maximum is 5120\&. Corresponds to the same option for
\fBmysqltest\fR\&.
.sp
This option is available from MySQL 5\&.1\&.45\&.
.RE
.sp
.RS 4
...
...
@@ -900,13 +1037,12 @@ Use a server that has already been started by the user in a debugger\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: manual-gdb option
.\" manual-gdb option: mysql-test-run.pl
\fB\-\-manual\-gdb\fR
.\" mysql-test-run.pl: max-save-core option
.\" max-save-core option: mysql-test-run.pl
\fB\-\-max\-save\-core=\fR\fB\fIN\fR\fR
.sp
Use a server that has already been started by the user in the
\fBgdb\fR
debugger\&.
Limit the number of core files saved, to avoid filling up disks in case of a frequently crashing server\&. Defaults to 5, set to 0 for no limit\&. May also be set with the environment variable
MTR_MAX_SAVE_CORE
.RE
.sp
.RS 4
...
...
@@ -917,13 +1053,12 @@ debugger\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: master-binary option
.\" master-binary option: mysql-test-run.pl
\fB\-\-master\-binary=\fR\fB\fIpath\fR\fR
.\" mysql-test-run.pl: max-save-datadir option
.\" max-save-datadir option: mysql-test-run.pl
\fB\-\-max\-save\-datadir=\fR\fB\fIN\fR\fR
.sp
Specify the path of the
\fBmysqld\fR
binary to use for master servers\&.
Limit the number of data directories saved after failed tests, to avoid filling up disks in case of frequent failures\&. Defaults to 20, set to 0 for no limit\&. May also be set with the environment variable
MTR_MAX_SAVE_DATADIR
.RE
.sp
.RS 4
...
...
@@ -934,11 +1069,12 @@ binary to use for master servers\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: master_port option
.\" master_port option: mysql-test-run.pl
\fB\-\-master_port=\fR\fB\fIport_num\fR\fR
.\" mysql-test-run.pl: max-test-fail option
.\" max-test-fail option: mysql-test-run.pl
\fB\-\-max\-test\-fail=\fR\fB\fIN\fR\fR
.sp
Specify the TCP/IP port number for the first master server to use\&. Observe that the option name has an underscore and not a dash\&.
Stop execution after the specified number of tests have failed, to avoid using up resources (and time) in case of massive failures\&. retries are noe counted, nor are failures of tests marked experimental\&. Defaults to 10, set to 0 for no limit\&. May also be set with the environment variable
MTR_MAX_TEST_FAIL
.RE
.sp
.RS 4
...
...
@@ -953,7 +1089,9 @@ Specify the TCP/IP port number for the first master server to use\&. Observe tha
.\" mem option: mysql-test-run.pl
\fB\-\-mem\fR
.sp
Run the test suite in memory, using tmpfs or ramdisk\&. This can decrease test times significantly\&.
This option is not supported on Windows\&.
.sp
Run the test suite in memory, using tmpfs or ramdisk\&. This can decrease test times significantly, in particular if you would otherwise be running over a remote file system\&.
\fBmysql\-test\-run\&.pl\fR
attempts to find a suitable location using a built\-in list of standard locations for tmpfs and puts the
var
...
...
@@ -966,7 +1104,14 @@ MTR_MEM[=\fIdir_name\fR]\&. If
\fIdir_name\fR
is given, it is added to the beginning of the list of locations to search, so it takes precedence over any built\-in locations\&.
.sp
This option was added in MySQL 4\&.1\&.22, 5\&.0\&.30, and 5\&.1\&.13\&.
Once you have run tests with
\fB\-\-mem\fR
within a
mysql\-testdirectory, a soflink
var
will have been set up to the temporary directory, and this will be re\-used the next time, until the soflink is deleted\&. Thus, you do not have to repeat the
\fB\-\-mem\fR
option next time\&.
.RE
.sp
.RS 4
...
...
@@ -996,25 +1141,6 @@ Section\ \&4.9, \(lqPassing Options from mysql-test-run.pl to mysqld or mysqltes
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: mysqltest option
.\" mysqltest option: mysql-test-run.pl
\fB\-\-mysqltest=\fR\fB\fIvalue\fR\fR
.sp
Extra options to pass to
\fBmysqltest\fR\&. The value should consist of one or more comma\-separated
\fBmysqltest\fR
options\&. See
Section\ \&4.9, \(lqPassing Options from mysql-test-run.pl to mysqld or mysqltest\(rq\&. This option was added in MySQL 6\&.0\&.6\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: ndb-connectstring option
.\" ndb-connectstring option: mysql-test-run.pl
\fB\-\-ndb\-connectstring=\fR\fB\fIstr\fR\fR
...
...
@@ -1034,15 +1160,13 @@ from starting a cluster\&. It is assumed that there is already a cluster running
to slave MySQL servers\&. This option also prevents
\fBmysql\-test\-run\&.pl\fR
from starting a cluster\&. It is assumed that there is already a cluster running to which the server can connect with the given connectstring\&.
Disable the check for test case side effects; see
\fB\-\-check\-testcases\fR
for a description\&.
.RE
.sp
.RS 4
...
...
@@ -1053,11 +1177,11 @@ from starting a cluster\&. It is assumed that there is already a cluster running
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: ndb-extra-test option
.\" ndb-extra-test option: mysql-test-run.pl
\fB\-\-ndb\-extra\-test\fR
.\" mysql-test-run.pl: noreorder option
.\" noreorder option: mysql-test-run.pl
\fB\-\-noreorder\fR
.sp
Unknown\&.
Do not reorder tests to reduce number of restarts, but run them in exactly the order given\&. If a whole suite is to be run, the tests are run in alphabetical order, though similiar combinations will be grouped together\&. If more than one suite is listed, the tests are run one suite at a time, in the order listed\&.
.RE
.sp
.RS 4
...
...
@@ -1068,14 +1192,13 @@ Unknown\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: ndbcluster-port option
.\" ndbcluster-port option: mysql-test-run.pl
.\" mysql-test-run.pl: ndbcluster_port option
.\" ndbcluster_port option: mysql-test-run.pl
\fB\-\-ndbcluster\-port=\fR\fB\fIport_num\fR\fR,
\fB\-\-ndbcluster_port=\fR\fB\fIport_num\fR\fR
.\" mysql-test-run.pl: notimer option
.\" notimer option: mysql-test-run.pl
\fB\-\-notimer\fR
.sp
Specify the TCP/IP port number that NDB Cluster should use\&.
Cause
\fBmysqltest\fR
not to generate a timing file\&. The effect of this is that the report from each test case does not include the timing in milliseconds as it normally does\&.
.RE
.sp
.RS 4
...
...
@@ -1086,11 +1209,11 @@ Specify the TCP/IP port number that NDB Cluster should use\&.
Specify the TCP/IP port number that the slave NDB Cluster should use\&.
Do not look for and report errors and warning in the server logs\&.
.RE
.sp
.RS 4
...
...
@@ -1101,13 +1224,16 @@ Specify the TCP/IP port number that the slave NDB Cluster should use\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: netware option
.\" netware option: mysql-test-run.pl
\fB\-\-netware\fR
.\" mysql-test-run.pl: parallel option
.\" parallel option: mysql-test-run.pl
\fB\-\-parallel={\fR\fB\fIN\fR\fR\fB|auto}\fR
.sp
Run
\fBmysqld\fR
with options needed on NetWare\&.
Run tests using
\fIN\fR
parallel threads\&. By default, 1 thread is used\&. Use
\fB\-\-parallel=auto\fR
for auto\-setting of
\fIN\fR\&. The auto value was added in MySQL 5\&.1\&.36\&.
.RE
.sp
.RS 4
...
...
@@ -1118,13 +1244,24 @@ with options needed on NetWare\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: notimer option
.\" notimer option: mysql-test-run.pl
\fB\-\-notimer\fR
.\" mysql-test-run.pl: port-base option
.\" port-base option: mysql-test-run.pl
\fB\-\-port\-base=\fR\fB\fIP\fR\fR
.sp
Cause
\fBmysqltest\fR
not to generate a timing file\&.
Specify base of port numbers to be used; a block of 10 will be allocated\&.
\fIP\fR
should be divisible by 10; if it is not, it will be rounded down\&. If running with more than one parallel test thread, thread 2 will use the next block of 10 and so on\&.
.sp
If the port number is given as
auto, which is also the default,
\fBmysql\-test\-run\&.pl\fRwill allocate a number unique to this host\&. The value may also be given with the environment variable
MTR_PORT_BASE\&.
.sp
\fB\-\-port\-base\fR
was added in MySQL 5\&.1\&.45 as a more logical alternative to
\fB\-\-build\-thread\fR\&. If both are used,
\fB\-\-port\-base\fR
takes presedence\&.
.RE
.sp
.RS 4
...
...
@@ -1135,16 +1272,11 @@ not to generate a timing file\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: parallel option
.\" parallel option: mysql-test-run.pl
\fB\-\-parallel={\fR\fB\fIN\fR\fR\fB|auto}\fR
.\" mysql-test-run.pl: print-testcases option
.\" print-testcases option: mysql-test-run.pl
\fB\-\-print\-testcases\fR
.sp
Run tests using
\fIN\fR
parallel threads\&. By default, 1 thread is used\&. Use
\fB\-\-parallel=auto\fR
for auto\-setting of
\fIN\fR\&. This option was added in MySQL 5\&.1\&.36\&.
Do not run any tests, but print details about all tests, in the order they would have been run\&.
.RE
.sp
.RS 4
...
...
@@ -1195,7 +1327,24 @@ option to
.\" reorder option: mysql-test-run.pl
\fB\-\-reorder\fR
.sp
Reorder tests to minimize the number of server restarts needed\&.
Reorder tests to minimize the number of server restarts needed\&. This is the default behavior\&. There is no guarantee that a particular set of tests will always end up in the same order\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: repeat option
.\" repeat option: mysql-test-run.pl
\fB\-\-repeat=\fR\fB\fIN\fR\fR
.sp
Run each test
\fIN\fR
number of times\&.
.RE
.sp
.RS 4
...
...
@@ -1214,8 +1363,33 @@ Display the output of
SHOW ENGINES
and
SHOW VARIABLES\&. This can be used to verify that binaries are built with all required features\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: retry option
.\" retry option: mysql-test-run.pl
\fB\-\-retry=\fR\fB\fIN\fR\fR
.sp
If a test fails, it is retried up to a maximum of
\fIN\fR
runs, but will terminate after 2 failures\&. Default is 3, set to 1 or 0 for no retries\&. This option has no effect unless
\fB\-\-force\fR
is also used; without it, test execution will terminate after the first failure\&.
.sp
This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.14\&.
The
\fB\-\-retry\fR
and
\fB\-\-retry\-failure\fR
options do not affect how many times a test repeated with
\fB\-\-repeat\fR
may fail in total, as each repetition is considered a new test case, which may in turn be retried if it fails\&.
.RE
.sp
.RS 4
...
...
@@ -1226,13 +1400,11 @@ This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.14\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: script-debug option
.\" script-debug option: mysql-test-run.pl
\fB\-\-script\-debug\fR
.\" mysql-test-run.pl: retry-failure option
.\" retry-failure option: mysql-test-run.pl
\fB\-\-retry\-failure=\fR\fB\fIN\fR\fR
.sp
Enable debug output for
\fBmysql\-test\-run\&.pl\fR
itself\&.
Allow a failed and retried test to fail more than the default 2 times before giving it up\&. Setting it to 0 or 1 effectively turns off retries
.RE
.sp
.RS 4
...
...
@@ -1243,11 +1415,11 @@ itself\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: skip-im option
.\" skip-im option: mysql-test-run.pl
\fB\-\-skip\-im\fR
.\" mysql-test-run.pl: shutdown-timeout option
.\" shutdown-timeout option: mysql-test-run.pl
\fB\-\-shutdown\-timeout=\fR\fB\fISECONDS\fR\fR
.sp
Do not start Instance Manager; skip Instance Manager test cases\&.
Max number of seconds to wait for servers to do controlled shutdown before killing them\&. Default is 10\&.
.RE
.sp
.RS 4
...
...
@@ -1258,11 +1430,11 @@ Do not start Instance Manager; skip Instance Manager test cases\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: skip-master-binlog option
.\" skip-master-binlog option: mysql-test-run.pl
\fB\-\-skip\-master\-binlog\fR
.\" mysql-test-run.pl: skip-combinations option
.\" skip-combinations option: mysql-test-run.pl
\fB\-\-skip\-combinations\fR
.sp
Do not enable master server binary logging\&.
Do not apply combinations; ignore combinations file or option\&.
.RE
.sp
.RS 4
...
...
@@ -1324,21 +1496,6 @@ Skip replication test cases\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: skip-slave-binlog option
.\" skip-slave-binlog option: mysql-test-run.pl
\fB\-\-skip\-slave\-binlog\fR
.sp
Do not enable master server binary logging\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: skip-ssl option
.\" skip-ssl option: mysql-test-run.pl
\fB\-\-skip\-ssl\fR
...
...
@@ -1362,7 +1519,7 @@ with support for SSL connections\&.
.sp
Specify a regular expression to be applied to test case names\&. Cases with names that match the expression are skipped\&. tests to skip\&.
.sp
As of MySQL 5\&.0\&.54/5\&.1\&.23/6\&.0\&.5, the argument for the
The argument for the
\fB\-\-skip\-test\fR
option allows more flexible specification of which tests to skip\&. If the argument contains a pattern metacharacter other than a lone period, it is interpreted as a Perl regular expression and applies to test names that match the pattern\&. See the description of the
\fB\-\-do\-test\fR
...
...
@@ -1393,13 +1550,14 @@ are passed to the master server\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: slave-binary option
.\" slave-binary option: mysql-test-run.pl
\fB\-\-slave\-binary=\fR\fB\fIpath\fR\fR
.\" mysql-test-run.pl: sleep option
.\" sleep option: mysql-test-run.pl
\fB\-\-sleep=\fR\fB\fIN\fR\fR
.sp
Specify the path of the
\fBmysqld\fR
binary to use for slave servers\&.
Pass
\fB\-\-sleep=\fR\fB\fIN\fR\fR
to
\fBmysqltest\fR\&.
.RE
.sp
.RS 4
...
...
@@ -1410,82 +1568,14 @@ binary to use for slave servers\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: slave_port option
.\" slave_port option: mysql-test-run.pl
\fB\-\-slave_port=\fR\fB\fIport_num\fR\fR
.\" mysql-test-run.pl: sp-protocol option
.\" sp-protocol option: mysql-test-run.pl
\fB\-\-sp\-protocol\fR
.sp
Specify the TCP/IP port number for the first master server to use\&. Observe that the option name has an underscore and not a dash\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: sleep option
.\" sleep option: mysql-test-run.pl
\fB\-\-sleep=\fR\fB\fIN\fR\fR
.sp
Pass
\fB\-\-sleep=\fR\fB\fIN\fR\fR
to
\fBmysqltest\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: small-bench option
.\" small-bench option: mysql-test-run.pl
\fB\-\-small\-bench\fR
.sp
Run the benchmarks with the
\fB\-\-small\-tests\fR
and
\fB\-\-small\-tables\fR
options\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: socket option
.\" socket option: mysql-test-run.pl
\fB\-\-socket=\fR\fB\fIfile_name\fR\fR
.sp
For connections to
localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: sp-protocol option
.\" sp-protocol option: mysql-test-run.pl
\fB\-\-sp\-protocol\fR
.sp
Pass the
\fB\-\-sp\-protocol\fR
option to
\fBmysqltest\fR\&.
Pass the
\fB\-\-sp\-protocol\fR
option to
\fBmysqltest\fR\&.
.RE
.sp
.RS 4
...
...
@@ -1520,39 +1610,11 @@ Couldn\'t find support for SSL
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: start option
.\" start option: mysql-test-run.pl
\fB\-\-start\fR
.sp
Initialize and start servers with the startup settings for the first specified test case\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBcd mysql\-test\fR
shell> \fB\&./mysql\-test\-run\&.pl \-\-start alias &\fR
.fi
.if n \{\
.RE
.\}
.sp
This option was added in MySQL 5\&.1\&.32/6\&.0\&.11\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: start-and-exit option
.\" start-and-exit option: mysql-test-run.pl
\fB\-\-start\-and\-exit\fR
\fB\-\-start\fR
.sp
Initialize and start servers with the startup settings for the specified test case or cases, if any, and then exit\&. You can use this option to start a server to which you can connect later\&. For example, after building a source distribution you can start a server and connect to it with the
Initialize and start servers with the startup settings for the specified test case\&. You can use this option to start a server to which you can connect later\&. For example, after building a source distribution you can start a server and connect to it with the
Start servers (without initialization) for the specified test case or cases, if any, and then exit\&. You can then manually run the test cases\&.
This is similar to
\fB\-\-start\fR, but will skip the database initialization phase and assume that database files are already available\&. Usually this means you must have run another test first\&.
The file that contains the list of tests to use in stress testing\&. The tests should be named without the
\&.test
extension\&. The default file is
stress_tests\&.txt
in the test suite directory\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: stress-threads option
.\" stress-threads option: mysql-test-run.pl
\fB\-\-stress\-threads=\fR\fB\fIN\fR\fR
.sp
The number of threads to use in stress testing\&. The default is 5\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: suite option
.\" suite option: mysql-test-run.pl
\fB\-\-suite=\fR\fB\fIsuite_name\fR\fR
...
...
@@ -1831,14 +1746,12 @@ Specify the maximum test case runtime\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: timer option
.\" timer option: mysql-test-run.pl
\fB\-\-timer\fR
.\" mysql-test-run.pl: timediff option
.\" timediff option: mysql-test-run.pl
\fB\-\-timediff\fR
.sp
Cause
\fBmysqltest\fR
to generate a timing file\&. The default file is named
\&./var/log/timer\&.
Adds to each test report for a test case, the total time in sconds and milliseconds passed since the preceding test ended\&. This option can only be used together with
\fB\-\-timestamp\fR, and has no effect without it\&.
.RE
.sp
.RS 4
...
...
@@ -1849,28 +1762,14 @@ to generate a timing file\&. The default file is named
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: tmpdir option
.\" tmpdir option: mysql-test-run.pl
\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR
.sp
The directory where temporary file are stored\&. The default location is
\&./var/tmp\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: unified-diff option
.\" unified-diff option: mysql-test-run.pl
\fB\-\-unified\-diff\fR,
\fB\-\-udiff\fR
.\" mysql-test-run.pl: timer option
.\" timer option: mysql-test-run.pl
\fB\-\-timer\fR
.sp
Use unified diff format when presenting differences between expected and actual test case results\&.
Cause
\fBmysqltest\fR
to generate a timing file\&. The default file is named
\&./var/log/timer\&.
.RE
.sp
.RS 4
...
...
@@ -1881,11 +1780,11 @@ Use unified diff format when presenting differences between expected and actual
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: use-old-data option
.\" use-old-data option: mysql-test-run.pl
\fB\-\-use\-old\-data\fR
.\" mysql-test-run.pl: timestamp option
.\" timestamp option: mysql-test-run.pl
\fB\-\-timestamp\fR
.sp
Do not install the test databases\&. (Use existing ones\&.)
Prints a timestamp before the test case name in each test report line, showing when the test ended\&.
.RE
.sp
.RS 4
...
...
@@ -1896,11 +1795,14 @@ Do not install the test databases\&. (Use existing ones\&.)
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: user-test option
.\" user-test option: mysql-test-run.pl
\fB\-\-user\-test=\fR\fB\fIval\fR\fR
.\" mysql-test-run.pl: tmpdir option
.\" tmpdir option: mysql-test-run.pl
\fB\-\-tmpdir=\fR\fB\fIpath\fR\fR
.sp
Unused\&.
The directory where temporary file are stored\&. The default location is
\&./var/tmp\&. The environment variable
MYSQL_TMP_DIR
will be set to the path for this directory, whether it has the default value or has been set explicitly\&. This may be referred to in tests\&.
.RE
.sp
.RS 4
...
...
@@ -1935,7 +1837,11 @@ Run
and
\fBmysqld\fR
with
\fBvalgrind\fR\&.
\fBvalgrind\fR\&. Thiks and the following
\fB\-\-valgrind\fR
options require that the executables have been build with
Specify the path where files generated during the test run are stored\&. The default location is
\&./var\&.
\&./var\&. The environment variable
MYSQLTEST_VARDIR
will be set to the path for this directory, whether it has the default value or has been set explicitly\&. This may be referred to in tests\&.
.RE
.sp
.RS 4
...
...
@@ -2055,14 +1939,11 @@ Specify the path where files generated during the test run are stored\&. The def
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: view-protocol option
.\" view-protocol option: mysql-test-run.pl
\fB\-\-view\-protocol\fR
.\" mysql-test-run.pl: verbose option
.\" verbose option: mysql-test-run.pl
\fB\-\-verbose\fR
.sp
Pass the
\fB\-\-view\-protocol\fR
option to
\fBmysqltest\fR\&.
Give more verbose output regarding test execution\&. Use the option twice to get even more output\&. Note that the output generated within each test case is not affected\&.
.RE
.sp
.RS 4
...
...
@@ -2073,13 +1954,11 @@ option to
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: vs-config option
.\" vs-config option: mysql-test-run.pl
\fB\-\-vs\-config=\fR\fB\fIconfig_val\fR\fR
.\" mysql-test-run.pl: verbose-restart option
.\" verbose-restart option: mysql-test-run.pl
\fB\-\-verbose\-restart\fR
.sp
Specify the configuration used to build MySQL (for example,
\fB\-\-vs\-config=debug\fR
\fB\-\-vs\-config=release\fR)\&. This option is for Windows only\&. It is available as of MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.14\&.
Write when and why servers are restarted between test cases\&.
.RE
.sp
.RS 4
...
...
@@ -2090,11 +1969,14 @@ Specify the configuration used to build MySQL (for example,
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: wait-timeout option
.\" wait-timeout option: mysql-test-run.pl
\fB\-\-wait\-timeout=\fR\fB\fIN\fR\fR
.\" mysql-test-run.pl: view-protocol option
.\" view-protocol option: mysql-test-run.pl
\fB\-\-view\-protocol\fR
.sp
Unused?
Pass the
\fB\-\-view\-protocol\fR
option to
\fBmysqltest\fR\&.
.RE
.sp
.RS 4
...
...
@@ -2105,12 +1987,13 @@ Unused?
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: warnings option
.\" warnings option: mysql-test-run.pl
\fB\-\-warnings\fR
.\" mysql-test-run.pl: vs-config option
.\" vs-config option: mysql-test-run.pl
\fB\-\-vs\-config=\fR\fB\fIconfig_val\fR\fR
.sp
This option is a synonym for
\fB\-\-log\-warnings\fR\&.
Specify the configuration used to build MySQL (for example,
\fB\-\-vs\-config=debug\fR
\fB\-\-vs\-config=release\fR)\&. This option is for Windows only\&.
.RE
.sp
.RS 4
...
...
@@ -2121,11 +2004,17 @@ This option is a synonym for
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: with-ndbcluster option
.\" with-ndbcluster option: mysql-test-run.pl
\fB\-\-with\-ndbcluster\fR
.\" mysql-test-run.pl: wait-all option
.\" wait-all option: mysql-test-run.pl
\fB\-\-wait\-all\fR
.sp
If
\fB\-\-start\fR
or
\fB\-\-start\-dirty\fR
is used, wait for all servers to exit before termination\&. Otherise, it will terminate if one (of several) servers is restarted\&.
.sp
Use NDB Cluster and enable test cases that require it\&.
This option was added in MySQL 5\&.1\&.36\&.
.RE
.sp
.RS 4
...
...
@@ -2136,11 +2025,12 @@ Use NDB Cluster and enable test cases that require it\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysql-test-run.pl: with-ndbcluster-all option
.\" with-ndbcluster-all option: mysql-test-run.pl
\fB\-\-with\-ndbcluster\-all\fR
.\" mysql-test-run.pl: warnings option
.\" warnings option: mysql-test-run.pl
\fB\-\-warnings\fR
.sp
Use NDB Cluster in all tests\&.
Search the server log for errors or warning after each test and report any suspicious ones; if any are found, the test will be marked as failed\&. This is the default behavior, it may be turned off with
\fB\-\-nowarnings\fR\&.
.RE
.sp
.RS 4
...
...
@@ -2159,100 +2049,10 @@ Run only test cases that have
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright \(co 2007, 2010, Oracle and/or its affiliates. All rights reserved.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
...
...
@@ -2260,12 +2060,6 @@ This documentation is distributed in the hope that it will be useful, but WITHOU
.PP
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
supports the following options, which can be specified on the command line or in the
[mysql]
and
[client]
option file groups\&.
\fBmysql\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -182,7 +188,7 @@ option\&.
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -345,7 +351,7 @@ latin1
character set by default\&. You can usually fix such issues by using this option to force the client to use the system character set instead\&.
.sp
See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq, for more information\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq, for more information\&.
.RE
.sp
.RS 4
...
...
@@ -550,10 +556,8 @@ the section called \(lqMYSQL COMMANDS\(rq\&.
\fB\-\-no\-auto\-rehash\fR,
\fB\-A\fR
.sp
Deprecated form of
\fB\-skip\-auto\-rehash\fR\&. Use
\fB\-\-disable\-auto\-rehash\fR
instead\&. See the description for
This has the same effect as
\fB\-skip\-auto\-rehash\fR\&. See the description for
\fB\-\-auto\-rehash\fR\&.
.RE
.sp
...
...
@@ -589,6 +593,8 @@ Do not beep when errors occur\&.
Deprecated, use
\fB\-\-disable\-named\-commands\fR
instead\&.
\fB\-\-no\-named\-commands\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
...
...
@@ -607,6 +613,8 @@ Deprecated form of
\fB\-\-skip\-pager\fR\&. See the
\fB\-\-pager\fR
option\&.
\fB\-\-no\-pager\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
...
...
@@ -621,8 +629,12 @@ option\&.
.\" no-tee option: mysql
\fB\-\-no\-tee\fR
.sp
Do not copy output to a file\&.
the section called \(lqMYSQL COMMANDS\(rq, discusses tee files further\&.
Deprecated form of
\fB\-\-skip\-tee\fR\&. See the
\fB\-\-tee\fR
option\&.
\fB\-\-no\-tee\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
...
...
@@ -684,10 +696,12 @@ value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysql\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
On Windows, connect to the server via a named pipe\&. This option applies only for connections to a local server, and only if the server supports named\-pipe connections\&.
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
.RE
.sp
.RS 4
...
...
@@ -950,9 +964,7 @@ option\&.
\fB\-\-skip\-column\-names\fR,
\fB\-N\fR
.sp
Do not write column names in results\&. The short format,
\fB\-N\fR
is deprecated, use the long format instead\&.
Do not write column names in results\&.
.RE
.sp
.RS 4
...
...
@@ -968,9 +980,7 @@ is deprecated, use the long format instead\&.
\fB\-\-skip\-line\-numbers\fR,
\fB\-L\fR
.sp
Do not write line numbers for errors\&. Useful when you want to compare result files that include error messages\&. The short format,
\fB\-L\fR
is deprecated, use the long format instead\&.
Do not write line numbers for errors\&. Useful when you want to compare result files that include error messages\&.
.RE
.sp
.RS 4
...
...
@@ -1005,7 +1015,7 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR\&. The
\fB\-\-set\-variable\fR
format is deprecated\&.
format is deprecated and is removed in MySQL 5\&.5\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -1325,7 +1335,7 @@ environment variable\&.
The
\&.mysql_history
should be protected with a restrictive access mode because sensitive information might be written to it, such as the text of SQL statements that contain passwords\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
.PP
If you do not want to maintain a history file, first remove
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
...
...
@@ -2817,7 +2827,7 @@ You should have received a copy of the GNU General Public License along with the
.IP " 1." 4
Bug#25946
.RS 4
\%http://bugs.mysql.com/25946
\%http://bugs.mysql.com/bug.php?id=25946
.RE
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
@@ -62,7 +62,7 @@ sections, although you should rename such sections to
when using MySQL 5\&.1\&.
.PP
\fBmysql\&.server\fR
supports the following options:
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -176,7 +176,7 @@ The login user name to use for running
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
is similar but used for testing the embedded server\&. Both programs are run as part of the test suite\&.
.PP
The source code for the programs can be found in in
test/mysql_client_test\&.c
tests/mysql_client_test\&.c
in a source distribution\&. The program serves as a good source of examples illustrating how to use various features of the client API\&.
.PP
\fBmysql_client_test\fR
is used in a test by the same name in the main tests suite of
\fBmysql\-test\-run\&.pl\fR
but may also be run directly\&. Unlike the other programs listed here, it does not read an external description of what tests to run\&. Instead, all tests are coded into the program, which is written to cover all aspects of the C language API\&.
.PP
\fBmysql_client_test\fR
supports the following options:
.sp
.RS 4
...
...
@@ -70,10 +75,10 @@ Display a help message and exit\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-b \fR\fB\fIdir_name\fR\fR,
\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR,
.\" mysql_client_test: basedir option
.\" basedir option: mysql_client_test
\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR
\fB\-b \fR\fB\fIdir_name\fR\fR
.sp
The base directory for the tests\&.
.RE
...
...
@@ -86,10 +91,10 @@ The base directory for the tests\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-t \fR\fB\fIcount\fR\fR,
\fB\-\-count=\fR\fB\fIcount\fR\fR,
.\" mysql_client_test: count option
.\" count option: mysql_client_test
\fB\-\-count=\fR\fB\fIcount\fR\fR
\fB\-t \fR\fB\fIcount\fR\fR
.sp
The number of times to execute the tests\&.
.RE
...
...
@@ -137,10 +142,10 @@ value is
.sp -1
.IP \(bu 2.3
.\}
\fB\-g \fR\fB\fIoption\fR\fR,
\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR,
.\" mysql_client_test: getopt-ll-test option
.\" getopt-ll-test option: mysql_client_test
\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR
\fB\-g \fR\fB\fIoption\fR\fR
.sp
Option to use for testing bugs in the
getopt
...
...
@@ -213,10 +218,10 @@ The TCP/IP port number to use for the connection\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-A \fR\fB\fIarg\fR\fR,
\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR,
.\" mysql_client_test: server-arg option
.\" server-arg option: mysql_client_test
\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR
\fB\-A \fR\fB\fIarg\fR\fR
.sp
Argument to send to the embedded server\&.
.RE
...
...
@@ -229,8 +234,8 @@ Argument to send to the embedded server\&.
.sp -1
.IP \(bu 2.3
.\}
\fB\-T\fR,
\fB\-\-show\-tests\fR
\fB\-\-show\-tests\fR,
\fB\-T\fR
.sp
Show all test names\&.
.RE
...
...
@@ -277,12 +282,13 @@ localhost
.sp -1
.IP \(bu 2.3
.\}
\fB\-c\fR,
\fB\-\-testcase\fR
\fB\-\-testcase\fR,
\fB\-c\fR
.sp
The option may disable some code when run as a
\fBmysql\-test\-run\&.pl\fR
test case\&.
The option is used when called from
\fBmysql\-test\-run\&.pl\fR, so that
\fBmysql_client_test\fR
may optionally behave in a different way than if called manually, for example by skipping some tests\&. Currently, there is no difference in behavior but the option is included in order to make this possible\&.
.RE
.sp
.RS 4
...
...
@@ -320,7 +326,7 @@ mysql\-test/var\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright \(co 2007, 2010, Oracle and/or its affiliates. All rights reserved.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -30,7 +30,7 @@ mysql_config \- get compile options for compiling clients
provides you with useful information for compiling your MySQL client and connecting it to MySQL\&.
.PP
\fBmysql_config\fR
supports the following options:
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -224,7 +224,7 @@ this way, be sure to invoke it within backtick (\(lq`\(rq) characters\&. That te
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -115,10 +115,10 @@ Connect to the MySQL server on the given host\&.
.\" password option: mysql_convert_table_format
\fB\-\-password=\fR\fB\fIpassword\fR\fR
.sp
The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&. You can use an option file to avoid giving the password on the command line\&.
The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
.RE
.sp
.RS 4
...
...
@@ -216,7 +216,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
Prior to version 5\&.1\&.17, this script is found in the
Prior to version 5\&.1\&.17, the
mysql_fix_privilege_tables\&.sql
script is found in the
scripts
directory\&.
.sp .5v
...
...
@@ -157,7 +159,7 @@ After running the script, stop the server and restart it\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -94,8 +94,12 @@ environment variable to the full path name of a server that has all options enab
will use that server\&.
.PP
\fBmysql_install_db\fR
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
supports the following options, which can be specified on the command line or in the
[mysql_install_db]
and (if they are common to
\fBmysqld\fR)
[mysqld]
option file groups\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -248,7 +252,7 @@ For internal use\&. This option is used for creating Windows distributions\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -96,7 +96,7 @@ The script will prompt you to determine which actions to perform\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -109,10 +109,10 @@ Connect to the MySQL server on the given host\&.
.\" password option: mysql_setpermission
\fB\-\-password=\fR\fB\fIpassword\fR\fR
.sp
The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&. You can use an option file to avoid giving the password on the command line\&.
The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
.RE
.sp
.RS 4
...
...
@@ -163,7 +163,7 @@ The MySQL user name to use when connecting to the server\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -33,11 +33,11 @@ program loads the time zone tables in the
mysql
database\&. It is used on systems that have a
zoneinfo
database (the set of files describing time zones)\&. Examples of such systems are Linux, FreeBSD, Sun Solaris, and Mac OS X\&. One likely location for these files is the
database (the set of files describing time zones)\&. Examples of such systems are Linux, FreeBSD, Solaris, and Mac OS X\&. One likely location for these files is the
/usr/share/zoneinfo
directory (/usr/share/lib/zoneinfo
on Solaris)\&. If your system does not have a zoneinfo database, you can use the downloadable package described in
Section\ \&9.7, \(lqMySQL Server Time Zone Support\(rq\&.
Section\ \&9.6, \(lqMySQL Server Time Zone Support\(rq\&.
.PP
\fBmysql_tzinfo_to_sql\fR
can be invoked several ways:
...
...
@@ -113,7 +113,7 @@ After running
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -52,6 +52,24 @@ for manual table repair strategies\&.
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
On Windows Server 2008 and Windows Vista, you must run
\fBmysql_upgrade\fR
with administrator privileges\&. You can do this by running a Command Prompt as Administrator and running the command\&. Failure to do so may result in the upgrade failing to execute correctly\&.
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBCaution\fR
.ps -1
.br
...
...
@@ -59,7 +77,7 @@ for manual table repair strategies\&.
You should always back up your current MySQL installation
that contains SQL statements to upgrade the tables in the
mysql
...
...
@@ -198,15 +216,17 @@ was added as a shell script and worked only for Unix systems\&. As of MySQL 5\&.
is an executable binary and is available on all systems\&.
.PP
\fBmysql_upgrade\fR
supports the options in the following list\&. It also reads option files (the
supports the following options, which can be specified on the command line or in the
[mysql_upgrade]
and
[client]
groups) and supports the options for processing them described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&. Other options are passed to
option file groups\&. Other options are passed to
\fBmysqlcheck\fR\&. For example, it might be necessary to specify the
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR
option\&.
\fBmysql_upgrade\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -375,7 +395,7 @@ This option was introduced in MySQL 5\&.1\&.40\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -120,7 +120,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -116,7 +116,7 @@ Test mode\&. Display information about each process but do not kill it\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqlaccess\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -319,13 +321,15 @@ Undo the most recent changes to the temporary grant tables\&.
The password to use when connecting to the server as the superuser\&. If you omit the
\fIpassword\fR
value following the
\fB\-\-password\fR
\fB\-\-spassword\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqlaccess\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -419,7 +423,7 @@ error will occur when you run
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -586,7 +586,13 @@ waits until the server\'s process ID file has been removed, to ensure that the s
.\" startup parameters: mysqladmin
.PP
\fBmysqladmin\fR
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
supports the following options, which can be specified on the command line or in the
[mysqladmin]
and
[client]
option file groups\&.
\fBmysqladmin\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -618,7 +624,7 @@ Display a help message and exit\&.
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -720,7 +726,7 @@ Print debugging information and memory and CPU usage statistics when the program
Use
\fIcharset_name\fR
as the default character set\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -794,10 +800,12 @@ value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqladmin\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
On Windows, connect to the server via a named pipe\&. This option applies only for connections to a local server, and only if the server supports named\-pipe connections\&.
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
.RE
.sp
.RS 4
...
...
@@ -940,7 +948,7 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
format is deprecated and is removed in MySQL 5\&.5\&. syntax:
.sp
.RS 4
.ie n \{\
...
...
@@ -1064,7 +1072,7 @@ The maximum number of seconds to wait for server shutdown\&. The default value i
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
to display the contents of relay log files written by a slave server in a replication setup because relay logs have the same format as binary logs\&. The binary log and relay log are discussed further in
Section\ \&5.2.4, \(lqThe Binary Log\(rq, and
Section\ \&16.4.2, \(lqReplication Relay and Status Files\(rq\&.
Section\ \&16.2.2, \(lqReplication Relay and Status Files\(rq\&.
binlog\&.000003\&. Event information includes the statement, the ID of the server on which it was executed, the timestamp when the statement was executed, how much time it took, and so forth\&.
binlog\&.000003\&. For statement\-based logging, event information includes the SQL statement, the ID of the server on which it was executed, the timestamp when the statement was executed, how much time it took, and so forth\&. For row\-based logging, the event indicates a row change rather than an SQL statement\&. See
Section\ \&16.1.2, \(lqReplication Formats\(rq, for information about logging modes\&.
.PP
Events are preceded by header comments that provide additional information\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
# at 141
#100309 9:28:36 server id 123 end_log_pos 245
Query thread_id=3350 exec_time=11 error_code=0
.fi
.if n \{\
.RE
.\}
.PP
In the first line, the number following
at
indicates the starting position of the event in the binary log file\&.
.PP
The second line starts with a date and time indicating when the statement started on the server where the event originated\&. For replication, this timestamp is propagated to slave servers\&.
server id
is the
server_id
value of the server where the event originated\&.
end_log_pos
indicates where the next event starts (that is, it is the end position of the current event + 1)\&.
thread_id
indicates which thread executed the event\&.
exec_time
is the time spent executing the event, on a master server\&. On a slave, it is the difference of the end execution time on the slave minus the beginning execution time on the master\&. The difference serves as an indicator of how much replication lags behind the master\&.
error_code
indicates the result from executing the event\&. Zero means that no error occurred\&.
.PP
The output from
\fBmysqlbinlog\fR
can be re\-executed (for example, by using it as input to
\fBmysql\fR) to reapply the statements in the log\&. This is useful for recovery operations after a server crash\&. For other usage examples, see the discussion later in this section\&.
\fBmysql\fR) to redo the statements in the log\&. This is useful for recovery operations after a server crash\&. For other usage examples, see the discussion later in this section and
Section\ \&6.5, \(lqPoint-in-Time (Incremental) Recovery Using the Binary Log\(rq\&.
.PP
Normally, you use
\fBmysqlbinlog\fR
to read binary log files directly and apply them to the local MySQL server\&. It is also possible to read binary logs from a remote server by using the
\fB\-\-read\-from\-remote\-server\fR
option\&. When you read remote binary logs, the connection parameter options can be given to indicate how to connect to the server\&. These options are
option\&. To read remote binary logs, the connection parameter options can be given to indicate how to connect to the server\&. These options are
\fB\-\-host\fR,
\fB\-\-password\fR,
\fB\-\-port\fR,
...
...
@@ -86,7 +120,13 @@ option\&. When you read remote binary logs, the connection parameter options can
option\&.
.PP
\fBmysqlbinlog\fR
supports the following options\&. It also reads option files and supports the options for processing them described at
supports the following options, which can be specified on the command line or in the
[mysqlbinlog]
and
[client]
option file groups\&.
\fBmysqlbinlog\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -248,7 +288,7 @@ the section called \(lqMYSQLBINLOG ROW EVENT DISPLAY\(rq\&.
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -264,15 +304,140 @@ Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
\fB\-d \fR\fB\fIdb_name\fR\fR
.sp
List entries for just this database (local log only)\&. You can only specify one database with this option \- if you specify multiple
This option causes
\fBmysqlbinlog\fR
to output entries from the binary log (local log only) that occur while
\fIdb_name\fR
is been selected as the default database by
USE\&.
.sp
The
\fB\-\-database\fR
options, only the last one is used\&. This option forces
option for
\fBmysqlbinlog\fR
to output entries from the binary log where the default database (that is, the one selected by
USE) is
\fIdb_name\fR\&. Note that this does not replicate cross\-database statements such as
UPDATE \fIsome_db\&.some_table\fR SET foo=\'bar\'
while having selected a different database or no database\&.
is similar to the
\fB\-\-binlog\-do\-db\fR
option for
\fBmysqld\fR, but can be used to specify only one database\&. If
\fB\-\-database\fR
is given multiple times, only the last instance is used\&.
.sp
The effects of this option depend on whether the statement\-based or row\-based logging format is in use, in the same way that the effects of
\fB\-\-binlog\-do\-db\fR
depend on whether statement\-based or row\-based logging is in use\&.
.PP
\fBStatement-based logging\fR. The
\fB\-\-database\fR
option works as follows:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
While
\fIdb_name\fR
is the default database, statements are output whether they modify tables in
\fIdb_name\fR
or a different database\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Unless
\fIdb_name\fR
is selected as the default database, statements are not output, even if they modify tables in
\fIdb_name\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
There is an exception for
CREATE DATABASE,
ALTER DATABASE, and
DROP DATABASE\&. The database being
\fIcreated, altered, or dropped\fR
is considered to be the default database when determining whether to output the statement\&.
.RE
.RS 4
Suppose that the binary log was created by executing these statements using statement\-based\-logging:
.sp
.if n \{\
.RS 4
.\}
.nf
INSERT INTO test\&.t1 (i) VALUES(100);
INSERT INTO db2\&.t2 (j) VALUES(200);
USE test;
INSERT INTO test\&.t1 (i) VALUES(101);
INSERT INTO t1 (i) VALUES(102);
INSERT INTO db2\&.t2 (j) VALUES(201);
USE db2;
INSERT INTO test\&.t1 (i) VALUES(103);
INSERT INTO db2\&.t2 (j) VALUES(202);
INSERT INTO t2 (j) VALUES(203);
.fi
.if n \{\
.RE
.\}
.sp
\fBmysqlbinlog \-\-database=test\fR
does not output the first two
INSERT
statements because there is no default database\&. It outputs the three
INSERT
statements following
USE test, but not the three
INSERT
statements following
USE db2\&.
.sp
\fBmysqlbinlog \-\-database=db2\fR
does not output the first two
INSERT
statements because there is no default database\&. It does not output the three
INSERT
statements following
USE test, but does output the three
INSERT
statements following
USE db2\&.
.PP
\fBRow-based logging\fR.
\fBmysqlbinlog\fR
outputs only entries that change tables belonging to
\fIdb_name\fR\&. The default database has no effect on this\&. Suppose that the binary log just described was created using row\-based logging rather than statement\-based logging\&.
\fBmysqlbinlog \-\-database=test\fR
outputs only those entries that modify
t1
in the test database, regardless of whether
USE
was issued or what the default database is\&.
If a server is running with
binlog_format
set to
MIXED
and you want it to be possible to use
\fBmysqlbinlog\fR
with the
\fB\-\-database\fR
option, you must ensure that tables that are modified are in the database selected by
USE\&. (In particular, no cross\-database updates should be used\&.)
.if n \{\
.sp
.\}
...
...
@@ -406,7 +571,7 @@ stops if it reads such an event\&.
\fB\-H\fR
.sp
Display a hex dump of the log in comments, as described in
the section called \(lqMYSQLBINLOG HEX DUMP FORMAT\(rq\&. This output can be helpful for replication debugging\&. This option was added in MySQL 5\&.1\&.2\&.
the section called \(lqMYSQLBINLOG HEX DUMP FORMAT\(rq\&. The hex output can be helpful for replication debugging\&. This option was added in MySQL 5\&.1\&.2\&.
.RE
.sp
.RS 4
...
...
@@ -482,10 +647,12 @@ value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqlbinlog\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
.RE
.sp
.RS 4
...
...
@@ -514,12 +681,13 @@ The TCP/IP port number to use for connecting to a remote server\&.
.\}
.\" mysqlbinlog: position option
.\" position option: mysqlbinlog
\fB\-\-position=\fR\fB\fIN\fR\fR,
\fB\-j \fR\fB\fIN\fR\fR
\fB\-\-position=\fR\fB\fIN\fR\fR
.sp
Deprecated\&. Use
\fB\-\-start\-position\fR
instead\&.
\fB\-\-position\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
...
...
@@ -590,7 +758,7 @@ Direct output to the given file\&.
.\" server-id option: mysqlbinlog
\fB\-\-server\-id=\fR\fB\fIid\fR\fR
.sp
Extract only those events created by the server having the given server ID\&. This option is available as of MySQL 5\&.1\&.4\&.
Display only those events created by the server having the given server ID\&. This option is available as of MySQL 5\&.1\&.4\&.
Start reading the binary log at the first event having a position equal to or greater than
\fIN\fR\&. This option applies to the first log file named on the command line\&.
.sp
This option is useful for point\-in\-time recovery\&. See
Section\ \&6.3, \(lqExample Backup and Recovery Strategy\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -715,6 +887,9 @@ argument\&. This option is useful for point\-in\-time recovery\&. See the descri
option for information about the
\fIdatetime\fR
value\&.
.sp
This option is useful for point\-in\-time recovery\&. See
Section\ \&6.3, \(lqExample Backup and Recovery Strategy\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -731,6 +906,9 @@ value\&.
.sp
Stop reading the binary log at the first event having a position equal to or greater than
\fIN\fR\&. This option applies to the last log file named on the command line\&.
.sp
This option is useful for point\-in\-time recovery\&. See
Section\ \&6.3, \(lqExample Backup and Recovery Strategy\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -779,7 +957,7 @@ The MySQL user name to use when connecting to a remote server\&.
\fB\-\-verbose\fR,
\fB\-v\fR
.sp
Reconstruct row events and display them as commented SQL statements\&. If given twice, the output includes comments to indicate column data types and some metadata\&. This option was added in MySQL 5\&.1\&.28\&.
Reconstruct row events and display them as commented SQL statements\&. If this option is given twice, the output includes comments to indicate column data types and some metadata\&. This option was added in MySQL 5\&.1\&.28\&.
.sp
For examples that show the effect of
\fB\-\-base64\-output\fR
...
...
@@ -804,33 +982,6 @@ the section called \(lqMYSQLBINLOG ROW EVENT DISPLAY\(rq\&.
.sp
Display version information and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqlbinlog: write-binlog option
.\" write-binlog option: mysqlbinlog
\fB\-\-write\-binlog\fR
.sp
This option is enabled by default, so that
ANALYZE TABLE,
OPTIMIZE TABLE, and
REPAIR TABLE
statements generated by
\fBmysqlcheck\fR
are written to the binary log\&. Use
\fB\-\-skip\-write\-binlog\fR
to cause
NO_WRITE_TO_BINLOG
to be added to the statements so that they are not logged\&. Use the
\fB\-\-skip\-write\-binlog\fR
when these statements should not be sent to replication slaves or run when using the binary logs for recovery from backup\&. This option was added in MySQL 5\&.1\&.18\&.
client to execute the statements contained in the binary log\&. This is used to recover from a crash when you have an old backup (see
Section\ \&6.1, \(lqDatabase Backup Methods\(rq)\&. For example:
client to execute the events contained in the binary log\&. This technique is used to recover from a crash when you have an old backup (see
Section\ \&6.5, \(lqPoint-in-Time (Incremental) Recovery Using the Binary Log\(rq)\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBmysqlbinlog binlog\&.000001 | mysql\fR
shell> \fBmysqlbinlog binlog\&.000001 | mysql \-u root \-p\fR
.fi
.if n \{\
.RE
...
...
@@ -873,7 +1024,7 @@ Or:
.RS 4
.\}
.nf
shell> \fBmysqlbinlog binlog\&.[0\-9]* | mysql\fR
shell> \fBmysqlbinlog binlog\&.[0\-9]* | mysql \-u root \-p\fR
.fi
.if n \{\
.RE
...
...
@@ -883,12 +1034,25 @@ You can also redirect the output of
\fBmysqlbinlog\fR
to a text file instead, if you need to modify the statement log first (for example, to remove statements that you do not want to execute for some reason)\&. After editing the file, execute the statements that it contains by using it as input to the
option, which prints only those statements with an offset in the binary log greater than or equal to a given position (the given position must match the start of one event)\&. It also has options to stop and start when it sees an event with a given date and time\&. This enables you to perform point\-in\-time recovery using the
option, it displays only those events with an offset in the binary log greater than or equal to a given position (the given position must match the start of one event)\&. It also has options to stop and start when it sees an event with a given date and time\&. This enables you to perform point\-in\-time recovery using the
\fB\-\-stop\-datetime\fR
option (to be able to say, for example,
\(lqroll forward my databases to how they were today at 10:30 a\&.m\&.\(rq)\&.
...
...
@@ -900,8 +1064,8 @@ If you have more than one binary log to execute on the MySQL server, the safe me
.RS 4
.\}
.nf
shell> \fBmysqlbinlog binlog\&.000001 | mysql # DANGER!!\fR
shell> \fBmysqlbinlog binlog\&.000002 | mysql # DANGER!!\fR
shell> \fBmysqlbinlog binlog\&.000001 | mysql \-u root \-p # DANGER!!\fR
shell> \fBmysqlbinlog binlog\&.000002 | mysql \-u root \-p # DANGER!!\fR
.fi
.if n \{\
.RE
...
...
@@ -918,13 +1082,14 @@ process attempts to use the table, the server reports
.PP
To avoid problems like this, use a
\fIsingle\fR
connection to execute the contents of all binary logs that you want to process\&. Here is one way to do so:
\fBmysql\fR
process to execute the contents of all binary logs that you want to process\&. Here is one way to do so:
LOCAL), both the client and the server that you use to process the statements must be configured to allow
LOCAL), both the client and the server that you use to process the statements must be configured with the
LOCAL
capability\&. See
Section\ \&5.3.4, \(lqSecurity Issues with LOAD DATA LOCAL\(rq\&.
capability enabled\&. See
Section\ \&5.3.5, \(lqSecurity Issues with LOAD DATA LOCAL\(rq\&.
.if n \{\
.sp
.\}
...
...
@@ -991,7 +1156,9 @@ automatically deleted because they are needed until you actually execute those s
.PP
The
\fB\-\-hexdump\fR
option produces a hex dump of the log contents:
option causes
\fBmysqlbinlog\fR
to produce a hex dump of the binary log contents:
.sp
.if n \{\
.RS 4
...
...
@@ -1029,7 +1196,8 @@ ROLLBACK;
.RE
.\}
.PP
Hex dump output currently contains the following elements\&. This format is subject to change\&.
Hex dump output currently contains the elements in the following list\&. This format is subject to change\&. (For more information about binary log format, see
@@ -1796,7 +1964,7 @@ option can be used to prevent this header from being written\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
...
...
@@ -1808,7 +1976,7 @@ You should have received a copy of the GNU General Public License along with the
.IP " 1." 4
Bug#42941
.RS 4
\%http://bugs.mysql.com/42941
\%http://bugs.mysql.com/bug.php?id=42941
.RE
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
This program enables you to generate a bug report and send it to Sun Microsystems, Inc\&. It is a shell script and runs on Unix\&.
This program enables you to generate a bug report and send it to Oracle Corporation\&. It is a shell script and runs on Unix\&.
.PP
The normal way to report bugs is to visit
\m[blue]\fB\%http://bugs.mysql.com/\fR\m[], which is the address for our bugs database\&. This database is public and can be browsed and searched by anyone\&. If you log in to the system, you can enter new reports\&. If you have no Web access, you can generate a bug report by using the
...
...
@@ -62,7 +62,7 @@ will send the report by email\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -37,7 +37,7 @@ client performs table maintenance: It checks, repairs, optimizes, or analyzes ta
Each table is locked and therefore unavailable to other sessions while it is being processed, although for check operations, the table is locked with a
READ
lock only (see
Section\ \&12.4.5, \(lqLOCK TABLES and UNLOCK TABLES Syntax\(rq, for more information about
Section\ \&12.3.5, \(lqLOCK TABLES and UNLOCK TABLES Syntax\(rq, for more information about
READ
and
WRITE
...
...
@@ -72,7 +72,7 @@ REPAIR TABLE,
ANALYZE TABLE, and
OPTIMIZE TABLE
in a convenient way for the user\&. It determines which statements to use for the operation you want to perform, and then sends the statements to the server to be executed\&. For details about which storage engines each statement works with, see the descriptions for those statements in
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
supports the following options, which can be specified on the command line or in the
[mysqlcheck]
and
[client]
option file groups\&.
\fBmysqlcheck\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -285,7 +291,7 @@ If a checked table is corrupted, automatically fix it\&. Any necessary repairs a
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -444,7 +450,7 @@ Print debugging information and memory and CPU usage statistics when the program
Use
\fIcharset_name\fR
as the default character set\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -598,10 +604,12 @@ value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqlcheck\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
On Windows, connect to the server via a named pipe\&. This option applies only for connections to a local server, and only if the server supports named\-pipe connections\&.
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
.RE
.sp
.RS 4
...
...
@@ -734,7 +742,7 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
@@ -824,10 +832,37 @@ Verbose mode\&. Print information about the various stages of program operation\
.sp
Display version information and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqlcheck: write-binlog option
.\" write-binlog option: mysqlcheck
\fB\-\-write\-binlog\fR
.sp
This option is enabled by default, so that
ANALYZE TABLE,
OPTIMIZE TABLE, and
REPAIR TABLE
statements generated by
\fBmysqlcheck\fR
are written to the binary log\&. Use
\fB\-\-skip\-write\-binlog\fR
to cause
NO_WRITE_TO_BINLOG
to be added to the statements so that they are not logged\&. Use the
\fB\-\-skip\-write\-binlog\fR
when these statements should not be sent to replication slaves or run when using the binary logs for recovery from backup\&. This option was added in MySQL 5\&.1\&.18\&.
.RE
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -53,7 +53,7 @@ Chapter\ \&2, Installing and Upgrading MySQL\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -69,36 +69,70 @@ option, entire databases are dumped\&.
\fBmysqldump\fR
does not dump the
INFORMATION_SCHEMA
database\&. If you name that database explicitly on the command line,
database by default\&. As of MySQL 5\&.1\&.38,
\fBmysqldump\fR
silently ignores it\&.
dumps
INFORMATION_SCHEMA
if you name it explicitly on the command line, although currently you must also use the
\fB\-\-skip\-lock\-tables\fR
option\&. Before 5\&.1\&.38,
\fBmysqldump\fR
silently ignores
INFORMATION_SCHEMA
even if you name it explicitly on the command line\&.
.PP
To get a list of the options your version of
To see a list of the options your version of
\fBmysqldump\fR
supports, execute
\fBmysqldump \-\-help\fR\&.
.PP
Some
\fBmysqldump\fR
options are shorthand for groups of other options\&.
\fB\-\-opt\fR
and
\fB\-\-compact\fR
fall into this category\&. For example, use of
options are shorthand for groups of other options:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use of
\fB\-\-opt\fR
is the same as specifying
\fB\-\-add\-drop\-table\fR
\fB\-\-add\-locks\fR
\fB\-\-create\-options\fR
\fB\-\-disable\-keys\fR
\fB\-\-extended\-insert\fR
\fB\-\-lock\-tables\fR
\fB\-\-quick\fR
\fB\-\-set\-charset\fR\&. Note that all of the options that
\fB\-\-add\-drop\-table\fR,
\fB\-\-add\-locks\fR,
\fB\-\-create\-options\fR,
\fB\-\-disable\-keys\fR,
\fB\-\-extended\-insert\fR,
\fB\-\-lock\-tables\fR,
\fB\-\-quick\fR, and
\fB\-\-set\-charset\fR\&. All of the options that
\fB\-\-opt\fR
stands for also are on by default because
\fB\-\-opt\fR
is on by default\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use of
\fB\-\-compact\fR
is the same as specifying
\fB\-\-skip\-add\-drop\-table\fR,
\fB\-\-skip\-add\-locks\fR,
\fB\-\-skip\-comments\fR,
\fB\-\-skip\-disable\-keys\fR, and
\fB\-\-skip\-set\-charset\fR
options\&.
.RE
.PP
To reverse the effect of a group option, uses its
\fB\-\-skip\-\fR\fB\fIxxx\fR\fR
...
...
@@ -118,10 +152,10 @@ To select the effect of
\fB\-\-opt\fR
except for some features, use the
\fB\-\-skip\fR
option for each feature\&. For example, to disable extended inserts and memory buffering, use
option for each feature\&. To disable extended inserts and memory buffering, use
\fB\-\-opt\fR
\fB\-\-skip\-extended\-insert\fR
\fB\-\-skip\-quick\fR\&. (As of MySQL 5\&.1,
\fB\-\-skip\-quick\fR\&. (Actually,
\fB\-\-skip\-extended\-insert\fR
\fB\-\-skip\-quick\fR
is sufficient because
...
...
@@ -161,7 +195,7 @@ option (or
\fB\-\-quick\fR)\&. The
\fB\-\-opt\fR
option (and hence
\fB\-\-quick\fR) is enabled by default in MySQL 5\&.1; to enable memory buffering, use
\fB\-\-quick\fR) is enabled by default, so to enable memory buffering, use
\fB\-\-skip\-quick\fR\&.
.PP
If you are using a recent version of
...
...
@@ -187,12 +221,18 @@ instead\&.
.br
.PP
\fBmysqldump\fR
from the MySQL 5\&.1\&.21 distribution cannot be used to create dumps from MySQL server versions 5\&.1\&.20 and older\&. This issue is fixed in MySQL 5\&.1\&.22\&. (\m[blue]\fBBug#30123\fR\m[]\&\s-2\u[1]\d\s+2)
from MySQL 5\&.1\&.21 cannot be used to create dumps from MySQL server 5\&.1\&.20 and older\&. This issue is fixed in MySQL 5\&.1\&.22\&. (\m[blue]\fBBug#30123\fR\m[]\&\s-2\u[1]\d\s+2)
.sp .5v
.RE
.PP
\fBmysqldump\fR
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
supports the following options, which can be specified on the command line or in the
[mysqldump]
and
[client]
option file groups\&.
\fBmysqldump\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -227,7 +267,13 @@ Add a
DROP DATABASE
statement before each
CREATE DATABASE
statement\&.
statement\&. This option is typically used in conjunction with the
\fB\-\-all\-databases\fR
or
\fB\-\-databases\fR
option because no
CREATE DATABASE
statements are written unless one of those options is specified\&.
.RE
.sp
.RS 4
...
...
@@ -336,7 +382,7 @@ Allow creation of column names that are keywords\&. This works by prefixing each
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -368,7 +414,7 @@ Write additional information in the dump file such as program version, server ve
.\" compact option: mysqldump
\fB\-\-compact\fR
.sp
Produce less verbose output\&. This option enables the
Produce more compact output\&. This option enables the
\fB\-\-skip\-add\-drop\-table\fR,
\fB\-\-skip\-add\-locks\fR,
\fB\-\-skip\-comments\fR,
...
...
@@ -387,7 +433,7 @@ options\&.
\fBNote\fR
.ps -1
.br
Prior to release 5\&.1\&.21, this option did not create valid SQL if the database dump contained views\&. The recreation of views requires the creation and removal of temporary tables and this option suppressed the removal of those temporary tables\&. As a workaround, use
Prior to MySQL 5\&.1\&.21, this option did not create valid SQL if the database dump contained views\&. The recreation of views requires the creation and removal of temporary tables and this option suppressed the removal of those temporary tables\&. As a workaround, use
\fB\-\-compact\fR
with the
\fB\-\-add\-drop\-table\fR
...
...
@@ -409,7 +455,7 @@ option and then manually adjust the dump file\&.
\fB\-\-compatible=\fR\fB\fIname\fR\fR
.sp
Produce output that is more compatible with other database systems or with older MySQL servers\&. The value of
name
\fIname\fR
can be
ansi,
mysql323,
...
...
@@ -569,7 +615,7 @@ Print debugging information and memory and CPU usage statistics when the program
Use
\fIcharset_name\fR
as the default character set\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&. If no character set is specified,
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&. If no character set is specified,
\fBmysqldump\fR
uses
utf8, and earlier versions use
...
...
@@ -611,7 +657,9 @@ statements\&.
.\" delete-master-logs option: mysqldump
\fB\-\-delete\-master\-logs\fR
.sp
On a master replication server, delete the binary logs after performing the dump operation\&. This option automatically enables
On a master replication server, delete the binary logs by sending a
PURGE BINARY LOGS
statement to the server after performing the dump operation\&. This option automatically enables
\fB\-\-master\-data\fR\&.
.RE
.sp
...
...
@@ -651,12 +699,23 @@ tables\&.
.\" dump-date option: mysqldump
\fB\-\-dump\-date\fR
.sp
If the
\fB\-\-comments\fR
option is given,
\fBmysqldump\fR
produces a
produces a comment at the end of the dump of the following form:
.sp
.if n \{\
.RS 4
.\}
.nf
\-\- Dump completed on \fIDATE\fR
comment at the end of the dump if the
\fB\-\-comments\fR
option is given\&. However, the date causes dump files for identical data take at different times to appear to be different\&.
.fi
.if n \{\
.RE
.\}
.sp
However, the date causes dump files taken at different times to appear to be different, even if the data are otherwise identical\&.
\fB\-\-dump\-date\fR
and
\fB\-\-skip\-dump\-date\fR
...
...
@@ -680,7 +739,7 @@ suppresses date printing\&. This option was added in MySQL 5\&.1\&.23\&.
\fB\-\-events\fR,
\fB\-E\fR
.sp
Dump events from the dumped databases\&. This option was added in MySQL 5\&.1\&.8\&.
Include Event Scheduler events for the dumped databases in the output\&. This option was added in MySQL 5\&.1\&.8\&.
.RE
.sp
.RS 4
...
...
@@ -725,8 +784,10 @@ lists\&. This results in a smaller dump file and speeds up inserts when the file
\fB\-\-fields\-escaped\-by=\&.\&.\&.\fR
.sp
These options are used with the
\fB\-T\fR
option and have the same meaning as the corresponding clauses for
\fB\-\-tab\fR
option and have the same meaning as the corresponding
FIELDS
clauses for
LOAD DATA INFILE\&. See
Section\ \&12.2.6, \(lqLOAD DATA INFILE Syntax\(rq\&.
.RE
...
...
@@ -741,11 +802,13 @@ Section\ \&12.2.6, \(lqLOAD DATA INFILE Syntax\(rq\&.
.\}
.\" mysqldump: first-slave option
.\" first-slave option: mysqldump
\fB\-\-first\-slave\fR,
\fB\-x\fR
\fB\-\-first\-slave\fR
.sp
Deprecated\&. Now renamed to
\fB\-\-lock\-all\-tables\fR\&.
Deprecated\&. Use
\fB\-\-lock\-all\-tables\fR
instead\&.
\fB\-\-first\-slave\fR
is removed in MySQL 5\&.5\&.
.RE
.sp
.RS 4
...
...
@@ -763,10 +826,9 @@ Deprecated\&. Now renamed to
.sp
Flush the MySQL server log files before starting the dump\&. This option requires the
RELOAD
privilege\&. Note that if you use this option in combination with the
privilege\&. If you use this option in combination with the
\fB\-\-all\-databases\fR
(or
\fB\-A\fR) option, the logs are flushed
option, the logs are flushed
\fIfor each database dumped\fR\&. The exception is when using
\fB\-\-lock\-all\-tables\fR
or
...
...
@@ -790,9 +852,9 @@ or
.\" flush-privileges option: mysqldump
\fB\-\-flush\-privileges\fR
.sp
Emit a
Send a
FLUSH PRIVILEGES
statement after dumping the
statement to the server after dumping the
mysql
database\&. This option should be used any time the dump contains the
mysql
...
...
@@ -861,8 +923,9 @@ Dump binary columns using hexadecimal notation (for example,
becomes
0x616263)\&. The affected data types are
BINARY,
VARBINARY,
BLOB, and
VARBINARY, the
BLOB
types, and
BIT\&.
.RE
.sp
...
...
@@ -894,10 +957,10 @@ Do not dump the given table, which must be specified using both the database and
\fB\-\-insert\-ignore\fR
.sp
Write
INSERT IGNORE
statements rather than
INSERT
statements with the
IGNORE
option\&.
statements\&.
.RE
.sp
.RS 4
...
...
@@ -913,8 +976,10 @@ option\&.
\fB\-\-lines\-terminated\-by=\&.\&.\&.\fR
.sp
This option is used with the
\fB\-T\fR
option and has the same meaning as the corresponding clause for
\fB\-\-tab\fR
option and has the same meaning as the corresponding
LINES
clause for
LOAD DATA INFILE\&. See
Section\ \&12.2.6, \(lqLOAD DATA INFILE Syntax\(rq\&.
.RE
...
...
@@ -951,18 +1016,20 @@ and
\fB\-\-lock\-tables\fR,
\fB\-l\fR
.sp
Lock all tables before dumping them\&. The tables are locked with
For each dumped database, lock all tables to be dumped before dumping them\&. The tables are locked with
READ LOCAL
to allow concurrent inserts in the case of
MyISAM
tables\&. For transactional tables such as
InnoDB,
\fB\-\-single\-transaction\fR
is a much better option, because it does not need to lock the tables at all\&.
is a much better option than
\fB\-\-lock\-tables\fR
because it does not need to lock the tables at all\&.
.sp
Please note that when dumping multiple databases,
Because
\fB\-\-lock\-tables\fR
locks tables for each database separately\&. Therefore, this option does not guarantee that the tables in the dump file are logically consistent between databases\&. Tables in different databases may be dumped in completely different states\&.
locks tables for each database separately, this option does not guarantee that the tables in the dump file are logically consistent between databases\&. Tables in different databases may be dumped in completely different states\&.
.RE
.sp
.RS 4
...
...
@@ -977,7 +1044,7 @@ locks tables for each database separately\&. Therefore, this option does not gua
.\" log-error option: mysqldump
\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR
.sp
Append warnings and errors to the named file\&. This option was added in MySQL 5\&.1\&.18\&.
Log warnings and errors by appending them to the named file\&. The default is to do no logging\&. This option was added in MySQL 5\&.1\&.18\&.
.RE
.sp
.RS 4
...
...
@@ -994,11 +1061,11 @@ Append warnings and errors to the named file\&. This option was added in MySQL 5
.sp
Use this option to dump a master replication server to produce a dump file that can be used to set up another server as a slave of the master\&. It causes the dump output to include a
CHANGE MASTER TO
statement that indicates the binary log coordinates (file name and position) of the dumped server\&. These are the master server coordinates from which the slave should start replicating\&.
statement that indicates the binary log coordinates (file name and position) of the dumped server\&. These are the master server coordinates from which the slave should start replicating after you load the dump file into the slave\&.
.sp
If the option value is 2, the
CHANGE MASTER TO
statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded\&. If the option value is 1, the statement takes effect when the dump file is reloaded\&. If the option value is not specified, the default value is 1\&.
statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded\&. If the option value is 1, the statement is not written as a comment and takes effect when the dump file is reloaded\&. If no option value is specified, the default value is 1\&.
From the output of the SHOW SLAVE STATUS statement, get the binary log coordinates of the master server from which the new slave should start replicating\&. These coordinates are the values of the Relay_Master_Log_File and Exec_Master_Log_Pos values\&. Denote those values as file_name and file_pos\&.
From the output of the
SHOW SLAVE STATUS
statement, the binary log coordinates of the master server from which the new slave should start replicating are the values of the
Relay_Master_Log_File
and
Exec_Master_Log_Pos
fields\&. Denote those values as
\fIfile_name\fR
and
\fIfile_pos\fR\&.
.RE
.sp
.RS 4
...
...
@@ -1098,7 +1174,7 @@ mysql> \fBSTART SLAVE;\fR
.sp -1
.IP " 5." 4.2
.\}
On the new slave, reload the dump file:
On the new slave, load the dump file:
.sp
.if n \{\
.RS 4
...
...
@@ -1126,7 +1202,7 @@ On the new slave, set the replication coordinates to those of the master server
@@ -1214,9 +1290,9 @@ statements that re\-create each dumped table\&.
\fB\-\-no\-data\fR,
\fB\-d\fR
.sp
Do not write any table row information (that is, do not dump table contents)\&. This is very useful if you want to dump only the
Do not write any table row information (that is, do not dump table contents)\&. This is useful if you want to dump only the
CREATE TABLE
statement for the table\&.
statement for the table (for example, to create an empty copy of the table by loading the dump file)\&.
.RE
.sp
.RS 4
...
...
@@ -1229,11 +1305,11 @@ statement for the table\&.
.\}
.\" mysqldump: no-set-names option
.\" no-set-names option: mysqldump
\fB\-\-no\-set\-names\fR
\fB\-\-no\-set\-names\fR,
\fB\-N\fR
.sp
This option is deprecated\&. Use
\fB\-\-skip\-set\-charset\fR
instead\&.
This has the same effect as
\fB\-\-skip\-set\-charset\fR\&.
.RE
.sp
.RS 4
...
...
@@ -1248,7 +1324,7 @@ instead\&.
.\" opt option: mysqldump
\fB\-\-opt\fR
.sp
This option is shorthand; it is the same as specifying
This option is shorthand\&. It is the same as specifying
\fB\-\-add\-drop\-table\fR
\fB\-\-add\-locks\fR
\fB\-\-create\-options\fR
...
...
@@ -1259,7 +1335,7 @@ This option is shorthand; it is the same as specifying
\fB\-\-set\-charset\fR\&. It should give you a fast dump operation and produce a dump file that can be reloaded into a MySQL server quickly\&.
.sp
\fIThe \fR\fI\fB\-\-opt\fR\fR\fI option is enabled by default\&. Use \fR\fI\fB\-\-skip\-opt\fR\fR\fI to disable it\&.\fR
See the discussion at the beginning of this section for information about selectively enabling or disabling certain of the options affected by
See the discussion at the beginning of this section for information about selectively enabling or disabling a subset of the options affected by
\fB\-\-opt\fR\&.
.RE
.sp
...
...
@@ -1275,11 +1351,11 @@ See the discussion at the beginning of this section for information about select
.\" order-by-primary option: mysqldump
\fB\-\-order\-by\-primary\fR
.sp
Sort each table\'s rows by its primary key, or by its first unique index, if such an index exists\&. This is useful when dumping a
Dump each table\'s rows sorted by its primary key, or by its first unique index, if such an index exists\&. This is useful when dumping a
MyISAM
table to be loaded into an
InnoDB
table, but will make the dump itself take considerably longer\&.
table, but will make the dump operation take considerably longer\&.
.RE
.sp
.RS 4
...
...
@@ -1303,10 +1379,12 @@ value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqldump\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
On Windows, connect to the server via a named pipe\&. This option applies only for connections to a local server, and only if the server supports named\-pipe connections\&.
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
.RE
.sp
.RS 4
...
...
@@ -1388,11 +1466,11 @@ to retrieve rows for a table from the server a row at a time rather than retriev
\fB\-\-quote\-names\fR,
\fB\-Q\fR
.sp
Quote database, table, and column names within
Quote identifiers (such as database, table, and column names) within
\(lq`\(rq
characters\&. If the
ANSI_QUOTES
SQL mode is enabled, names are quoted within
SQL mode is enabled, identifiers are quoted within
\(lq"\(rq
characters\&. This option is enabled by default\&. It can be disabled with
\fB\-\-skip\-quote\-names\fR, but this option should be given after any option such as
...
...
@@ -1417,7 +1495,7 @@ Write
REPLACE
statements rather than
INSERT
statements\&. Available as of MySQL 5\&.1\&.3\&.
statements\&. This option was added in MySQL 5\&.1\&.3\&.
.RE
.sp
.RS 4
...
...
@@ -1437,7 +1515,7 @@ Direct output to a given file\&. This option should be used on Windows to preven
\(lq\en\(rq
characters from being converted to
\(lq\er\en\(rq
carriage return/newline sequences\&. The result file is created and its contents overwritten, even if an error occurs while generating the dump\&. The previous contents are lost\&.
carriage return/newline sequences\&. The result file is created and its previous contents overwritten, even if an error occurs while generating the dump\&.
.RE
.sp
.RS 4
...
...
@@ -1453,7 +1531,7 @@ carriage return/newline sequences\&. The result file is created and its contents
\fB\-\-routines\fR,
\fB\-R\fR
.sp
Dump stored routines (procedures and functions) from the dumped databases\&. Use of this option requires the
Included stored routines (procedures and functions) for the dumped databases in the output\&. Use of this option requires the
SELECT
privilege for the
mysql\&.proc
...
...
@@ -1511,9 +1589,9 @@ statement, use
.\" single-transaction option: mysqldump
\fB\-\-single\-transaction\fR
.sp
This option issues a
BEGIN
SQL statement before dumping data from the server\&. It is useful only with transactional tables such as
This option sends a
START TRANSACTION
SQL statement to the server before dumping data\&. It is useful only with transactional tables such as
InnoDB, because then it dumps the consistent state of the database at the time when
BEGIN
was issued without blocking any applications\&.
...
...
@@ -1528,16 +1606,25 @@ tables dumped while using this option may still change state\&.
.sp
While a
\fB\-\-single\-transaction\fR
dump is in process, to ensure a valid dump file (correct table contents and binary log position), no other connection should use the following statements:
dump is in process, to ensure a valid dump file (correct table contents and binary log coordinates), no other connection should use the following statements:
ALTER TABLE,
CREATE TABLE,
DROP TABLE,
RENAME TABLE,
TRUNCATE TABLE\&. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the
SELECT
performed by
that is performed by
\fBmysqldump\fR
to retrieve the table contents to obtain incorrect contents or fail\&.
.sp
The
\fB\-\-single\-transaction\fR
option and the
\fB\-\-lock\-tables\fR
option are mutually exclusive because
LOCK TABLES
causes any pending transactions to be committed implicitly\&.
.sp
This option is not supported for MySQL Cluster tables; the results cannot be guaranteed to be consistent due to the fact that the
NDBCLUSTER
storage engine supports only the
...
...
@@ -1546,15 +1633,9 @@ transaction isolation level\&. You should always use
NDB
backup and restore instead\&.
.sp
The
To dump large tables, you should combine the
\fB\-\-single\-transaction\fR
option and the
\fB\-\-lock\-tables\fR
option are mutually exclusive, because
LOCK TABLES
causes any pending transactions to be committed implicitly\&.
.sp
To dump large tables, you should combine this option with
option with
\fB\-\-quick\fR\&.
.RE
.sp
...
...
@@ -1624,7 +1705,7 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
Produce tab\-separated data files\&. For each dumped table,
Produce tab\-separated text\-format data files\&. For each dumped table,
\fBmysqldump\fR
creates a
\fItbl_name\fR\&.sql
file that contains the
CREATE TABLE
statement that creates the table, and a
statement that creates the table, and the server writes a
\fItbl_name\fR\&.txt
file that contains its data\&. The option value is the directory in which to write the files\&.
.sp
By default, the
\&.txt
data files are formatted using tab characters between column values and a newline at the end of each line\&. The format can be specified explicitly using the
\fB\-\-fields\-\fR\fB\fIxxx\fR\fR
and
\fB\-\-lines\-terminated\-by\fR
options\&.
.sp
As of MySQL 5\&.1\&.38, column values are written converted to the character set specified by the
\fB\-\-default\-character\-set\fR
option\&. Prior to 5\&.1\&.38 or if no such option is present, values are dumped using the
binary
character set\&. In effect, there is no character set conversion\&. If a table contains columns in several character sets, the output data file will as well and you may not be able to reload the file correctly\&.
.if n \{\
.sp
.\}
...
...
@@ -1684,6 +1751,19 @@ FILE
privilege, and the server must have permission to write files in the directory that you specify\&.
.sp .5v
.RE
By default, the
\&.txt
data files are formatted using tab characters between column values and a newline at the end of each line\&. The format can be specified explicitly using the
\fB\-\-fields\-\fR\fB\fIxxx\fR\fR
and
\fB\-\-lines\-terminated\-by\fR
options\&.
.sp
As of MySQL 5\&.1\&.38, column values are converted to the character set specified by the
\fB\-\-default\-character\-set\fR
option\&. Prior to 5\&.1\&.38 or if no such option is present, values are dumped using the
binary
character set\&. In effect, there is no character set conversion\&. If a table contains columns in several character sets, the output data file will as well and you may not be able to reload the file correctly\&.
.RE
.sp
.RS 4
...
...
@@ -1719,7 +1799,7 @@ regards all name arguments following the option as table names\&.
.\" triggers option: mysqldump
\fB\-\-triggers\fR
.sp
Dump triggers for each dumped table\&. This option is enabled by default; disable it with
Include triggers for each dumped table in the output\&. This option is enabled by default; disable it with
\fB\-\-skip\-triggers\fR\&.
.RE
.sp
...
...
@@ -1743,7 +1823,7 @@ sets its connection time zone to UTC and adds
SET TIME_ZONE=\'+00:00\'
to the dump file\&. Without this option,
TIMESTAMP
columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change\&.
columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change if the servers are in different time zones\&.
\fB\-\-tz\-utc\fR
also protects against changes due to daylight saving time\&.
\fB\-\-tz\-utc\fR
...
...
@@ -1846,7 +1926,7 @@ Examples:
.sp
Write dump output as well\-formed XML\&.
.sp
\fBNULL\fR\fB, \fR\fB\'NULL\'\fR\fB, and Empty Values\fR: For some column named
\fBNULL\fR\fB, \fR\fB\'NULL\'\fR\fB, and Empty Values\fR: For a column named
\fIcolumn_name\fR, the
NULL
value, an empty string, and the string value
...
...
@@ -1884,7 +1964,7 @@ Beginning with MySQL 5\&.1\&.12, the output from the
This backup acquires a global read lock on all tables (using
FLUSH TABLES WITH READ LOCK) 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 long updating statements are running when the
FLUSH
statement is issued, the MySQL server may get stalled until those statements finish\&. After that, the dump becomes lock\-free and does not disturb reads and writes on the tables\&. 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\&.
statement is issued, the MySQL server may get stalled until those statements finish\&. After that, the dump becomes lockfree and does not disturb reads and writes on the tables\&. 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\&.
.PP
For point\-in\-time recovery (also known as
\(lqroll\-forward,\(rq
...
...
@@ -2106,13 +2191,13 @@ The
\fB\-\-master\-data\fR
and
\fB\-\-single\-transaction\fR
options can be used simultaneously, which provides a convenient way to make an online backup suitable for point\-in\-time recovery if tables are stored using the
options can be used simultaneously, which provides a convenient way to make an online backup suitable for use prior to point\-in\-time recovery if tables are stored using the
InnoDB
storage engine\&.
.PP
For more information on making backups, see
Section\ \&6.1, \(lqDatabase Backup Methods\(rq, and
Section\ \&6.2, \(lqExample Backup and Recovery Strategy\(rq\&.
Section\ \&6.2, \(lqDatabase Backup Methods\(rq, and
Section\ \&6.3, \(lqExample Backup and Recovery Strategy\(rq\&.
.\" mysqldump: views
.\" mysqldump: problems
.\" mysqldump: workarounds
...
...
@@ -2122,7 +2207,7 @@ Section\ \&D.4, \(lqRestrictions on Views\(rq\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
...
...
@@ -2134,7 +2219,7 @@ You should have received a copy of the GNU General Public License along with the
.IP " 1." 4
Bug#30123
.RS 4
\%http://bugs.mysql.com/30123
\%http://bugs.mysql.com/bug.php?id=30123
.RE
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -32,18 +32,28 @@ mysqlhotcopy \- a database backup program
.PP
\fBmysqlhotcopy\fR
is a Perl script that was originally written and contributed by Tim Bunce\&. It uses
LOCK TABLES,
FLUSH TABLES, and
FLUSH TABLES,
LOCK TABLES, and
cp
or
scp
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\&.
to make a database backup\&. It is a fast 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\&.
\fBmysqlhotcopy\fR
works only for backing up
MyISAM
and
ARCHIVE
tables\&. It runs on Unix and NetWare\&.
.PP
To use
\fBmysqlhotcopy\fR, you must have read access to the files for the tables that you are backing up, the
supports the following options, which can be specified on the command line or in the
[mysqlhotcopy]
and
[client]
option file groups\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -275,7 +289,8 @@ Do not delete previous (renamed) target when done\&.
.sp
The method for copying files (cp
or
scp)\&.
scp)\&. The default is
cp\&.
.RE
.sp
.RS 4
...
...
@@ -290,7 +305,9 @@ scp)\&.
.\" noindices option: mysqlhotcopy
\fB\-\-noindices\fR
.sp
Do not include full index files in the backup\&. This makes the backup smaller and faster\&. The indexes for reloaded tables can be reconstructed later with
Do not include full index files for
MyISAM
tables in the backup\&. This makes the backup smaller and faster\&. The indexes for reloaded tables can be reconstructed later with
\fBmyisamchk \-rq\fR\&.
.RE
.sp
...
...
@@ -307,10 +324,10 @@ Do not include full index files in the backup\&. This makes the backup smaller a
\fB\-\-password=\fR\fB\fIpassword\fR\fR,
\fB\-p\fR\fB\fIpassword\fR\fR
.sp
The password to use when connecting to the server\&. Note that the password value is not optional for this option, unlike for other MySQL programs\&. You can use an option file to avoid giving the password on the command line\&.
The password to use when connecting to the server\&. The password value is not optional for this option, unlike for other MySQL programs\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
.RE
.sp
.RS 4
...
...
@@ -423,7 +440,8 @@ file after locking all the tables\&.
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
\fB\-S \fR\fB\fIpath\fR\fR
.sp
The Unix socket file to use for the connection\&.
The Unix socket file to use for connections to
localhost\&.
.RE
.sp
.RS 4
...
...
@@ -438,7 +456,7 @@ The Unix socket file to use for the connection\&.
.\" suffix option: mysqlhotcopy
\fB\-\-suffix=\fR\fB\fIstr\fR\fR
.sp
The suffix for names of copied databases\&.
The suffix to use for names of copied databases\&.
.RE
.sp
.RS 4
...
...
@@ -473,23 +491,6 @@ The temporary directory\&. The default is
The MySQL user name to use when connecting to the server\&.
.RE
.PP
\fBmysqlhotcopy\fR
reads the
[client]
and
[mysqlhotcopy]
option groups from option files\&.
.PP
To execute
\fBmysqlhotcopy\fR, you must have access to the files for the tables that you are backing up, the
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
For additional information about
\fBmysqldump\fR, see
Section\ \&6.4, \(lqUsing mysqldump for Backups\(rq\&.
.PP
\fBmysqldump\fR
supports the following options, which can be specified on the command line or in the
[mysqldump]
and
[client]
option file groups\&.
\fBmysqldump\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -97,7 +107,7 @@ Display a help message and exit\&.
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -197,7 +207,7 @@ Print debugging information and memory and CPU usage statistics when the program
Use
\fIcharset_name\fR
as the default character set\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -379,8 +389,9 @@ tables for writing before processing any text files\&. This ensures that all tab
.sp
Use
LOW_PRIORITY
when loading the table\&. This affects only storage engines that use only table\-level locking (MyISAM,
MEMORY,
when loading the table\&. This affects only storage engines that use only table\-level locking (such as
MyISAM,
MEMORY, and
MERGE)\&.
.RE
.sp
...
...
@@ -405,10 +416,12 @@ value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqlimport\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
On Windows, connect to the server via a named pipe\&. This option applies only for connections to a local server, and only if the server supports named\-pipe connections\&.
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
.RE
.sp
.RS 4
...
...
@@ -529,7 +542,7 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -39,7 +39,7 @@ client can be used to quickly see which databases exist, their tables, or a tabl
provides a command\-line interface to several SQL
SHOW
statements\&. See
Section\ \&12.5.5, \(lqSHOW Syntax\(rq\&. The same information can be obtained by using those statements directly\&. For example, you can issue them from the
Section\ \&12.4.5, \(lqSHOW Syntax\(rq\&. The same information can be obtained by using those statements directly\&. For example, you can issue them from the
\fBmysql\fR
client program\&.
.PP
...
...
@@ -112,7 +112,13 @@ shows you only the table names that match the pattern\&. This is easily fixed by
last on the command line as a separate argument\&.
.PP
\fBmysqlshow\fR
supports the options in the following list\&. It also reads option files and supports the options for processing them described at
supports the following options, which can be specified on the command line or in the
[mysqlshow]
and
[client]
option file groups\&.
\fBmysqlshow\fR
also supports the options for processing option files described at
Section\ \&4.2.3.3.1, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
.sp
.RS 4
...
...
@@ -144,7 +150,7 @@ Display a help message and exit\&.
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -244,7 +250,7 @@ Print debugging information and memory and CPU usage statistics when the program
Use
\fIcharset_name\fR
as the default character set\&. See
Section\ \&9.2, \(lqThe Character Set Used for Data and Sorting\(rq\&.
Section\ \&9.5, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
...
...
@@ -300,10 +306,12 @@ value following the
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqlshow\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
On Windows, connect to the server via a named pipe\&. This option applies only for connections to a local server, and only if the server supports named\-pipe connections\&.
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
.RE
.sp
.RS 4
...
...
@@ -406,7 +414,7 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
@@ -475,7 +483,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
\fB\-\-query="use test;insert into t values(null)"\fR
.fi
.if n \{\
.RE
.\}
.sp
This option was added in MySQL 5\&.1\&.5\&.
.RE
.sp
.RS 4
...
...
@@ -653,15 +676,15 @@ The password to use when connecting to the server\&. If you use the short option
have a space between the option and the password\&. If you omit the
\fIpassword\fR
value following the
.\" mysqlslap: password option
.\" password option: mysqlslap
\fB\-\-password\fR
or
\fB\-p\fR
option on the command line, you are prompted for one\&.
option on the command line,
\fBmysqlslap\fR
prompts for one\&.
.sp
Specifying a password on the command line should be considered insecure\&. See
Section\ \&5.5.6.2, \(lqEnd-User Guidelines for Password Security\(rq\&.
Section\ \&5.3.2.2, \(lqEnd-User Guidelines for Password Security\(rq\&. You can use an option file to avoid giving the password on the command line\&.
On Windows, connect to the server via a named pipe\&. This option applies only for connections to a local server, and only if the server supports named\-pipe connections\&.
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
.RE
.sp
.RS 4
...
...
@@ -897,7 +920,7 @@ localhost, the Unix socket file to use, or, on Windows, the name of the named pi
Options that begin with
\fB\-\-ssl\fR
specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates\&. See
@@ -971,7 +994,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -175,31 +175,11 @@ The base directory for tests\&.
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: big-test option
.\" big-test option: mysqltest
\fB\-\-big\-test\fR,
\fB\-B\fR
.sp
Define the
\fBmysqltest\fR
variable
$BIG_TEST
as 1\&. This option was removed in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.13\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: character-sets-dir option
.\" character-sets-dir option: mysqltest
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.sp
The directory where character sets are installed\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.32, and 5\&.1\&.13\&.
The directory where character sets are installed\&.
.RE
.sp
.RS 4
...
...
@@ -226,12 +206,11 @@ Compress all information sent between the client and the server if both support
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: cursor-protocol option
.\" mysqltest: currsor-protocol option
.\" cursor-protocol option: mysqltest
\fB\-\-cursor\-protocol\fR
.sp
Use cursors for prepared statements (implies
\fB\-\-ps\-protocol\fR)\&. This option was added in MySQL 5\&.0\&.19\&.
Use cursors for prepared statements\&.
.RE
.sp
.RS 4
...
...
@@ -281,7 +260,7 @@ value is
.\" debug-check option: mysqltest
\fB\-\-debug\-check\fR
.sp
Print some debugging information when the program exits\&. This option was added in MySQL 5\&.1\&.21\&.
Print some debugging information when the program exits\&.
.RE
.sp
.RS 4
...
...
@@ -296,7 +275,7 @@ Print some debugging information when the program exits\&. This option was added
.\" debug-info option: mysqltest
\fB\-\-debug\-info\fR
.sp
Print debugging information and memory and CPU usage statistics when the program exits\&. This option was added in MySQL 5\&.1\&.14\&.
Print debugging information and memory and CPU usage statistics when the program exits\&.
.RE
.sp
.RS 4
...
...
@@ -332,7 +311,7 @@ Include the contents of the given file before processing the contents of the tes
\fBmysqltest\fR
test files\&. This option has the same effect as putting a
\-\-source \fIfile_name\fR
command as the first line of the test file\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.7\&.
command as the first line of the test file\&.
.RE
.sp
.RS 4
...
...
@@ -347,7 +326,7 @@ command as the first line of the test file\&. This option was added in MySQL 4\&
.\" logdir option: mysqltest
\fB\-\-logdir=\fR\fB\fIdir_name\fR\fR
.sp
The directory to use for log files\&. This option was added in MySQL 5\&.1\&.14\&.
The directory to use for log files\&.
.RE
.sp
.RS 4
...
...
@@ -363,7 +342,7 @@ The directory to use for log files\&. This option was added in MySQL 5\&.1\&.14\
\fB\-\-mark\-progress\fR
.sp
Write the line number and elapsed time to
\fItest_file\fR\&.progress\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.30, and 5\&.1\&.12\&.
\fItest_file\fR\&.progress\&.
.RE
.sp
.RS 4
...
...
@@ -378,7 +357,24 @@ Write the line number and elapsed time to
.\" max-connect-retries option: mysqltest
\fB\-\-max\-connect\-retries=\fR\fB\fInum\fR\fR
.sp
The maximum number of connection attempts when connecting to server\&. This option was added in MySQL 4\&.1\&.23, 5\&.0\&.23, and 5\&.1\&.11\&.
The maximum number of connection attempts when connecting to server\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: max-connections option
.\" max-connections option: mysqltest
\fB\-\-max\-connections=\fR\fB\fInum\fR\fR
.sp
The maximum number of simultaneous server connections per client (that is, per test)\&. If not set, the maximum is 128\&. Minimum allowed limit is 8, maximum is 5120\&.
.sp
This option is available from MySQL 5\&.1\&.45\&.
.RE
.sp
.RS 4
...
...
@@ -393,7 +389,7 @@ The maximum number of connection attempts when connecting to server\&. This opti
.\" no-defaults option: mysqltest
\fB\-\-no\-defaults\fR
.sp
Do not read default options from any option files\&.
Do not read default options from any option files\&. If used, this must be the first option\&.
.RE
.sp
.RS 4
...
...
@@ -484,7 +480,8 @@ Suppress all normal output\&. This is a synonym for
.sp
Record the output that results from running the test file into the file named by the
\fB\-\-result\-file\fR
option, if that option is given\&.
option, if that option is given\&. It is an error to use this option without also using
\fB\-\-result\-file\fR\&.
.RE
.sp
.RS 4
...
...
@@ -516,7 +513,9 @@ treats the test actual and expected results for a test case:
.\}
If the test produces no results,
\fBmysqltest\fR
exits with an error message to that effect\&.
exits with an error message to that effect, unless
\fB\-\-result\-file\fR
is given and the named file is an empty file\&.
.RE
.sp
.RS 4
...
...
@@ -551,7 +550,7 @@ reads the expected results from the given file and compares them with the actual
\fBmysqltest\fR
writes a
\&.reject
file in the same directory as the result file and exits with an error\&.
file in the same directory as the result file, outputs a diff of the two files, and exits with an error\&.
.RE
.sp
.RS 4
...
...
@@ -695,7 +694,22 @@ localhost
.sp
Execute DML statements within a stored procedure\&. For every DML statement,
\fBmysqltest\fR
creates and invokes a stored procedure that executes the statement rather than executing the statement directly\&. This option was added in MySQL 5\&.0\&.19\&.
creates and invokes a stored procedure that executes the statement rather than executing the statement directly\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" mysqltest: tail-lines option
.\" tail-lines option: mysqltest
\fB\-\-tail\-lines=\fR\fB\fInn\fR\fR
.sp
Specify how many lines of the result to include in the output if the test fails because an SQL statement fails\&. The default is 0, meaning no lines of result printed\&.
.RE
.sp
.RS 4
...
...
@@ -727,7 +741,9 @@ Read test input from this file\&. The default is to read from the standard input
\fB\-\-timer\-file=\fR\fB\fIfile_name\fR\fR,
\fB\-m \fR\fB\fIfile_name\fR\fR
.sp
The file where the timing in microseconds is written\&.
If given, the number of millisecond spent running the test will be written to this file\&. This is used by
\fBmysql\-test\-run\&.pl\fR
for its reporting\&.
.RE
.sp
.RS 4
...
...
@@ -743,7 +759,7 @@ The file where the timing in microseconds is written\&.
\fB\-\-tmpdir=\fR\fB\fIdir_name\fR\fR,
\fB\-t \fR\fB\fIdir_name\fR\fR
.sp
The temporary directory where socket files are put\&.
The temporary directory where socket files are created\&.
.RE
.sp
.RS 4
...
...
@@ -775,7 +791,7 @@ The MySQL user name to use when connecting to the server\&.
\fB\-\-verbose\fR,
\fB\-v\fR
.sp
Verbose mode\&. Print out more information what the program does\&.
Verbose mode\&. Print out more information about what the program does\&.
.RE
.sp
.RS 4
...
...
@@ -813,7 +829,7 @@ statement is wrapped inside a view\&. This option was added in MySQL 5\&.0\&.19\
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright \(co 2007, 2010, Oracle and/or its affiliates. All rights reserved.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -298,7 +298,7 @@ Backup files that have already been created by the affected node
.IP \(bu 2.3
.\}
MySQL Cluster Disk Data files (see
Section\ \&17.5.9, \(lqMySQL Cluster Disk Data Tables\(rq)\&.
Section\ \&17.5.10, \(lqMySQL Cluster Disk Data Tables\(rq)\&.
.RE
.RS 4
.sp
...
...
@@ -334,7 +334,7 @@ T}:T{
5\&.1\&.11
T}
T{
\fBCommandLine Format\fR
\fBCommand\-Line Format\fR
T}:T{
\-\-initial\-start
T}
...
...
@@ -358,20 +358,27 @@ T}
This option is used when performing a partial initial start of the cluster\&. Each node should be started with this option, as well as
\fB\-\-nowait\-nodes\fR\&.
.sp
For example, suppose you have a 4\-node cluster whose data nodes have the IDs 2, 3, 4, and 5, and you wish to perform a partial initial start using only nodes 2, 4, and 5 \(em that is, omitting node 3:
Suppose that you have a 4\-node cluster whose data nodes have the IDs 2, 3, 4, and 5, and you wish to perform a partial initial start using only nodes 2, 4, and 5 \(em that is, omitting node 3:
Prior to MySQL 5\&.1\&.19, it was not possible to perform DDL operations involving Disk Data tables on a partially started cluster\&. (See
\m[blue]\fBBug#24631\fR\m[]\&\s-2\u[1]\d\s+2\&.)
.sp
When using this option, you must also specify the node ID for the data node being started with the
\fB\-\-ndb\-nodeid\fR
option\&.
.sp
This option was added in MySQL 5\&.1\&.11\&.
.if n \{\
.sp
...
...
@@ -385,8 +392,11 @@ This option was added in MySQL 5\&.1\&.11\&.
\fBImportant\fR
.ps -1
.br
Prior to MySQL 5\&.1\&.19, it was not possible to perform DDL operations involving Disk Data tables on a partially started cluster\&. (See
\m[blue]\fBBug#24631\fR\m[]\&\s-2\u[1]\d\s+2\&.)
Do not confuse this option with the
\fB\-\-nowait\-nodes\fR
option added for
\fBndb_mgmd\fR
in MySQL Cluster NDB 7\&.0\&.10, which can be used to allow a cluster configured with multiple management servers to be started without all management servers being online\&.
.sp .5v
.RE
.RE
...
...
@@ -412,10 +422,10 @@ l l s
T{
\fBVersion Introduced\fR
T}:T{
5\&.1\&.11
5\&.1\&.9
T}
T{
\fBCommandLine Format\fR
\fBCommand\-Line Format\fR
T}:T{
\-\-nowait\-nodes=list
T}
...
...
@@ -470,9 +480,12 @@ allbox tab(:);
l l s
l l s
^ l l
^ l l
l l s
^ l l
^ l l.
T{
\fBCommandLine Format\fR
\fBCommand\-Line Format\fR
T}:T{
\-\-nodaemon
T}
...
...
@@ -491,6 +504,21 @@ T}
T}:T{
FALSE
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR (windows)
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
TRUE
T}
.TE
.sp 1
Instructs
...
...
@@ -527,7 +555,7 @@ l l s
^ l l
^ l l.
T{
\fBCommandLine Format\fR
\fBCommand\-Line Format\fR
T}:T{
\-\-nostart
T}
...
...
@@ -759,7 +787,7 @@ Section\ \&17.1.5, \(lqKnown Limitations of MySQL Cluster\(rq\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
...
...
@@ -771,12 +799,12 @@ You should have received a copy of the GNU General Public License along with the
@@ -154,7 +154,7 @@ must be run on a cluster data node, since it accesses the data node file system
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -74,7 +74,7 @@ Prior to MySQL Cluster NDB 7\&.0\&.6, there were known issues when using
\fBndbmtd\fR
with MySQL Cluster Disk Data tables\&. If you wish to use multi\-threaded data nodes with disk\-based
NDB
tables, you should insure that you are running MySQL Cluster NDB 7\&.0\&.6 or later\&. (\m[blue]\fBBug#41915\fR\m[]\&\s-2\u[1]\d\s+2,
tables, you should ensure that you are running MySQL Cluster NDB 7\&.0\&.6 or later\&. (\m[blue]\fBBug#41915\fR\m[]\&\s-2\u[1]\d\s+2,
\m[blue]\fBBug#44915\fR\m[]\&\s-2\u[2]\d\s+2)
.PP
Using
...
...
@@ -356,7 +356,7 @@ concurrently on different data nodes in the same MySQL Cluster\&. However, such
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
...
...
@@ -368,12 +368,12 @@ You should have received a copy of the GNU General Public License along with the
Note that the meaning of system error messages may be dependent on your operating system\&. A given error code may mean different things on different operating systems\&.
.PP
\fBperror\fR
supports the following options:
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -181,7 +181,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -160,7 +160,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
@@ -49,7 +49,7 @@ command\&. The numeric dump file should contain a numeric stack track from
\fBmysqld\fR\&. If no numeric dump file is named on the command line, the stack trace is read from the standard input\&.
.PP
\fBresolve_stack_dump\fR
supports the options described in the following list\&.
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -117,7 +117,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
supports the options described in the following list\&.
supports the following options\&.
.sp
.RS 4
.ie n \{\
...
...
@@ -99,7 +99,7 @@ Display version information and exit\&.
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
