mysqlslap is a diagnostic program designed to emulate client load for a MySQL server and to report the timing of each stage. It works as if multiple clients are accessing the server.
Invoke mysqlslap like this:
shell> mysqlslap [options]
Some options such as
--query enable you to
specify a string containing an SQL statement or a file
containing statements. If you specify a file, by default it must
contain one statement per line. (That is, the implicit statement
delimiter is the newline character.) Use the
--delimiter option to specify
a different delimiter, which enables you to specify statements
that span multiple lines or place multiple statements on a
single line. You cannot include comments in a file;
mysqlslap does not understand them.
mysqlslap runs in three stages:
Create schema, table, and optionally any stored programs or data to use for the test. This stage uses a single client connection.
Run the load test. This stage can use many client connections.
Clean up (disconnect, drop table if specified). This stage uses a single client connection.
Supply your own create and query SQL statements, with 50 clients querying and 200 selects for each (enter the command on a single line):
mysqlslap --delimiter=";" --create="CREATE TABLE a (b int);INSERT INTO a VALUES (23)" --query="SELECT * FROM a" --concurrency=50 --iterations=200
Let mysqlslap build the query SQL statement
with a table of two
VARCHAR columns. Use
five clients querying 20 times each. Do not create the table or
insert the data (that is, use the previous test's schema and
mysqlslap --concurrency=5 --iterations=20 --number-int-cols=2 --number-char-cols=3 --auto-generate-sql
Tell the program to load the create, insert, and query SQL
statements from the specified files, where the
create.sql file has multiple table creation
statements delimited by
';' and multiple
insert statements delimited by
--query file will have multiple queries
';'. Run all the load
statements, then run all the queries in the query file with five
clients (five times each):
mysqlslap --concurrency=5 --iterations=5 --query=query.sql --create=create.sql --delimiter=";"
mysqlslap supports the following options,
which can be specified on the command line or in the
groups of an option file. For information about option files
used by MySQL programs, see Section 4.2.6, “Using Option Files”.
|--auto-generate-sql||Generate SQL statements automatically when they are not supplied in files or using command options|
|--auto-generate-sql-add-autoincrement||Add AUTO_INCREMENT column to automatically generated tables|
|--auto-generate-sql-execute-number||Specify how many queries to generate automatically|
|--auto-generate-sql-guid-primary||Add a GUID-based primary key to automatically generated tables|
|--auto-generate-sql-load-type||Specify the test load type|
|--auto-generate-sql-secondary-indexes||Specify how many secondary indexes to add to automatically generated tables|
|--auto-generate-sql-unique-query-number||How many different queries to generate for automatic tests.|
|--auto-generate-sql-unique-write-number||How many different queries to generate for --auto-generate-sql-write-number|
|--auto-generate-sql-write-number||How many row inserts to perform on each thread|
|--commit||How many statements to execute before committing.|
|--compress||Compress all information sent between client and server|
|--concurrency||Number of clients to simulate when issuing the SELECT statement|
|--create||File or string containing the statement to use for creating the table|
|--create-schema||Schema in which to run the tests|
|--csv||Generate output in comma-separated values format|
|--debug||Write debugging log|
|--debug-check||Print debugging information when program exits|
|--debug-info||Print debugging information, memory, and CPU statistics when program exits|
|--default-auth||Authentication plugin to use|
|--defaults-extra-file||Read named option file in addition to usual option files|
|--defaults-file||Read only named option file|
|--defaults-group-suffix||Option group suffix value|
|--delimiter||Delimiter to use in SQL statements|
|--detach||Detach (close and reopen) each connection after each N statements|
|--enable-cleartext-plugin||Enable cleartext authentication plugin|
|--engine||Storage engine to use for creating the table|
|--help||Display help message and exit|
|--host||Connect to MySQL server on given host|
|--iterations||Number of times to run the tests|
|--login-path||Read login path options from .mylogin.cnf|
|--no-defaults||Read no option files|
|--no-drop||Do not drop any schema created during the test run|
|--number-char-cols||Number of VARCHAR columns to use if --auto-generate-sql is specified|
|--number-int-cols||Number of INT columns to use if --auto-generate-sql is specified|
|--number-of-queries||Limit each client to approximately this number of queries|
|--only-print||Do not connect to databases. mysqlslap only prints what it would have done|
|--password||Password to use when connecting to server|
|--pipe||On Windows, connect to server using named pipe|
|--plugin-dir||Directory where plugins are installed|
|--port||TCP/IP port number to use for connection|
|--post-query||File or string containing the statement to execute after the tests have completed|
|--post-system||String to execute using system() after the tests have completed|
|--pre-query||File or string containing the statement to execute before running the tests|
|--pre-system||String to execute using system() before running the tests|
|--print-defaults||Print default options|
|--protocol||Connection protocol to use|
|--query||File or string containing the SELECT statement to use for retrieving data|
|--secure-auth||Do not send passwords to server in old (pre-4.1) format||5.7.4||5.7.5|
|--shared-memory-base-name||The name of shared memory to use for shared-memory connections|
|--socket||For connections to localhost, the Unix socket file to use|
|--sql-mode||Set SQL mode for client session||5.7.5|
|--ssl||Enable encrypted connection|
|--ssl-ca||Path of file that contains list of trusted SSL CAs|
|--ssl-capath||Path of directory that contains trusted SSL CA certificates in PEM format|
|--ssl-cert||Path of file that contains X509 certificate in PEM format|
|--ssl-cipher||List of permitted ciphers to use for connection encryption|
|--ssl-crl||Path of file that contains certificate revocation lists|
|--ssl-crlpath||Path of directory that contains certificate revocation list files|
|--ssl-key||Path of file that contains X509 key in PEM format|
|--ssl-mode||Security state of connection to server||5.7.11|
|--ssl-verify-server-cert||Verify server certificate Common Name value against host name used when connecting to server|
|--tls-version||Protocols permitted for encrypted connections||5.7.10|
|--user||MySQL user name to use when connecting to server|
|--version||Display version information and exit|
Display a help message and exit.
Generate SQL statements automatically when they are not supplied in files or using command options.
AUTO_INCREMENTcolumn to automatically generated tables.
Specify how many queries to generate automatically.
Add a GUID-based primary key to automatically generated tables.
Specify the test load type. The permissible values are
write(insert into tables),
key(read primary keys),
update(update primary keys), or
mixed(half inserts, half scanning selects). The default is
Specify how many secondary indexes to add to automatically generated tables. By default, none are added.
How many different queries to generate for automatic tests. For example, if you run a
keytest that performs 1000 selects, you can use this option with a value of 1000 to run 1000 unique queries, or with a value of 50 to perform 50 different selects. The default is 10.
How many different queries to generate for
--auto-generate-sql-write-number. The default is 10.
How many row inserts to perform. The default is 100.
How many statements to execute before committing. The default is 0 (no commits are done).
Compress all information sent between the client and the server if both support compression.
The number of parallel clients to simulate.
The file or string containing the statement to use for creating the table.
The schema in which to run the tests.
Generate output in comma-separated values format. The output goes to the named file, or to the standard output if no file is given.
Write a debugging log. A typical
d:t:o,. The default is
Print some debugging information when the program exits.
Print debugging information and memory and CPU usage statistics when the program exits.
A hint about the client-side authentication plugin to use. See Section 6.3.9, “Pluggable Authentication”.
Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs.
file_nameis interpreted relative to the current directory if given as a relative path name rather than a full path name.
Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs.
file_nameis interpreted relative to the current directory if given as a relative path name rather than a full path name.
Exception: Even with
--defaults-file, client programs read
Read not only the usual option groups, but also groups with the usual names and a suffix of
str. For example, mysqlslap normally reads the
[mysqlslap]groups. If the
--defaults-group-suffix=_otheroption is given, mysqlslap also reads the
The delimiter to use in SQL statements supplied in files or using command options.
Detach (close and reopen) each connection after each
Nstatements. The default is 0 (connections are not detached).
mysql_clear_passwordcleartext authentication plugin. (See Section 188.8.131.52, “Client-Side Cleartext Pluggable Authentication”.)
The storage engine to use for creating tables.
Connect to the MySQL server on the given host.
The number of times to run the tests.
Read options from the named login path in the
.mylogin.cnflogin path file. A “login path” is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use the mysql_config_editor utility. See Section 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.
Prevent mysqlslap from dropping any schema it creates during the test run.
Do not read any option files. If program startup fails due to reading unknown options from an option file,
--no-defaultscan be used to prevent them from being read.
The exception is that the
.mylogin.cnffile, if it exists, is read in all cases. This permits passwords to be specified in a safer way than on the command line even when
--no-defaultsis used. (
.mylogin.cnfis created by the mysql_config_editor utility. See Section 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.)
Limit each client to approximately this many queries. Query counting takes into account the statement delimiter. For example, if you invoke mysqlslap as follows, the
;delimiter is recognized so that each instance of the query string counts as two queries. As a result, 5 rows (not 10) are inserted.
shell> mysqlslap --delimiter=";" --number-of-queries=10 --query="use test;insert into t values(null)"
Do not connect to databases. mysqlslap only prints what it would have done.
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
passwordvalue following the
-poption on the command line, mysqlslap prompts for one.
Specifying a password on the command line should be considered insecure. See Section 184.108.40.206, “End-User Guidelines for Password Security”. You can use an option file to avoid giving the password on the command line.
On Windows, connect to the server using a named pipe. This option applies only if the server supports named-pipe connections.
The directory in which to look for plugins. Specify this option if the
--default-authoption is used to specify an authentication plugin but mysqlslap does not find it. See Section 6.3.9, “Pluggable Authentication”.
The TCP/IP port number to use for the connection.
The file or string containing the statement to execute after the tests have completed. This execution is not counted for timing purposes.
The string to execute using
system()after the tests have completed. This execution is not counted for timing purposes.
The file or string containing the statement to execute before running the tests. This execution is not counted for timing purposes.
The string to execute using
system()before running the tests. This execution is not counted for timing purposes.
Print the program name and all options that it gets from option files.
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. For details on the permissible values, see Section 4.2.2, “Connecting to the MySQL Server”.
The file or string containing the
SELECTstatement to use for retrieving data.
Do not send passwords to the server in old (pre-4.1) format. This prevents connections except for servers that use the newer password format. This option was added in MySQL 5.7.4.
As of MySQL 5.7.5, this option is deprecated and will be removed in a future MySQL release. It is always enabled and attempting to disable it (
--secure-auth=0) produces an error. Before MySQL 5.7.5, this option is enabled by default but can be disabled.Note
Passwords that use the pre-4.1 hashing method are less secure than passwords that use the native password hashing method and should be avoided. Pre-4.1 passwords are deprecated and support for them was removed in MySQL 5.7.5. For account upgrade instructions, see Section 220.127.116.11, “Migrating Away from Pre-4.1 Password Hashing and the mysql_old_password Plugin”.
On Windows, the shared-memory name to use, for connections made using shared memory to a local server. This option applies only if the server supports shared-memory connections.
Silent mode. No output.
For connections to
localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.
Set the SQL mode for the client session. This option was added in MySQL 5.7.5.
Options that begin with
--sslspecify whether to connect to the server using SSL and indicate where to find SSL keys and certificates. See Section 6.4.2, “Command Options for Encrypted Connections”.
The protocols permitted by the client for encrypted connections. The value is a comma-separated list containing one or more protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.4.6, “Encrypted Connection Protocols and Ciphers”.
This option was added in MySQL 5.7.10.
The MySQL user name to use when connecting to the server.
Verbose mode. Print more information about what the program does. This option can be used multiple times to increase the amount of information.
Display version information and exit.