932 lines
19 KiB
Groff
932 lines
19 KiB
Groff
|
'\" t
|
||
|
|
.\" Title: \fBmysqltest\fR
|
||
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
||
|
|
.\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
|
||
|
|
.\" Date: 11/04/2013
|
||
|
|
.\" Manual: MySQL Database System
|
||
|
|
.\" Source: MySQL
|
||
|
|
.\" Language: English
|
||
|
|
.\"
|
||
|
|
.TH "\FBMYSQLTEST\FR" "1" "11/04/2013" "MySQL" "MySQL Database System"
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * Define some portability stuff
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.\" http://bugs.debian.org/507673
|
||
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * set default formatting
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" disable hyphenation
|
||
|
|
.nh
|
||
|
|
.\" disable justification (adjust text to left margin only)
|
||
|
|
.ad l
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * MAIN CONTENT STARTS HERE *
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" mysqltest
|
||
|
|
.\" mysqltest_embedded
|
||
|
|
.SH "NAME"
|
||
|
|
mysqltest \- program to run test cases
|
||
|
|
.br
|
||
|
|
mysqltest_embedded \- program to run embedded test cases
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.HP \w'\fBmysqltest\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u
|
||
|
|
\fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR
|
||
|
|
.HP \w'\fBmysqltest_embedded\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u
|
||
|
|
\fBmysqltest_embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.PP
|
||
|
|
The
|
||
|
|
\fBmysqltest\fR
|
||
|
|
program runs a test case against a MySQL server and optionally compares the output with a result file\&. This program reads input written in a special test language\&. Typically, you invoke
|
||
|
|
\fBmysqltest\fR
|
||
|
|
using
|
||
|
|
\fBmysql\-test\-run\&.pl\fR
|
||
|
|
rather than invoking it directly\&.
|
||
|
|
.PP
|
||
|
|
\fBmysqltest_embedded\fR
|
||
|
|
is similar but is built with support for the
|
||
|
|
libmysqld
|
||
|
|
embedded server\&.
|
||
|
|
.PP
|
||
|
|
Features of
|
||
|
|
\fBmysqltest\fR:
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
Can send SQL statements to MySQL servers for execution
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
Can execute external shell commands
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
Can test whether the result from an SQL statement or shell command is as expected
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
Can connect to one or more standalone
|
||
|
|
\fBmysqld\fR
|
||
|
|
servers and switch between connections
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
Can connect to an embedded server (libmysqld), if MySQL is compiled with support for
|
||
|
|
libmysqld\&. (In this case, the executable is named
|
||
|
|
\fBmysqltest_embedded\fR
|
||
|
|
rather than
|
||
|
|
\fBmysqltest\fR\&.)
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
By default,
|
||
|
|
\fBmysqltest\fR
|
||
|
|
reads the test case on the standard input\&. To run
|
||
|
|
\fBmysqltest\fR
|
||
|
|
this way, you normally invoke it like this:
|
||
|
|
.sp
|
||
|
|
.if n \{\
|
||
|
|
.RS 4
|
||
|
|
.\}
|
||
|
|
.nf
|
||
|
|
shell> \fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB] < \fR\fB\fItest_file\fR\fR
|
||
|
|
.fi
|
||
|
|
.if n \{\
|
||
|
|
.RE
|
||
|
|
.\}
|
||
|
|
.PP
|
||
|
|
You can also name the test case file with a
|
||
|
|
\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR
|
||
|
|
option\&.
|
||
|
|
.PP
|
||
|
|
The exit value from
|
||
|
|
\fBmysqltest\fR
|
||
|
|
is 0 for success, 1 for failure, and 62 if it skips the test case (for example, if after checking some preconditions it decides not to run the test)\&.
|
||
|
|
.PP
|
||
|
|
\fBmysqltest\fR
|
||
|
|
supports the following options:
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: help option
|
||
|
|
.\" help option: mysqltest
|
||
|
|
\fB\-\-help\fR,
|
||
|
|
\fB\-?\fR
|
||
|
|
.sp
|
||
|
|
Display a help message and exit\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: basedir option
|
||
|
|
.\" basedir option: mysqltest
|
||
|
|
\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR,
|
||
|
|
\fB\-b \fR\fB\fIdir_name\fR\fR
|
||
|
|
.sp
|
||
|
|
The base directory for tests\&.
|
||
|
|
.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\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: compress option
|
||
|
|
.\" compress option: mysqltest
|
||
|
|
\fB\-\-compress\fR,
|
||
|
|
\fB\-C\fR
|
||
|
|
.sp
|
||
|
|
Compress all information sent between the client and the server if both support compression\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: currsor-protocol option
|
||
|
|
.\" cursor-protocol option: mysqltest
|
||
|
|
\fB\-\-cursor\-protocol\fR
|
||
|
|
.sp
|
||
|
|
Use cursors for prepared statements\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: database option
|
||
|
|
.\" database option: mysqltest
|
||
|
|
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
|
||
|
|
\fB\-D \fR\fB\fIdb_name\fR\fR
|
||
|
|
.sp
|
||
|
|
The default database to use\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: debug option
|
||
|
|
.\" debug option: mysqltest
|
||
|
|
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
|
||
|
|
\fB\-#[\fR\fB\fIdebug_options\fR\fR\fB]\fR
|
||
|
|
.sp
|
||
|
|
Write a debugging log if MySQL is built with debugging support\&. The default
|
||
|
|
\fIdebug_options\fR
|
||
|
|
value is
|
||
|
|
\*(Aqd:t:S:i:O,/tmp/mysqltest\&.trace\*(Aq\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: debug-check option
|
||
|
|
.\" debug-check option: mysqltest
|
||
|
|
\fB\-\-debug\-check\fR
|
||
|
|
.sp
|
||
|
|
Print some debugging information when the program exits\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: debug-info option
|
||
|
|
.\" debug-info option: mysqltest
|
||
|
|
\fB\-\-debug\-info\fR
|
||
|
|
.sp
|
||
|
|
Print debugging information and memory and CPU usage statistics when the program exits\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: host option
|
||
|
|
.\" host option: mysqltest
|
||
|
|
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
|
||
|
|
\fB\-h \fR\fB\fIhost_name\fR\fR
|
||
|
|
.sp
|
||
|
|
Connect to the MySQL server on the given host\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: include option
|
||
|
|
.\" include option: mysqltest
|
||
|
|
\fB\-\-include=\fR\fB\fIfile_name\fR\fR,
|
||
|
|
\fB\-i \fR\fB\fIfile_name\fR\fR
|
||
|
|
.sp
|
||
|
|
Include the contents of the given file before processing the contents of the test file\&. The included file should have the same format as other
|
||
|
|
\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\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: logdir option
|
||
|
|
.\" logdir option: mysqltest
|
||
|
|
\fB\-\-logdir=\fR\fB\fIdir_name\fR\fR
|
||
|
|
.sp
|
||
|
|
The directory to use for log files\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: mark-progress option
|
||
|
|
.\" mark-progress option: mysqltest
|
||
|
|
\fB\-\-mark\-progress\fR
|
||
|
|
.sp
|
||
|
|
Write the line number and elapsed time to
|
||
|
|
\fItest_file\fR\&.progress\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: max-connect-retries option
|
||
|
|
.\" 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\&.
|
||
|
|
.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
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: no-defaults option
|
||
|
|
.\" no-defaults option: mysqltest
|
||
|
|
\fB\-\-no\-defaults\fR
|
||
|
|
.sp
|
||
|
|
Do not read default options from any option files\&. If used, this must be the first option\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: plugin-dir option
|
||
|
|
.\" plugin-dir option: mysqltest
|
||
|
|
\fB\-\-plugin\-dir=\fR\fB\fIpath\fR\fR
|
||
|
|
.sp
|
||
|
|
The directory in which to look for plugins\&. It may be necessary to specify this option if the
|
||
|
|
\fIdefault_auth\fR
|
||
|
|
argument is used for the
|
||
|
|
connect()
|
||
|
|
command to specify an authentication plugin but
|
||
|
|
\fBmysqltest\fR
|
||
|
|
does not find it\&. This option was added in MySQL 5\&.5\&.7\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: password option
|
||
|
|
.\" password option: mysqltest
|
||
|
|
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
|
||
|
|
\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
|
||
|
|
.sp
|
||
|
|
The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you
|
||
|
|
\fIcannot\fR
|
||
|
|
have a space between the option and the password\&. If you omit the
|
||
|
|
\fIpassword\fR
|
||
|
|
value following the
|
||
|
|
\fB\-\-password\fR
|
||
|
|
or
|
||
|
|
\fB\-p\fR
|
||
|
|
option on the command line, you are prompted for one\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: port option
|
||
|
|
.\" port option: mysqltest
|
||
|
|
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
|
||
|
|
\fB\-P \fR\fB\fIport_num\fR\fR
|
||
|
|
.sp
|
||
|
|
The TCP/IP port number to use for the connection\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: protocol option
|
||
|
|
.\" protocol option: mysqltest
|
||
|
|
\fB\-\-protocol=\fR\fB{TCP|SOCKET|PIPE|MEMORY}\fR
|
||
|
|
.sp
|
||
|
|
Choose the protocol for communication with the server\&.
|
||
|
|
SOCKET
|
||
|
|
is default\&.
|
||
|
|
.sp
|
||
|
|
The
|
||
|
|
\fB\-\-protocol\fR
|
||
|
|
option is available from MySQL 5\&.1\&.51\&. It is ignored if running with the embedded server\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: ps-protocol option
|
||
|
|
.\" ps-protocol option: mysqltest
|
||
|
|
\fB\-\-ps\-protocol\fR
|
||
|
|
.sp
|
||
|
|
Use the prepared\-statement protocol for communication\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: quiet option
|
||
|
|
.\" quiet option: mysqltest
|
||
|
|
\fB\-\-quiet\fR
|
||
|
|
.sp
|
||
|
|
Suppress all normal output\&. This is a synonym for
|
||
|
|
.\" mysqltest: silent option
|
||
|
|
.\" silent option: mysqltest
|
||
|
|
\fB\-\-silent\fR\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: record option
|
||
|
|
.\" record option: mysqltest
|
||
|
|
\fB\-\-record\fR,
|
||
|
|
\fB\-r\fR
|
||
|
|
.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\&. It is an error to use this option without also using
|
||
|
|
\fB\-\-result\-file\fR\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: result-file option
|
||
|
|
.\" result-file option: mysqltest
|
||
|
|
\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR,
|
||
|
|
\fB\-R \fR\fB\fIfile_name\fR\fR
|
||
|
|
.sp
|
||
|
|
This option specifies the file for test case expected results\&.
|
||
|
|
\fB\-\-result\-file\fR, together with
|
||
|
|
\fB\-\-record\fR, determines how
|
||
|
|
\fBmysqltest\fR
|
||
|
|
treats the test actual and expected results for a test case:
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
If the test produces no results,
|
||
|
|
\fBmysqltest\fR
|
||
|
|
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
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
Otherwise, if
|
||
|
|
\fB\-\-result\-file\fR
|
||
|
|
is not given,
|
||
|
|
\fBmysqltest\fR
|
||
|
|
sends test results to the standard output\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
With
|
||
|
|
\fB\-\-result\-file\fR
|
||
|
|
but not
|
||
|
|
\fB\-\-record\fR,
|
||
|
|
\fBmysqltest\fR
|
||
|
|
reads the expected results from the given file and compares them with the actual results\&. If the results do not match,
|
||
|
|
\fBmysqltest\fR
|
||
|
|
writes a
|
||
|
|
\&.reject
|
||
|
|
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
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
With both
|
||
|
|
\fB\-\-result\-file\fR
|
||
|
|
and
|
||
|
|
\fB\-\-record\fR,
|
||
|
|
\fBmysqltest\fR
|
||
|
|
updates the given file by writing the actual test results to it\&.
|
||
|
|
.RE
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: server-arg option
|
||
|
|
.\" server-arg option: mysqltest
|
||
|
|
\fB\-\-server\-arg=\fR\fB\fIvalue\fR\fR,
|
||
|
|
\fB\-A \fR\fB\fIvalue\fR\fR
|
||
|
|
.sp
|
||
|
|
Pass the argument as an argument to the embedded server\&. For example,
|
||
|
|
\fB\-\-server\-arg=\-\-tmpdir=/tmp\fR
|
||
|
|
or
|
||
|
|
\fB\-\-server\-arg=\-\-core\fR\&. Up to 64 arguments can be given\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: server-file option
|
||
|
|
.\" server-file option: mysqltest
|
||
|
|
\fB\-\-server\-file=\fR\fB\fIfile_name\fR\fR,
|
||
|
|
\fB\-F \fR\fB\fIfile_name\fR\fR
|
||
|
|
.sp
|
||
|
|
Read arguments for the embedded server from the given file\&. The file should contain one argument per line\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: server-public-key-path option
|
||
|
|
.\" server-public-key-path option: mysqltest
|
||
|
|
\fB\-\-server\-public\-key\-path=\fR\fBfile_name\fR
|
||
|
|
.sp
|
||
|
|
The path name to a file containing the server RSA public key\&. The file must be in PEM format\&. The public key is used for RSA encryption of the client password for connections to the server made using accounts that authenticate with the
|
||
|
|
sha256_password
|
||
|
|
plugin\&. This option is ignored for client accounts that do not authenticate with that plugin\&. It is also ignored if password encryption is not needed, as is the case when the client connects to the server using an SSL connection\&.
|
||
|
|
.sp
|
||
|
|
The server sends the public key to the client as needed, so it is not necessary to use this option for RSA password encryption to occur\&. It is more efficient to do so because then the server need not send the key\&.
|
||
|
|
.sp
|
||
|
|
For additional discussion regarding use of the
|
||
|
|
sha256_password
|
||
|
|
plugin, including how to get the RSA public key, see
|
||
|
|
\m[blue]\fBThe SHA\-256 Authentication Plugin\fR\m[]\&\s-2\u[1]\d\s+2\&.
|
||
|
|
.sp
|
||
|
|
This option is available only if MySQL was built using OpenSSL\&. It was added in MySQL 5\&.6\&.6 under the name
|
||
|
|
\fB\-\-server\-public\-key\fR
|
||
|
|
and renamed in 5\&.6\&.7 to
|
||
|
|
\fB\-\-server\-public\-key\-path\fR\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: silent option
|
||
|
|
.\" silent option: mysqltest
|
||
|
|
\fB\-\-silent\fR,
|
||
|
|
\fB\-s\fR
|
||
|
|
.sp
|
||
|
|
Suppress all normal output\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: skip-safemalloc option
|
||
|
|
.\" skip-safemalloc option: mysqltest
|
||
|
|
\fB\-\-skip\-safemalloc\fR
|
||
|
|
.sp
|
||
|
|
Do not use memory allocation checking\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: sleep option
|
||
|
|
.\" sleep option: mysqltest
|
||
|
|
\fB\-\-sleep=\fR\fB\fInum\fR\fR,
|
||
|
|
\fB\-T \fR\fB\fInum\fR\fR
|
||
|
|
.sp
|
||
|
|
Cause all
|
||
|
|
sleep
|
||
|
|
commands in the test case file to sleep
|
||
|
|
\fInum\fR
|
||
|
|
seconds\&. This option does not affect
|
||
|
|
real_sleep
|
||
|
|
commands\&.
|
||
|
|
.sp
|
||
|
|
As of MySQL 5\&.0\&.23, an option value of 0 can be used, which effectively disables
|
||
|
|
sleep
|
||
|
|
commands in the test case\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: socket option
|
||
|
|
.\" socket option: mysqltest
|
||
|
|
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
|
||
|
|
\fB\-S \fR\fB\fIpath\fR\fR
|
||
|
|
.sp
|
||
|
|
The socket file to use when connecting to
|
||
|
|
localhost
|
||
|
|
(which is the default host)\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: sp-protocol option
|
||
|
|
.\" sp-protocol option: mysqltest
|
||
|
|
\fB\-\-sp\-protocol\fR
|
||
|
|
.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\&.
|
||
|
|
.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
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: test-file option
|
||
|
|
.\" test-file option: mysqltest
|
||
|
|
\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR,
|
||
|
|
\fB\-x \fR\fB\fIfile_name\fR\fR
|
||
|
|
.sp
|
||
|
|
Read test input from this file\&. The default is to read from the standard input\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: timer-file option
|
||
|
|
.\" timer-file option: mysqltest
|
||
|
|
\fB\-\-timer\-file=\fR\fB\fIfile_name\fR\fR,
|
||
|
|
\fB\-m \fR\fB\fIfile_name\fR\fR
|
||
|
|
.sp
|
||
|
|
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
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: tmpdir option
|
||
|
|
.\" tmpdir option: mysqltest
|
||
|
|
\fB\-\-tmpdir=\fR\fB\fIdir_name\fR\fR,
|
||
|
|
\fB\-t \fR\fB\fIdir_name\fR\fR
|
||
|
|
.sp
|
||
|
|
The temporary directory where socket files are created\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: user option
|
||
|
|
.\" user option: mysqltest
|
||
|
|
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
|
||
|
|
\fB\-u \fR\fB\fIuser_name\fR\fR
|
||
|
|
.sp
|
||
|
|
The MySQL user name to use when connecting to the server\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: verbose option
|
||
|
|
.\" verbose option: mysqltest
|
||
|
|
\fB\-\-verbose\fR,
|
||
|
|
\fB\-v\fR
|
||
|
|
.sp
|
||
|
|
Verbose mode\&. Print out more information about what the program does\&.
|
||
|
|
.RE
|
||
|
|
.sp
|
||
|
|
.RS 4
|
||
|
|
.ie n \{\
|
||
|
|
\h'-04'\(bu\h'+03'\c
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
.sp -1
|
||
|
|
.IP \(bu 2.3
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: version option
|
||
|
|
.\" version option: mysqltest
|
||
|
|
\fB\-\-version\fR,
|
||
|
|
\fB\-V\fR
|
||
|
|
.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
|
||
|
|
.\}
|
||
|
|
.\" mysqltest: view-protocol option
|
||
|
|
.\" view-protocol option: mysqltest
|
||
|
|
\fB\-\-view\-protocol\fR
|
||
|
|
.sp
|
||
|
|
Every
|
||
|
|
SELECT
|
||
|
|
statement is wrapped inside a view\&. This option was added in MySQL 5\&.0\&.19\&.
|
||
|
|
.RE
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
Copyright \(co 2006, 2013, 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
|
||
|
|
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||
|
|
.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/.
|
||
|
|
.sp
|
||
|
|
.SH "NOTES"
|
||
|
|
.IP " 1." 4
|
||
|
|
The SHA-256 Authentication Plugin
|
||
|
|
.RS 4
|
||
|
|
\%http://dev.mysql.com/doc/refman/5.6/en/sha256-authentication-plugin.html
|
||
|
|
.RE
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
For more information, please refer to the MySQL Reference Manual,
|
||
|
|
which may already be installed locally and which is also available
|
||
|
|
online at http://dev.mysql.com/doc/.
|
||
|
|
.SH AUTHOR
|
||
|
|
Oracle Corporation (http://dev.mysql.com/).
|