MySQL 5.7 Reference Manual Including MySQL NDB Cluster 7.5 and NDB Cluster 7.6
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 --create
or --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.
Examples:
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 INT
columns
and three 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
data):
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 ';'
. The
--query
file has multiple queries delimited by
';'
. 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
[mysqlslap]
and [client]
groups of an option file. For information about option files
used by MySQL programs, see Section 4.2.2.2, “Using Option Files”.
Table 4.19 mysqlslap Options
Option Name | Description | Introduced | Deprecated |
---|---|---|---|
--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 | ||
--get-server-public-key | Request RSA public key from server | 5.7.23 | |
--help | Display help message and exit | ||
--host | Host on which MySQL server is located | ||
--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 | Connect to server using named pipe (Windows only) | ||
--plugin-dir | Directory where plugins are installed | ||
--port | TCP/IP port number 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 | Transport 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 | Yes | |
--server-public-key-path | Path name to file containing RSA public key | 5.7.23 | |
--shared-memory-base-name | Shared-memory name for shared-memory connections (Windows only) | ||
--silent | Silent mode | ||
--socket | Unix socket file or Windows named pipe to use | ||
--sql-mode | Set SQL mode for client session | ||
--ssl | Enable connection encryption | ||
--ssl-ca | File that contains list of trusted SSL Certificate Authorities | ||
--ssl-capath | Directory that contains trusted SSL Certificate Authority certificate files | ||
--ssl-cert | File that contains X.509 certificate | ||
--ssl-cipher | Permissible ciphers for connection encryption | ||
--ssl-crl | File that contains certificate revocation lists | ||
--ssl-crlpath | Directory that contains certificate revocation-list files | ||
--ssl-key | File that contains X.509 key | ||
--ssl-mode | Desired security state of connection to server | 5.7.11 | |
--ssl-verify-server-cert | Verify host name against server certificate Common Name identity | ||
--tls-version | Permissible TLS protocols for encrypted connections | 5.7.10 | |
--user | MySQL user name to use when connecting to server | ||
--verbose | Verbose mode | ||
--version | Display version information and exit |
--help
,
-?
Display a help message and exit.
Generate SQL statements automatically when they are not supplied in files or using command options.
--auto-generate-sql-add-autoincrement
Add an AUTO_INCREMENT
column to
automatically generated tables.
--auto-generate-sql-execute-number=
N
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=
type
Specify the test load type. The permissible values are
read
(scan tables),
write
(insert into tables),
key
(read primary keys),
update
(update primary keys), or
mixed
(half inserts, half scanning
selects). The default is mixed
.
--auto-generate-sql-secondary-indexes=
N
Specify how many secondary indexes to add to automatically generated tables. By default, none are added.
--auto-generate-sql-unique-query-number=
N
How many different queries to generate for automatic tests.
For example, if you run a key
test 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.
--auto-generate-sql-unique-write-number=
N
How many different queries to generate for
--auto-generate-sql-write-number
.
The default is 10.
--auto-generate-sql-write-number=
N
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
,
-C
Compress all information sent between the client and the server if possible. See Section 4.2.6, “Connection Compression Control”.
--concurrency=
,
N
-c
N
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.
If the
--auto-generate-sql
option is also given, mysqlslap drops
the schema at the end of the test run. To avoid this, use
the --no-drop
option as
well.
Generate output in comma-separated values format. The output goes to the named file, or to the standard output if no file is given.
--debug[=
,
debug_options
]-#
[
debug_options
]
Write a debugging log. A typical
debug_options
string is
d:t:o,
.
The default is
file_name
d:t:o,/tmp/mysqlslap.trace
.
This option is available only if MySQL was built using
WITH_DEBUG
. MySQL release
binaries provided by Oracle are not
built using this option.
Print some debugging information when the program exits.
This option is available only if MySQL was built using
WITH_DEBUG
. MySQL release
binaries provided by Oracle are not
built using this option.
--debug-info
,
-T
Print debugging information and memory and CPU usage statistics when the program exits.
This option is available only if MySQL was built using
WITH_DEBUG
. MySQL release
binaries provided by Oracle are not
built using this option.
A hint about which client-side authentication plugin to use. See Section 6.2.13, “Pluggable Authentication”.
--defaults-extra-file=
file_name
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_name
is interpreted relative
to the current directory if given as a relative path name
rather than a full path name.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
Use only the given option file. If the file does not exist
or is otherwise inaccessible, an error occurs.
file_name
is 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 .mylogin.cnf
.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
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
[client]
and
[mysqlslap]
groups. If the
--defaults-group-suffix=_other
option is given, mysqlslap also reads the
[client_other]
and
[mysqlslap_other]
groups.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--delimiter=
,
str
-F
str
The delimiter to use in SQL statements supplied in files or using command options.
Detach (close and reopen) each connection after each
N
statements. The default is 0
(connections are not detached).
Enable the mysql_clear_password
cleartext
authentication plugin. (See
Section 6.4.1.6, “Client-Side Cleartext Pluggable Authentication”.)
--engine=
,
engine_name
-e
engine_name
The storage engine to use for creating tables.
Request from the server the RSA public key that it uses for
key pair-based password exchange. This option applies to
clients that connect to the server using an account that
authenticates with the
caching_sha2_password
authentication
plugin. For connections by such accounts, the server does
not send the public key to the client unless requested. The
option is ignored for accounts that do not authenticate with
that plugin. It is also ignored if RSA-based password
exchange is not needed, as is the case when the client
connects to the server using a secure connection.
If
--server-public-key-path=
is given and specifies a valid public key file, it takes
precedence over
file_name
--get-server-public-key
.
For information about the
caching_sha2_password
plugin, see
Section 6.4.1.4, “Caching SHA-2 Pluggable Authentication”.
The
--get-server-public-key
option was added in MySQL 5.7.23.
--host=
,
host_name
-h
host_name
Connect to the MySQL server on the given host.
--iterations=
,
N
-i
N
The number of times to run the tests.
Read options from the named login path in the
.mylogin.cnf
login 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”.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
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-defaults
can be used
to prevent them from being read.
The exception is that the .mylogin.cnf
file, 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-defaults
is used.
(.mylogin.cnf
is created by the
mysql_config_editor utility. See
Section 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.)
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--number-char-cols=
,
N
-x
N
The number of VARCHAR
columns
to use if
--auto-generate-sql
is
specified.
--number-int-cols=
,
N
-y
N
The number of INT
columns to
use if --auto-generate-sql
is specified.
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.
--password[=
,
password
]-p[
password
]
The password of the MySQL account used for connecting to the
server. The password value is optional. If not given,
mysqlslap prompts for one. If given,
there must be no space between
--password=
or
-p
and the password following it. If no
password option is specified, the default is to send no
password.
Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, “End-User Guidelines for Password Security”.
To explicitly specify that there is no password and that
mysqlslap should not prompt for one, use
the
--skip-password
option.
--pipe
,
-W
On Windows, connect to the server using a named pipe. This
option applies only if the server was started with the
named_pipe
system variable
enabled to support named-pipe connections. In addition, the
user making the connection must be a member of the Windows
group specified by the
named_pipe_full_access_group
system variable.
The directory in which to look for plugins. Specify this
option if the
--default-auth
option is
used to specify an authentication plugin but
mysqlslap does not find it. See
Section 6.2.13, “Pluggable Authentication”.
--port=
,
port_num
-P
port_num
For TCP/IP connections, the port number to use.
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.
For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--protocol={TCP|SOCKET|PIPE|MEMORY}
The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.5, “Connection Transport Protocols”.
--query=
,
value
-q
value
The file or string containing the
SELECT
statement 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.
As of MySQL 5.7.5, this option is deprecated; expect it to
be removed in a future MySQL release. It is always enabled
and attempting to disable it
(--skip-secure-auth
,
--secure-auth=0
) produces
an error. Before MySQL 5.7.5, this option is enabled by
default but can be disabled.
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 6.4.1.3, “Migrating Away from Pre-4.1 Password Hashing and the mysql_old_password Plugin”.
--server-public-key-path=
file_name
The path name to a file in PEM format containing a
client-side copy of the public key required by the server
for RSA key pair-based password exchange. This option
applies to clients that authenticate with the
sha256_password
or
caching_sha2_password
authentication
plugin. This option is ignored for accounts that do not
authenticate with one of those plugins. It is also ignored
if RSA-based password exchange is not used, as is the case
when the client connects to the server using a secure
connection.
If
--server-public-key-path=
is given and specifies a valid public key file, it takes
precedence over
file_name
--get-server-public-key
.
For sha256_password
, this option applies
only if MySQL was built using OpenSSL.
For information about the sha256_password
and caching_sha2_password
plugins, see
Section 6.4.1.5, “SHA-256 Pluggable Authentication”, and
Section 6.4.1.4, “Caching SHA-2 Pluggable Authentication”.
The
--server-public-key-path
option was added in MySQL 5.7.23.
--shared-memory-base-name=
name
On Windows, the shared-memory name to use for connections
made using shared memory to a local server. The default
value is MYSQL
. The shared-memory name is
case-sensitive.
This option applies only if the server was started with the
shared_memory
system
variable enabled to support shared-memory connections.
--silent
,
-s
Silent mode. No output.
--socket=
,
path
-S
path
For connections to localhost
, the Unix
socket file to use, or, on Windows, the name of the named
pipe to use.
On Windows, this option applies only if the server was
started with the named_pipe
system variable enabled to support named-pipe connections.
In addition, the user making the connection must be a member
of the Windows group specified by the
named_pipe_full_access_group
system variable.
Set the SQL mode for the client session.
Options that begin with --ssl
specify
whether to connect to the server using SSL and indicate
where to find SSL keys and certificates. See
Command Options for Encrypted Connections.
The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated 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.3.2, “Encrypted Connection TLS Protocols and Ciphers”.
This option was added in MySQL 5.7.10.
--user=
,
user_name
-u
user_name
The user name of the MySQL account to use for connecting to the server.
--verbose
,
-v
Verbose mode. Print more information about what the program does. This option can be used multiple times to increase the amount of information.
--version
,
-V
Display version information and exit.