.\"     Title: \fBmysqltest\fR
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
.\"      Date: 01/03/2008
.\"    Manual: MySQL Database System
.\"    Source: MySQL
.\"
.TH "\fBMYSQLTEST\fR" "1" "01/03/2008" "MySQL" "MySQL Database System"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
mysqltest \- program to run test cases
.br
mysqltest_embedded \- program to run embedded test cases
.SH "SYNOPSIS"
.HP 30
\fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR
.HP 39
\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
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:
.TP 3n
\(bu
Can send SQL statements to MySQL servers for execution
.TP 3n
\(bu
Can execute external shell commands
.TP 3n
\(bu
Can test whether the result from a SQL statement or shell command is as expected
.TP 3n
\(bu
Can connect to one or more standalone
\fBmysqld\fR
servers and switch between connections
.TP 3n
\(bu
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.)
.sp
.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
.RS 3n
.nf
shell> \fBmysqltest [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB] < \fR\fB\fItest_file\fR\fR
.fi
.RE
.PP
You can also name the test case file with a
\fB\-\-test\-file=\fR\fB\fIfile_name\fR\fR
option.
.PP
\fBmysqltest\fR
supports the following options:
.TP 3n
\(bu
\fB\-\-help\fR,
\fB\-?\fR
.sp
Display a help message and exit.
.TP 3n
\(bu
\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR,
\fB\-b \fR\fB\fIdir_name\fR\fR
.sp
The base directory for tests.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\fB\-\-compress\fR,
\fB\-C\fR
.sp
Compress all information sent between the client and the server if both support compression.
.TP 3n
\(bu
\fB\-\-cursor\-protocol\fR
.sp
Use cursors for prepared statements (implies
\fB\-\-ps\-protocol\fR). This option was added in MySQL 5.0.19.
.TP 3n
\(bu
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
\fB\-D \fR\fB\fIdb_name\fR\fR
.sp
The default database to use.
.TP 3n
\(bu
\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
\'d:t:S:i:O,/tmp/mysqltest.trace'.
.TP 3n
\(bu
\fB\-\-debug\-check\fR
.sp
Print some debugging information when the program exits. This option was added in MySQL 5.1.21.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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. This option was added in MySQL 4.1.23, 5.0.30, and 5.1.7.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\fB\-\-mark\-progress\fR
.sp
Write the line number and elapsed time to
\fI\fItest_file\fR\fR\fI.progress\fR. This option was added in MySQL 4.1.23, 5.0.30, and 5.1.12.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\fB\-\-no\-defaults\fR
.sp
Do not read default options from any option files.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\fB\-\-ps\-protocol\fR
.sp
Use the prepared\-statement protocol for communication.
.TP 3n
\(bu
\fB\-\-quiet\fR
.sp
Suppress all normal output. This is a synonym for
\fB\-\-silent\fR.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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:
.RS 3n
.TP 3n
\(bu
If the test produces no results,
\fBmysqltest\fR
exits with an error message to that effect.
.TP 3n
\(bu
Otherwise, if
\fB\-\-result\-file\fR
is not given,
\fBmysqltest\fR
sends test results to the standard output.
.TP 3n
\(bu
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
\fI.reject\fR
file in the same directory as the result file and exits with an error.
.TP 3n
\(bu
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
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\fB\-\-silent\fR,
\fB\-s\fR
.sp
Suppress all normal output.
.TP 3n
\(bu
\fB\-\-skip\-safemalloc\fR
.sp
Do not use memory allocation checking.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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).
.TP 3n
\(bu
\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. This option was added in MySQL 5.0.19.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\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.
.TP 3n
\(bu
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
\fB\-u \fR\fB\fIuser_name\fR\fR
.sp
The MySQL username to use when connecting to the server.
.TP 3n
\(bu
\fB\-\-verbose\fR,
\fB\-v\fR
.sp
Verbose mode. Print out more information what the program does.
.TP 3n
\(bu
\fB\-\-version\fR,
\fB\-V\fR
.sp
Display version information and exit.
.TP 3n
\(bu
\fB\-\-view\-protocol\fR
.sp
Every
SELECT
statement is wrapped inside a view. This option was added in MySQL 5.0.19.
.SH "COPYRIGHT"
.PP
Copyright 2007\-2008 MySQL AB
.PP
This documentation is free software; you can redistribute it and/or modify it 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/.
.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
MySQL AB (http://www.mysql.com/).