mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 03:52:35 +01:00
6f955c262a
For the sake of readable diffs this change is done separately from the previous commit and it changes all man page headers to: - Use correct syntax \fB and \fR to make titles bold instead of previous capitalized version that had no effect - Omit unnecessary \&. syntax, works fine without it - Bump version to 10.11 Ideally the version would automatically be inherited from the build/release, but for now at least update it manually to match what is in the VERSION file of this release branch. All new code of the whole pull request, including one or several files that are either new files or modified ones, are contributed under the BSD-new license. I am contributing on behalf of my employer Amazon Web Services, Inc.
1083 lines
20 KiB
Groff
1083 lines
20 KiB
Groff
'\" t
|
|
.\"
|
|
.TH "\fBMARIADB-TEST\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * 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"
|
|
mariadb-test \- program to run test cases (mysqltest is now a symlink to mariadb-test)
|
|
.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 MariaDB 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
|
|
via
|
|
\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 MariaDB 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 MariaDB 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: connect-timeout option
|
|
.\" connect-timeout option: mysqltest
|
|
\fB\-\-connect\-timeout=\fInum\fR
|
|
.sp
|
|
This can be used to set the MYSQL_OPT_CONNECT_TIMEOUT parameter of mysql_options to change the number of seconds before an unsuccessful connection attempt times out\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: continue-on-error option
|
|
.\" continue-on-error option: mysqltest
|
|
\fB\-\-continue\-on\-error\fR
|
|
.sp
|
|
Continue test even if we got an error\&. This is mostly
|
|
useful when testing a storage engine to see what from a
|
|
test file it can execute, or to find all syntax errors in
|
|
a newly created big test file\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: cursor-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 MariaDB is built with debugging support\&. The default
|
|
\fIdebug_options\fR
|
|
value is 'd:t:S:i:O,/tmp/mysqltest.trace'.
|
|
.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 MariaDB 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: 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\&.
|
|
.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: non-blocking-api option
|
|
.\" non-blocking-api option: mysqltest
|
|
\fB\-\-non\-blocking\-api\fR
|
|
.sp
|
|
Use the non-blocking client API for communication\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: overlay-dir option
|
|
.\" overlay-dir option: mysqltest
|
|
\fB\-\-overlay\-dir=\fIdir_name\fR
|
|
.sp
|
|
Overlay directory\&.
|
|
.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: plugin-dir option
|
|
.\" plugin-dir option: mysqltest
|
|
\fB\-\-plugin\-dir=\fIdir_name\fR
|
|
.sp
|
|
Directory for client-side plugins\&.
|
|
.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 or 0 for default to, in order of preference,
|
|
my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: prologue option
|
|
.\" prologue option: mysqltest
|
|
\fB\-\-prologue=\fR\fB\fIname\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: protocol option
|
|
.\" protocol option: mysqltest
|
|
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
|
|
.sp
|
|
The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&.
|
|
.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: result-format-version option
|
|
.\" result-format-version option: mysqltest
|
|
\fB\-\-result\-format\-version=\fI#\fR
|
|
.sp
|
|
Version of the result file format to use\&.
|
|
.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: 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: 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
|
|
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: SSL options
|
|
.\" SSL options: mysqltest
|
|
\fB\-\-ssl\fR
|
|
.sp
|
|
Enable SSL for connection (automatically enabled with other flags). Disable with
|
|
\fB\-\-skip-ssl\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL CA option
|
|
.\" SSL CA option: mysqltest
|
|
\fB\-\-ssl\-ca=\fIname\fR
|
|
.sp
|
|
CA file in PEM format (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL CA Path option
|
|
.\" SSL CA Path option: mysqltest
|
|
\fB\-\-ssl\-capath=\fIname\fR
|
|
.sp
|
|
CA directory (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL Cert option
|
|
.\" SSL Cert option: mysqltest
|
|
\fB\-\-ssl\-cert=\fIname\fR
|
|
.sp
|
|
X509 cert in PEM format (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL Cipher option
|
|
.\" SSL Cipher option: mysqltest
|
|
\fB\-\-ssl\-cipher=\fIname\fR
|
|
.sp
|
|
SSL cipher to use (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL Key option
|
|
.\" SSL Key option: mysqltest
|
|
\fB\-\-ssl\-key=\fIname\fR
|
|
.sp
|
|
X509 key in PEM format (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL Crl option
|
|
.\" SSL CRL option: mysqltest
|
|
\fB\-\-ssl\-crl=\fIname\fR
|
|
.sp
|
|
Certificate revocation list (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL Crlpath option
|
|
.\" SSL Crlpath option: mysqltest
|
|
\fB\-\-ssl\-crlpath=\fIname\fR
|
|
.sp
|
|
Certificate revocation list path (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: SSL Verify Server Cert option
|
|
.\" SSL Verify Server Cert option: mysqltest
|
|
\fB\-\-ssl\-verify\-server\-cert\fR
|
|
.sp
|
|
Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqltest: suite-dir option
|
|
.\" suite-dir option: mysqltest
|
|
\fB\-\-suite\-dir=\fIdir_name\fR
|
|
.sp
|
|
Suite directory\&.
|
|
.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 microseconds 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 MariaDB 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\&.
|
|
.RE
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
.PP
|
|
Copyright \(co 2007, 2010, Oracle and/or its affiliates, 2010-2020 MariaDB Foundation
|
|
.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-1335 USA or see http://www.gnu.org/licenses/.
|
|
.sp
|
|
.SH "SEE ALSO"
|
|
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
|
|
.SH AUTHOR
|
|
MariaDB Foundation (http://www.mariadb.org/).
|