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:
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 should contain 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 6.2.2.2, “Using Option Files”.
Table 6.16 mysqlslap Options
| Option Name | Description |
|---|---|
| --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 |
| --compression-algorithms | Permitted compression algorithms for connections to 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 |
| --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 |
| --no-login-paths | Do not read login paths from the login path file |
| --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 |
| --password1 | First multifactor authentication password to use when connecting to server |
| --password2 | Second multifactor authentication password to use when connecting to server |
| --password3 | Third multifactor authentication 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 |
| --server-public-key-path | Path name to file containing RSA public key |
| --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-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-fips-mode | Whether to enable FIPS mode on client side |
| --ssl-key | File that contains X.509 key |
| --ssl-mode | Desired security state of connection to server |
| --ssl-session-data | File that contains SSL session data |
| --ssl-session-data-continue-on-failed-reuse | Whether to establish connections if session reuse fails |
| --tls-ciphersuites | Permissible TLSv1.3 ciphersuites for encrypted connections |
| --tls-sni-servername | Server name supplied by the client |
| --tls-version | Permissible TLS protocols for encrypted connections |
| --user | MySQL user name to use when connecting to server |
| --verbose | Verbose mode |
| --version | Display version information and exit |
| --zstd-compression-level | Compression level for connections to server that use zstd compression |
--help,-?Command-Line Format --helpDisplay a help message and exit.
-
Command-Line Format --auto-generate-sqlType Boolean Default Value FALSEGenerate SQL statements automatically when they are not supplied in files or using command options.
--auto-generate-sql-add-autoincrementCommand-Line Format --auto-generate-sql-add-autoincrementType Boolean Default Value FALSEAdd an
AUTO_INCREMENTcolumn to automatically generated tables.--auto-generate-sql-execute-number=NCommand-Line Format --auto-generate-sql-execute-number=#Type Numeric Specify how many queries to generate automatically.
--auto-generate-sql-guid-primaryCommand-Line Format --auto-generate-sql-guid-primaryType Boolean Default Value FALSEAdd a GUID-based primary key to automatically generated tables.
--auto-generate-sql-load-type=typeCommand-Line Format --auto-generate-sql-load-type=typeType Enumeration Default Value mixedValid Values readwritekeyupdatemixedSpecify 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=NCommand-Line Format --auto-generate-sql-secondary-indexes=#Type Numeric Default Value 0Specify how many secondary indexes to add to automatically generated tables. By default, none are added.
--auto-generate-sql-unique-query-number=NCommand-Line Format --auto-generate-sql-unique-query-number=#Type Numeric Default Value 10How 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.--auto-generate-sql-unique-write-number=NCommand-Line Format --auto-generate-sql-unique-write-number=#Type Numeric Default Value 10How many different queries to generate for
--auto-generate-sql-write-number. The default is 10.--auto-generate-sql-write-number=NCommand-Line Format --auto-generate-sql-write-number=#Type Numeric Default Value 100How many row inserts to perform. The default is 100.
-
Command-Line Format --commit=#Type Numeric Default Value 0How many statements to execute before committing. The default is 0 (no commits are done).
--compress,-CCommand-Line Format --compress[={OFF|ON}]Deprecated Yes Type Boolean Default Value OFFCompress all information sent between the client and the server if possible. See Section 6.2.8, “Connection Compression Control”.
This option is deprecated. Expect it to be removed in a future version of MySQL. See Configuring Legacy Connection Compression.
--compression-algorithms=valueCommand-Line Format --compression-algorithms=valueType Set Default Value uncompressedValid Values zlibzstduncompressedThe permitted compression algorithms for connections to the server. The available algorithms are the same as for the
protocol_compression_algorithmssystem variable. The default value isuncompressed.For more information, see Section 6.2.8, “Connection Compression Control”.
--concurrency=,N-cNCommand-Line Format --concurrency=#Type Numeric The number of parallel clients to simulate.
-
Command-Line Format --create=valueType String The file or string containing the statement to use for creating the table.
-
Command-Line Format --create-schema=valueType String The schema in which to run the tests.
NoteIf the
--auto-generate-sqloption is also given, mysqlslap drops the schema at the end of the test run. To avoid this, use the--no-dropoption as well. -
Command-Line Format --csv=[file]Type File name 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]Command-Line Format --debug[=debug_options]Type String Default Value d:t:o,/tmp/mysqlslap.traceWrite a debugging log. A typical
debug_optionsstring isd:t:o,. The default isfile_named: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.-
Command-Line Format --debug-checkType Boolean Default Value FALSEPrint 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,-TCommand-Line Format --debug-infoType Boolean Default Value FALSEPrint 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.-
Command-Line Format --default-auth=pluginType String A hint about which client-side authentication plugin to use. See Section 8.2.17, “Pluggable Authentication”.
--defaults-extra-file=file_nameCommand-Line Format --defaults-extra-file=file_nameType 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. If
file_nameis not an absolute path name, it is interpreted relative to the current directory.For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.
-
Command-Line Format --defaults-file=file_nameType File name Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If
file_nameis not an absolute path name, it is interpreted relative to the current directory.Exception: Even with
--defaults-file, client programs read.mylogin.cnf.For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.
-
Command-Line Format --defaults-group-suffix=strType String 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 this option is given as--defaults-group-suffix=_other, mysqlslap also reads the[client_other]and[mysqlslap_other]groups.For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--delimiter=,str-FstrCommand-Line Format --delimiter=strType String The delimiter to use in SQL statements supplied in files or using command options.
-
Command-Line Format --detach=#Type Numeric Default Value 0Detach (close and reopen) each connection after each
Nstatements. The default is 0 (connections are not detached). -
Command-Line Format --enable-cleartext-pluginType Boolean Default Value FALSEEnable the
mysql_clear_passwordcleartext authentication plugin. (See Section 8.4.1.4, “Client-Side Cleartext Pluggable Authentication”.) --engine=,engine_name-eengine_nameCommand-Line Format --engine=engine_nameType String The storage engine to use for creating tables.
-
Command-Line Format --get-server-public-keyType Boolean 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_passwordauthentication 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 overfile_name--get-server-public-key.For information about the
caching_sha2_passwordplugin, see Section 8.4.1.2, “Caching SHA-2 Pluggable Authentication”. --host=,host_name-hhost_nameCommand-Line Format --host=host_nameType String Default Value localhostConnect to the MySQL server on the given host.
--iterations=,N-iNCommand-Line Format --iterations=#Type Numeric The number of times to run the tests.
-
Command-Line Format --login-path=nameType String 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 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.
-
Command-Line Format --no-login-pathsSkips reading options from the login path file.
See
--login-pathfor related information.For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.
-
Command-Line Format --no-dropType Boolean Default Value FALSEPrevent mysqlslap from dropping any schema it creates during the test run.
-
Command-Line Format --no-defaultsDo 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 is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when--no-defaultsis used. To create.mylogin.cnf, use the mysql_config_editor utility. See Section 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--number-char-cols=,N-xNCommand-Line Format --number-char-cols=#Type Numeric The number of
VARCHARcolumns to use if--auto-generate-sqlis specified.--number-int-cols=,N-yNCommand-Line Format --number-int-cols=#Type Numeric The number of
INTcolumns to use if--auto-generate-sqlis specified.-
Command-Line Format --number-of-queries=#Type Numeric 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.mysqlslap --delimiter=";" --number-of-queries=10 --query="use test;insert into t values(null)" -
Command-Line Format --only-printType Boolean Default Value FALSEDo not connect to databases. mysqlslap only prints what it would have done.
--password[=,password]-p[password]Command-Line Format --password[=password]Type String 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-pand 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 8.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-passwordoption.The password for multifactor authentication factor 1 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
--password1=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 8.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-password1option.--password1and--passwordare synonymous, as are--skip-password1and--skip-password.The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for
--password1; see the description of that option for details.The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for
--password1; see the description of that option for details.--pipe,-WCommand-Line Format --pipeType String On Windows, connect to the server using a named pipe. This option applies only if the server was started with the
named_pipesystem variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by thenamed_pipe_full_access_groupsystem variable.-
Command-Line Format --plugin-dir=dir_nameType Directory name 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 8.2.17, “Pluggable Authentication”. --port=,port_num-Pport_numCommand-Line Format --port=port_numType Numeric Default Value 3306For TCP/IP connections, the port number to use.
-
Command-Line Format --post-query=valueType String The file or string containing the statement to execute after the tests have completed. This execution is not counted for timing purposes.
-
Command-Line Format --post-system=strType String The string to execute using
system()after the tests have completed. This execution is not counted for timing purposes. -
Command-Line Format --pre-query=valueType String The file or string containing the statement to execute before running the tests. This execution is not counted for timing purposes.
-
Command-Line Format --pre-system=strType String The string to execute using
system()before running the tests. This execution is not counted for timing purposes. -
Command-Line Format --print-defaultsPrint the program name and all options that it gets from option files.
For additional information about this and other option-file options, see Section 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.
--protocol={TCP|SOCKET|PIPE|MEMORY}Command-Line Format --protocol=typeType String Default Value [see text]Valid Values TCPSOCKETPIPEMEMORYThe 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 6.2.7, “Connection Transport Protocols”.
--query=,value-qvalueCommand-Line Format --query=valueType String The file or string containing the
SELECTstatement to use for retrieving data.--server-public-key-path=file_nameCommand-Line Format --server-public-key-path=file_nameType 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(deprecated) orcaching_sha2_passwordauthentication 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 overfile_name--get-server-public-key.For
sha256_password(deprecated), this option applies only if MySQL was built using OpenSSL.For information about the
sha256_passwordandcaching_sha2_passwordplugins, see Section 8.4.1.3, “SHA-256 Pluggable Authentication”, and Section 8.4.1.2, “Caching SHA-2 Pluggable Authentication”.--shared-memory-base-name=nameCommand-Line Format --shared-memory-base-name=namePlatform Specific Windows 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_memorysystem variable enabled to support shared-memory connections.--silent,-sCommand-Line Format --silentSilent mode. No output.
--socket=,path-SpathCommand-Line Format --socket={file_name|pipe_name}Type String 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_pipesystem variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by thenamed_pipe_full_access_groupsystem variable.-
Command-Line Format --sql-mode=modeType String Set the SQL mode for the client session.
Options that begin with
--sslspecify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See Command Options for Encrypted Connections.--ssl-fips-mode={OFF|ON|STRICT}Command-Line Format --ssl-fips-mode={OFF|ON|STRICT}Deprecated Yes Type Enumeration Default Value OFFValid Values OFFONSTRICTControls whether to enable FIPS mode on the client side. The
--ssl-fips-modeoption differs from other--ssl-options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 8.8, “FIPS Support”.xxxThese
--ssl-fips-modevalues are permitted:OFF: Disable FIPS mode.ON: Enable FIPS mode.STRICT: Enable “strict” FIPS mode.
NoteIf the OpenSSL FIPS Object Module is not available, the only permitted value for
--ssl-fips-modeisOFF. In this case, setting--ssl-fips-modetoONorSTRICTcauses the client to produce a warning at startup and to operate in non-FIPS mode.This option is deprecated. Expect it to be removed in a future version of MySQL.
--tls-ciphersuites=ciphersuite_listCommand-Line Format --tls-ciphersuites=ciphersuite_listType String The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.
--tls-sni-servername=server_nameCommand-Line Format --tls-sni-servername=server_nameType String When specified, the name is passed to the
libmysqlclientC API library using theMYSQL_OPT_TLS_SNI_SERVERNAMEoption ofmysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check theTls_sni_server_namestatus variable.Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only.
-
Command-Line Format --tls-version=protocol_listType String Default Value TLSv1,TLSv1.1,TLSv1.2,TLSv1.3(OpenSSL 1.1.1 or higher)TLSv1,TLSv1.1,TLSv1.2(otherwise)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 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.
--user=,user_name-uuser_nameCommand-Line Format --user=user_name,Type String The user name of the MySQL account to use for connecting to the server.
--verbose,-vCommand-Line Format --verboseVerbose mode. Print more information about what the program does. This option can be used multiple times to increase the amount of information.
--version,-VCommand-Line Format --versionDisplay version information and exit.
--zstd-compression-level=levelCommand-Line Format --zstd-compression-level=#Type Integer The compression level to use for connections to the server that use the
zstdcompression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The defaultzstdcompression level is 3. The compression level setting has no effect on connections that do not usezstdcompression.For more information, see Section 6.2.8, “Connection Compression Control”.