mirror of
				https://github.com/MariaDB/server.git
				synced 2025-11-03 20:36:16 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			1083 lines
		
	
	
	
		
			21 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
			
		
		
	
	
			1083 lines
		
	
	
	
		
			21 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
'\" t
 | 
						|
.\"
 | 
						|
.TH "\fBMARIADB-TEST\fR" "1" "3 September 2024" "MariaDB 11.4" "MariaDB Database System"
 | 
						|
.\" -----------------------------------------------------------------
 | 
						|
.\" * set default formatting
 | 
						|
.\" -----------------------------------------------------------------
 | 
						|
.\" disable hyphenation
 | 
						|
.nh
 | 
						|
.\" disable justification (adjust text to left margin only)
 | 
						|
.ad l
 | 
						|
.\" -----------------------------------------------------------------
 | 
						|
.\" * MAIN CONTENT STARTS HERE *
 | 
						|
.\" -----------------------------------------------------------------
 | 
						|
.\" mariadb-test
 | 
						|
.\" mariadb-test-embedded
 | 
						|
.SH "NAME"
 | 
						|
mariadb-test \- program to run test cases (mariadb-test is now a symlink to mariadb-test)
 | 
						|
.br
 | 
						|
mariadb-test-embedded \- program to run embedded test cases
 | 
						|
.SH "SYNOPSIS"
 | 
						|
.HP \w'\fBmariadb-test\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u
 | 
						|
\fBmariadb-test [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR
 | 
						|
.HP \w'\fBmariadb-test-embedded\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB]\fR\ 'u
 | 
						|
\fBmariadb-test-embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB]\fR
 | 
						|
.SH "DESCRIPTION"
 | 
						|
.PP
 | 
						|
The
 | 
						|
\fBmariadb-test\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
 | 
						|
\fBmariadb-test\fR
 | 
						|
via
 | 
						|
\fBmariadb\-test\-run\&.pl\fR
 | 
						|
rather than invoking it directly\&.
 | 
						|
.PP
 | 
						|
\fBmariadb-test-embedded\fR
 | 
						|
is similar but is built with support for the
 | 
						|
libmariadbd
 | 
						|
embedded server\&.
 | 
						|
.PP
 | 
						|
Features of
 | 
						|
\fBmariadb-test\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
 | 
						|
\fBmariadbd\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 (libmariadbd), if MariaDB is compiled with support for
 | 
						|
libmariadbd\&. (In this case, the executable is named
 | 
						|
\fBmariadb-test-embedded\fR
 | 
						|
rather than
 | 
						|
\fBmariadb-test\fR\&.)
 | 
						|
.RE
 | 
						|
.PP
 | 
						|
By default,
 | 
						|
\fBmariadb-test\fR
 | 
						|
reads the test case on the standard input\&. To run
 | 
						|
\fBmariadb-test\fR
 | 
						|
this way, you normally invoke it like this:
 | 
						|
.sp
 | 
						|
.if n \{\
 | 
						|
.RS 4
 | 
						|
.\}
 | 
						|
.nf
 | 
						|
