mirror of
https://github.com/MariaDB/server.git
synced 2025-11-04 12:56:14 +01:00
332 lines
8 KiB
Groff
332 lines
8 KiB
Groff
'\" t
|
|
.\"
|
|
.TH "\fBMARIADB-CLIENT-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-client-test
|
|
.\" mariadb-client-test-embedded
|
|
.SH "NAME"
|
|
mariadb-client-test \- test client API (mariadb-client-test is now a symlink to mariadb-client-test)
|
|
.br
|
|
mariadb-client-test-embedded \- test client API for embedded server (mariadb-client-test-embedded is now a symlink to mariadb-client-test-embedded)
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBmariadb-client-test\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fItest_name\fR\fR\fB]\ \&.\&.\&.\fR\ 'u
|
|
\fBmariadb-client-test [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] \&.\&.\&.\fR
|
|
.HP \w'\fBmariadb-client-test-embedded\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fItest_name\fR\fR\fB]\ \&.\&.\&.\fR\ 'u
|
|
\fBmariadb-client-test-embedded [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fItest_name\fR\fR\fB] \&.\&.\&.\fR
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
The
|
|
\fBmariadb-client-test\fR
|
|
program is used for testing aspects of the MariaDB client API that cannot be tested using
|
|
\fBmariadb-test\fR
|
|
and its test language\&.
|
|
\fBmariadb-client-test-embedded\fR
|
|
is similar but used for testing the embedded server\&. Both programs are run as part of the test suite\&.
|
|
.PP
|
|
The source code for the programs can be found in in
|
|
tests/mariadb-client-test\&.c
|
|
in a source distribution\&. The program serves as a good source of examples illustrating how to use various features of the client API\&.
|
|
.PP
|
|
\fBmariadb-client-test\fR
|
|
is used in a test by the same name in the main tests suite of
|
|
\fBmariadb\-test\-run\&.pl\fR
|
|
but may also be run directly\&. Unlike the other programs listed here, it does not read an external description of what tests to run\&. Instead, all tests are coded into the program, which is written to cover all aspects of the C language API\&.
|
|
.PP
|
|
\fBmariadb-client-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-client-test: help option
|
|
.\" help option: mariadb-client-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
|
|
.\}
|
|
\fB\-\-basedir=\fR\fB\fIdir_name\fR\fR,
|
|
.\" mariadb-client-test: basedir option
|
|
.\" basedir option: mariadb-client-test
|
|
\fB\-b \fR\fB\fIdir_name\fR\fR
|
|
.sp
|
|
The base directory for the tests\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-count=\fR\fB\fIcount\fR\fR,
|
|
.\" mariadb-client-test: count option
|
|
.\" count option: mariadb-client-test
|
|
\fB\-t \fR\fB\fIcount\fR\fR
|
|
.sp
|
|
The number of times to execute the tests\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mariadb-client-test: database option
|
|
.\" database option: mariadb-client-test
|
|
\fB\-\-database=\fR\fB\fIdb_name\fR\fR,
|
|
\fB\-D \fR\fB\fIdb_name\fR\fR
|
|
.sp
|
|
The database to use\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mariadb-client-test: debug option
|
|
.\" debug option: mariadb-client-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:o,/tmp/mariadb-client-test.trace'.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-getopt\-ll\-test=\fR\fB\fIoption\fR\fR,
|
|
.\" mariadb-client-test: getopt-ll-test option
|
|
.\" getopt-ll-test option: mariadb-client-test
|
|
\fB\-g \fR\fB\fIoption\fR\fR
|
|
.sp
|
|
Option to use for testing bugs in the
|
|
getopt
|
|
library\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mariadb-client-test: host option
|
|
.\" host option: mariadb-client-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-client-test: password option
|
|
.\" password option: mariadb-client-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
|
|
.\" mariadb-client-test: password option
|
|
.\" password option: mariadb-client-test
|
|
\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-client-test: port option
|
|
.\" port option: mariadb-client-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\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-server\-arg=\fR\fB\fIarg\fR\fR,
|
|
.\" mariadb-client-test: server-arg option
|
|
.\" server-arg option: mariadb-client-test
|
|
\fB\-A \fR\fB\fIarg\fR\fR
|
|
.sp
|
|
Argument to send to the embedded server\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-show\-tests\fR,
|
|
\fB\-T\fR
|
|
.sp
|
|
Show all test names\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mariadb-client-test: silent option
|
|
.\" silent option: mariadb-client-test
|
|
\fB\-\-silent\fR,
|
|
\fB\-s\fR
|
|
.sp
|
|
Be more silent\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mariadb-client-test: socket option
|
|
.\" socket option: mariadb-client-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
|
|
.\}
|
|
\fB\-\-testcase\fR,
|
|
\fB\-c\fR
|
|
.sp
|
|
The option is used when called from
|
|
\fBmariadb\-test\-run\&.pl\fR, so that
|
|
\fBmariadb-client-test\fR
|
|
may optionally behave in a different way than if called manually, for example by skipping some tests\&. Currently, there is no difference in behavior but the option is included in order to make this possible\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mariadb-client-test: user option
|
|
.\" user option: mariadb-client-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
|
|
.\}
|
|
\fB\-v \fR\fB\fIdir_name\fR\fR,
|
|
.\" mariadb-client-test: vardir option
|
|
.\" vardir option: mariadb-client-test
|
|
\fB\-\-vardir=\fR\fB\fIdir_name\fR\fR
|
|
.sp
|
|
The data directory for tests\&. The default is
|
|
mariadb\-test/var\&.
|
|
.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/).
|