# mariadb-client-test

## NAME



           mariadb-client-test - test client API (mariadb-client-test is now
           a symlink to mariadb-client-test)
           mariadb-client-test-embedded - test client API for embedded server
           (mariadb-client-test-embedded is now a symlink to mariadb-client-
           test-embedded)
    


## SYNOPSIS



    
           **mariadb-client-test [**_options_**] [**_test_name_**] ...**
    
           **mariadb-client-test-embedded [**_options_**] [**_test_name_**] ...**
    


## DESCRIPTION



           The **mariadb-client-test** program is used for testing aspects of the
           MariaDB client API that cannot be tested using **mariadb-test** and
           its test language.  **mariadb-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 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.
    
           **mariadb-client-test** is used in a test by the same name in the main
           tests suite of **mariadb-test-run.pl** 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.
    
           **mariadb-client-test** supports the following options:
    
           •   **--help** , **-?**
    
               Display a help message and exit.
    
           •   **--basedir=**_dir_name_ , **-b** _dir_name_
    
               The base directory for the tests.
    
           •   **--count=**_count_ , **-t** _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 MariaDB is built with debugging
               support. The default _debug_options_ value is
               'd:t:o,/tmp/mariadb-client-test.trace'.
    
           •   **--getopt-ll-test=**_option_ , **-g** _option_
    
               Option to use for testing bugs in the getopt library.
    
           •   **--host=**_host_name_ , **-h** _host_name_
    
               Connect to the MariaDB 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.
    
           •   **--server-arg=**_arg_ , **-A** _arg_
    
               Argument to send to the embedded server.
    
           •   **--show-tests** , **-T**
    
               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).
    
           •   **--testcase** , **-c**
    
               The option is used when called from **mariadb-test-run.pl** , so
               that **mariadb-client-test** 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.
    
           •   **--user=**_user_name_ , **-u** _user_name_
    
               The MariaDB user name to use when connecting to the server.
    
           •   **-v** _dir_name_ , **--vardir=**_dir_name_
    
               The data directory for tests. The default is mariadb-test/var.
    


* * *