shell> \fBmariadb-test [\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
 | 
						|
\fBmariadb-test\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
 | 
						|
\fBmariadb-test\fR
 | 
						|
supports the following options:
 | 
						|
.sp
 | 
						|
.RS 4
 | 
						|
.ie n \{\
 | 
						|
\h'-04'\(bu\h'+03'\c
 | 
						|
.\}
 | 
						|
.el \{\
 | 
						|
.sp -1
 | 
						|
.IP \(bu 2.3
 | 
						|
.\}
 | 
						|
.\" mariadb-test: help option
 | 
						|
.\" help option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: basedir option
 | 
						|
.\" basedir option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: character-sets-dir option
 | 
						|
.\" character-sets-dir option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: compress option
 | 
						|
.\" compress option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: connect-timeout option
 | 
						|
.\" connect-timeout option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: continue-on-error option
 | 
						|
.\" continue-on-error option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: cursor-protocol option
 | 
						|
.\" cursor-protocol option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: database option
 | 
						|
.\" database option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: debug option
 | 
						|
.\" debug option: mariadb-test
 | 
						|
\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/mariadb-test.trace'.
 | 
						|
.RE
 | 
						|
.sp
 | 
						|
.RS 4
 | 
						|
.ie n \{\
 | 
						|
\h'-04'\(bu\h'+03'\c
 | 
						|
.\}
 | 
						|
.el \{\
 | 
						|
.sp -1
 | 
						|
.IP \(bu 2.3
 | 
						|
.\}
 | 
						|
.\" mariadb-test: debug-check option
 | 
						|
.\" debug-check option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: debug-info option
 | 
						|
.\" debug-info option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: host option
 | 
						|
.\" host option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: logdir option
 | 
						|
.\" logdir option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: mark-progress option
 | 
						|
.\" mark-progress option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: max-connect-retries option
 | 
						|
.\" max-connect-retries option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: max-connections option
 | 
						|
.\" max-connections option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: no-defaults option
 | 
						|
.\" no-defaults option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: non-blocking-api option
 | 
						|
.\" non-blocking-api option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: overlay-dir option
 | 
						|
.\" overlay-dir option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: password option
 | 
						|
.\" password option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: plugin-dir option
 | 
						|
.\" plugin-dir option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: port option
 | 
						|
.\" port option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: prologue option
 | 
						|
.\" prologue option: mariadb-test
 | 
						|
\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
 | 
						|
\fBmariadb-test\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: protocol option
 | 
						|
.\" protocol option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: ps-protocol option
 | 
						|
.\" ps-protocol option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: quiet option
 | 
						|
.\" quiet option: mariadb-test
 | 
						|
\fB\-\-quiet\fR
 | 
						|
.sp
 | 
						|
Suppress all normal output\&. This is a synonym for
 | 
						|
.\" mariadb-test: silent option
 | 
						|
.\" silent option: mariadb-test
 | 
						|
\fB\-\-silent\fR\&.
 | 
						|
.RE
 | 
						|
.sp
 | 
						|
.RS 4
 | 
						|
.ie n \{\
 | 
						|
\h'-04'\(bu\h'+03'\c
 | 
						|
.\}
 | 
						|
.el \{\
 | 
						|
.sp -1
 | 
						|
.IP \(bu 2.3
 | 
						|
.\}
 | 
						|
.\" mariadb-test: record option
 | 
						|
.\" record option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: result-file option
 | 
						|
.\" result-file option: mariadb-test
 | 
						|
\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
 | 
						|
\fBmariadb-test\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,
 | 
						|
\fBmariadb-test\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,
 | 
						|
\fBmariadb-test\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,
 | 
						|
\fBmariadb-test\fR
 | 
						|
reads the expected results from the given file and compares them with the actual results\&. If the results do not match,
 | 
						|
\fBmariadb-test\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,
 | 
						|
\fBmariadb-test\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: result-format-version option
 | 
						|
.\" result-format-version option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: server-arg option
 | 
						|
.\" server-arg option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: server-file option
 | 
						|
.\" server-file option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: silent option
 | 
						|
.\" silent option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: sleep option
 | 
						|
.\" sleep option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: socket option
 | 
						|
.\" socket option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: sp-protocol option
 | 
						|
.\" sp-protocol option: mariadb-test
 | 
						|
\fB\-\-sp\-protocol\fR
 | 
						|
.sp
 | 
						|
Execute DML statements within a stored procedure\&. For every DML statement,
 | 
						|
\fBmariadb-test\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL options
 | 
						|
.\" SSL options: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL CA option
 | 
						|
.\" SSL CA option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL CA Path option
 | 
						|
.\" SSL CA Path option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL Cert option
 | 
						|
.\" SSL Cert option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL Cipher option
 | 
						|
.\" SSL Cipher option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL Key option
 | 
						|
.\" SSL Key option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL Crl option
 | 
						|
.\" SSL CRL option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL Crlpath option
 | 
						|
.\" SSL Crlpath option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: SSL Verify Server Cert option
 | 
						|
.\" SSL Verify Server Cert option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: suite-dir option
 | 
						|
.\" suite-dir option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: tail-lines option
 | 
						|
.\" tail-lines option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: test-file option
 | 
						|
.\" test-file option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: timer-file option
 | 
						|
.\" timer-file option: mariadb-test
 | 
						|
\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
 | 
						|
\fBmariadb\-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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: tmpdir option
 | 
						|
.\" tmpdir option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: user option
 | 
						|
.\" user option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: verbose option
 | 
						|
.\" verbose option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: version option
 | 
						|
.\" version option: mariadb-test
 | 
						|
\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
 | 
						|
.\}
 | 
						|
.\" mariadb-test: view-protocol option
 | 
						|
.\" view-protocol option: mariadb-test
 | 
						|
\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-2024 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/).
 |