MYSQL_CLIENT_TEST(1)

NAME
mysql_client_test - test client API
mysql_client_test_embedded - test client API for embedded server

SYNOPSIS

mysql_client_test [options] [test_name] ...

mysql_client_test_embedded [options] [test_name] ...

DESCRIPTION

The mysql_client_test program is used for testing aspects of the MySQL client API that cannot be tested using mysqltest and its test language. mysql_client_test_embedded is similar but used for testing the embedded server. Both programs are run as part of the test suite.

The source code for the programs can be found in in test/mysql_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.

mysql_client_test supports the following options:

•   --help, -?

    Display a help message and exit.

•   -b dir_name, --basedir=dir_name

    The base directory for the tests.

•   -t count, --count=count

    The number of times to execute the tests.

•   --database=db_name, -D db_name

    The database to use.

•   --debug[=debug_options], -#[debug_options]

    Write a debugging log if MySQL is built with debugging support. The default debug_options value is 'd:t:o,/tmp/mysql_client_test.trace'.

•   -g option, --getopt-ll-test=option

    Option to use for testing bugs in the getopt library.

•   --host=host_name, -h host_name

    Connect to the MySQL server on the given host.

•   --password[=password], -p[password]

    The password to use when connecting to the server. If you use the short option form (-p), you cannot have a space between the option and the password. If you omit the password value following the --password or -p option on the command line, you are prompted for one.

•   --port=port_num, -P port_num

    The TCP/IP port number to use for the connection.

•   -A arg, --server-arg=arg

    Argument to send to the embedded server.

•   -T, --show-tests

    Show all test names.

•   --silent, -s

    Be more silent.

•   --socket=path, -S path

    The socket file to use when connecting to localhost (which is the default host).

•   -c, --testcase

    The option may disable some code when run as a mysql-test-run.pl test case.

•   --user=user_name, -u user_name

    The MySQL username to use when connecting to the server.

•   -v dir_name, --vardir=dir_name

    The data directory for tests. The default is mysql-test/var.

COPYRIGHT

Copyright 2006-2007 MySQL AB

This documentation is NOT distributed under a GPL license. Use of this documentation is subject to the following terms: You may create a printed copy of this documentation solely for your own personal use. Conversion to other formats is allowed as long as the actual content is not altered or edited in any way. You shall not publish or distribute this documentation in any form or on any media, except if you distribute the documentation in a manner similar to how MySQL disseminates it (that is, electronically for download on a Web site with the software) or on a CD-ROM or similar medium, provided however that the documentation is disseminated together with the software on the same medium. Any other use, such as any dissemination of printed copies or use of this documentation, in whole or in part, in another publication, requires the prior written consent from an authorized representative of MySQL AB. MySQL AB reserves any and all rights to this documentation not expressly granted above.

Please email <docs@mysql.com> for more information or if you are interested in doing a translation.

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/.

AUTHOR
MySQL AB (http://www.mysql.com/). This software comes with no warranty.