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 you want to using 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:
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 will have 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]
option file groups. mysqlslap also supports
the options for processing option files described at
Section 4.2.3.3.1, “Command-Line Options that Affect Option-File Handling”.
Table 4.8. mysqlslap
Options
Format | Option File | Description | Introduction | Deprecated | Removed |
---|---|---|---|---|---|
--auto-generate-sql | auto-generate-sql | Generate SQL statements automatically when they are not supplied in files or using command options | |||
--auto-generate-sql-add-autoincrement | auto-generate-sql-add-autoincrement | Add AUTO_INCREMENT column to automatically generated tables | |||
--auto-generate-sql-execute-number=# | auto-generate-sql-execute-number | Specify how many queries to generate automatically | |||
--auto-generate-sql-guid-primary | auto-generate-sql-guid-primary | Add a GUID-based primary key to automatically generated tables | |||
--auto-generate-sql-load-type=type | auto-generate-sql-load-type | Specify how many queries to generate automatically | |||
--auto-generate-sql-secondary-indexes=# | auto-generate-sql-secondary-indexes | Specify how many secondary indexes to add to automatically generated tables | |||
--auto-generate-sql-unique-query-number=# | auto-generate-sql-unique-query-number | How many different queries to generate for automatic tests. | |||
--auto-generate-sql-unique-write-number=# | auto-generate-sql-unique-write-number | How many different queries to generate for --auto-generate-sql-write-number | |||
--auto-generate-sql-write-number=# | auto-generate-sql-write-number | How many row inserts to perform on each thread | |||
--commit=# | commit | How many statements to execute before committing. | |||
--compress | compress | Compress all information sent between the client and the server | |||
--concurrency=# | concurrency | The number of clients to simulate when issuing the SELECT statement | |||
--create=value | create | The file or string containing the statement to use for creating the table | |||
--create-schema=value | create-schema | The schema in which to run the tests | |||
--csv=[file] | csv | Generate output in comma-separated values format | |||
--debug[=debug_options] | debug | Write a debugging log | |||
--debug-check | debug-check | Print debugging information when the program exits | |||
--debug-info | debug-info | Print debugging information, memory and CPU statistics when the program exits | |||
--delimiter=str | delimiter | The delimiter to use in SQL statements | |||
--detach=# | detach | Detach (close and reopen) each connection after each N statements | |||
--engine=engine_name | engine | The storage engine to use for creating the table | |||
--help | Display help message and exit | ||||
--host=host_name | host | Connect to the MySQL server on the given host | |||
--iterations=# | iterations | The number of times to run the tests | |||
--number-char-cols=# | number-char-cols | The number of VARCHAR columns to use if --auto-generate-sql is specified | |||
--number-int-cols=# | number-int-cols | The number of INT columns to use if --auto-generate-sql is specified | |||
--number-of-queries=# | number-of-queries | Limit each client to approximately this number of queries | |||
--only-print | only-print | Do not connect to databases. mysqlslap only prints what it would have done | |||
--password[=password] | password | The password to use when connecting to the server | |||
--pipe | On Windows, connect to server using a named pipe | ||||
--port=port_num | port | The TCP/IP port number to use for the connection | |||
--post-query=value | post-query | The file or string containing the statement to execute after the tests have completed | |||
--post-system=str | post-system | The string to execute using system() after the tests have completed | |||
--pre-query=value | pre-query | The file or string containing the statement to execute before running the tests | |||
--pre-system=str | pre-system | The string to execute using system() before running the tests | |||
--protocol=type | protocol | The connection protocol to use | |||
--query=value | query | The file or string containg the SELECT statement to use for retrieving data | |||
--silent | silent | Silent mode | |||
--socket=path | socket | For connections to localhost | |||
--ssl-ca=file_name | ssl-ca | The path to a file that contains a list of trusted SSL CAs | |||
--ssl-capath=directory_name | ssl-capath | The path to a directory that contains trusted SSL CA certificates in PEM format | |||
--ssl-cert=file_name | ssl-cert | The name of the SSL certificate file to use for establishing a secure connection | |||
--ssl-cipher=cipher_list | ssl-cipher | A list of allowable ciphers to use for SSL encryption | |||
--ssl-key=file_name | ssl-key | The name of the SSL key file to use for establishing a secure connection | |||
--ssl-verify-server-cert | ssl-verify-server-cert | The server's Common Name value in its certificate is verified against the host name used when connecting to the server | |||
--user=user_name, | user | The MySQL user name to use when connecting to the 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), ormixed
(half inserts, half scanning selects). The default ismixed
.--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 on each thread. 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 both support compression.
--concurrency=
,N
-c
N
The number of clients to simulate when issuing the
SELECT
statement.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.
--debug[=
,debug_options
]-# [
debug_options
]Write a debugging log. A typical
debug_options
string is'd:t:o,
. The default isfile_name
''d:t:o,/tmp/mysqlslap.trace'
.Print some debugging information when the program exits.
--debug-info
,-T
Print debugging information and memory and CPU usage statistics when the program exits.
--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).--engine=
,engine_name
-e
engine_name
The storage engine to use for creating tables.
--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.
--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 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 thepassword
value following the--password
or-p
option on the command line, mysqlslap prompts for one.Specifying a password on the command line should be considered insecure. See Section 5.3.2.2, “End-User Guidelines for Password Security”. You can use an option file to avoid giving the password on the command line.
--pipe
,-W
On Windows, connect to the server using a named pipe. This option applies only if the server supports named-pipe connections.
--port=
,port_num
-P
port_num
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.
--shared-memory-base-name=
name
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.
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.--protocol={TCP|SOCKET|PIPE|MEMORY}
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”.
--query=
,value
-q
value
The file or string containing the
SELECT
statement to use for retrieving data.--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.Options that begin with
--ssl
specify whether to connect to the server using SSL and indicate where to find SSL keys and certificates. See Section 5.5.8.3, “SSL Command Options”.--user=
,user_name
-u
user_name
The MySQL user name to use when 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.