Linux "mysqlslap" Command Line Options and Examples
load emulation client
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.
Usage:
mysqlslap [options]
Command Line Options:
--create
TABLE a (b int);INSERT INTO a VALUES (23)"
mysqlslap --create ...
--query="SELECT
Let mysqlslap build the query SQL statement with a table of two INT columns and three VARCHAR columns. Use five clients querying 20times 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
mysqlslap --query="SELECT ...
--number-int-cols
--number-char-cols=3
mysqlslap --number-int-cols ...
--auto-generate-sql
Tell the program to load the create, insert, and query SQL statements from the specified files, where the create.sql file hasmultiple table creation statements delimited by ';' and multiple insert statements delimited by ';'. The --query file will havemultiple queries delimited by ';'. Run all the load statements, then run all the queries in the query file with five clients (fivetimes each):mysqlslap --concurrency=5
mysqlslap --auto-generate-sql ...
--iterations
--query=query.sql --create=create.sql
mysqlslap --iterations ...
--delimiter
mysqlslap supports the following options, which can be specified on the command line or in the [mysqlslap] and [client] groups of anoption file. For information about option files used by MySQL programs, see Section 4.2.2.2, “Using Option Files”.
mysqlslap --delimiter ...
--help
Display a help message and exit.
mysqlslap --help ...
--auto-generate-sql-add-autoincrement
Add an AUTO_INCREMENT column to automatically generated tables.
mysqlslap --auto-generate-sql-add-autoincrement ...
--auto-generate-sql-execute-number
Specify how many queries to generate automatically.
mysqlslap --auto-generate-sql-execute-number ...
--auto-generate-sql-guid-primary
Add a GUID-based primary key to automatically generated tables.
mysqlslap --auto-generate-sql-guid-primary ...
--auto-generate-sql-load-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.
mysqlslap --auto-generate-sql-load-type ...
--auto-generate-sql-secondary-indexes
Specify how many secondary indexes to add to automatically generated tables. By default, none are added.
mysqlslap --auto-generate-sql-secondary-indexes ...
--auto-generate-sql-unique-query-number
How many different queries to generate for automatic tests. For example, if you run a key test that performs 1000 selects, youcan use this option with a value of 1000 to run 1000 unique queries, or with a value of 50 to perform 50 different selects. Thedefault is 10.
mysqlslap --auto-generate-sql-unique-query-number ...
--auto-generate-sql-unique-write-number
How many different queries to generate for --auto-generate-sql-write-number. The default is 10.
mysqlslap --auto-generate-sql-unique-write-number ...
--auto-generate-sql-write-number
How many row inserts to perform. The default is 100.
mysqlslap --auto-generate-sql-write-number ...
--commit
How many statements to execute before committing. The default is 0 (no commits are done).
mysqlslap --commit ...
--compress
Compress all information sent between the client and the server if possible. See Section 4.2.6, “Connection Compression Control”.As of MySQL 8.0.18, this option is deprecated. It will be removed in a future MySQL version. See the section called “LegacyConnection Compression Configuration”.
mysqlslap --compress ...
--concurrency
The number of parallel clients to simulate.
mysqlslap --concurrency ...
--create-schema
The schema in which to run the tests.NoteIf the --auto-generate-sql option is also given, mysqlslap drops the schema at the end of the test run. To avoid this, usethe --no-drop option as well.
mysqlslap --create-schema ...
--csv[
Generate output in comma-separated values format. The output goes to the named file, or to the standard output if no file isgiven.
mysqlslap --csv[ ...
--debug[
Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o,/tmp/mysqlslap.trace.
mysqlslap --debug[ ...
--debug-check
Print some debugging information when the program exits.
mysqlslap --debug-check ...
--debug-info
Print debugging information and memory and CPU usage statistics when the program exits.
mysqlslap --debug-info ...
--default-auth
A hint about which client-side authentication plugin to use. See Section 6.2.17, “Pluggable Authentication”.
mysqlslap --default-auth ...
--defaults-extra-file
Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or isotherwise inaccessible, an error occurs. file_name is interpreted relative to the current directory if given as a relative pathname 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 AffectOption-File Handling”.
mysqlslap --defaults-extra-file ...
--defaults-file
Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. file_name isinterpreted 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 AffectOption-File Handling”.
mysqlslap --defaults-file ...
--defaults-group-suffix
Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysqlslap normallyreads 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 AffectOption-File Handling”.
mysqlslap --defaults-group-suffix ...
--detach
Detach (close and reopen) each connection after each N statements. The default is 0 (connections are not detached).
mysqlslap --detach ...
--enable-cleartext-plugin
Enable the mysql_clear_password cleartext authentication plugin. (See Section 6.4.1.4, “Client-Side Cleartext PluggableAuthentication”.)
mysqlslap --enable-cleartext-plugin ...
--engine
The storage engine to use for creating tables.
mysqlslap --engine ...
--get-server-public-key
Request from the server the RSA public key that it uses for key pair-based password exchange. This option applies to clients thatconnect to the server using an account that authenticates with the caching_sha2_password authentication plugin. For connectionsby such accounts, the server does not send the public key to the client unless requested. The option is ignored for accounts thatdo not authenticate with that plugin. It is also ignored if RSA-based password exchange is not needed, as is the case when theclient connects to the server using a secure connection.If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over
mysqlslap --get-server-public-key ...
--get-server-public-key.
For information about the caching_sha2_password plugin, see Section 6.4.1.3, “Caching SHA-2 Pluggable Authentication”.
mysqlslap --get-server-public-key. ...
--host
Connect to the MySQL server on the given host.
mysqlslap --host ...
--login-path
Read options from the named login path in the .mylogin.cnf login path file. A “login path” is an option group containing optionsthat specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, usethe mysql_config_editor utility. See mysql_config_editor(1).For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that AffectOption-File Handling”.
mysqlslap --login-path ...
--no-drop
Prevent mysqlslap from dropping any schema it creates during the test run.
mysqlslap --no-drop ...
--no-defaults
Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can beused 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 asafer way than on the command line even when --no-defaults is used. (.mylogin.cnf is created by the mysql_config_editor utility.See mysql_config_editor(1).)For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that AffectOption-File Handling”.
mysqlslap --no-defaults ...
--number-char-cols
The number of VARCHAR columns to use if --auto-generate-sql is specified.
mysqlslap --number-char-cols ...
--number-of-queries
Limit each client to approximately this many queries. Query counting takes into account the statement delimiter. For example, ifyou 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
mysqlslap --number-of-queries ...
--query
test;insert into t values(null)"
mysqlslap --query ...
--only-print
Do not connect to databases. mysqlslap only prints what it would have done.
mysqlslap --only-print ...
--password[
The password of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlslapprompts for one. If given, there must be no space between --password= or -p and the password following it. If no password optionis 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 anoption 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.
mysqlslap --password[ ...
--pipe
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 theWindows group specified by the named_pipe_full_access_group system variable.
mysqlslap --pipe ...
--plugin-dir
The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authenticationplugin but mysqlslap does not find it. See Section 6.2.17, “Pluggable Authentication”.
mysqlslap --plugin-dir ...
--port
For TCP/IP connections, the port number to use.
mysqlslap --port ...
--post-query
The file or string containing the statement to execute after the tests have completed. This execution is not counted for timingpurposes.
mysqlslap --post-query ...
--post-system
The string to execute using system() after the tests have completed. This execution is not counted for timing purposes.
mysqlslap --post-system ...
--pre-query
The file or string containing the statement to execute before running the tests. This execution is not counted for timingpurposes.
mysqlslap --pre-query ...
--pre-system
The string to execute using system() before running the tests. This execution is not counted for timing purposes.
mysqlslap --pre-system ...
--print-defaults
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 AffectOption-File Handling”.
mysqlslap --print-defaults ...
--protocol
The connection protocol to use for connecting to the server. It is useful when the other connection parameters normally result inuse of a protocol other than the one you want. For details on the permissible values, see Section 4.2.4, “Connecting to the MySQLServer Using Command Options”.
mysqlslap --protocol ...
--secure-auth
This option was removed in MySQL 8.0.3.
mysqlslap --secure-auth ...
--server-public-key-path
The path name to a file containing a client-side copy of the public key required by the server for RSA key pair-based passwordexchange. The file must be in PEM format. This option applies to clients that authenticate with the sha256_password orcaching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of thoseplugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the serverusing a secure connection.If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over
mysqlslap --server-public-key-path ...
--shared-memory-base-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-memoryconnections.
mysqlslap --shared-memory-base-name ...
--silent
Silent mode. No output.
mysqlslap --silent ...
--socket
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-pipeconnections. In addition, the user making the connection must be a member of the Windows group specified by thenamed_pipe_full_access_group system variable.
mysqlslap --socket ...
--sql-mode
Set the SQL mode for the client session.
mysqlslap --sql-mode ...
--ssl*
Options that begin with --ssl specify whether to connect to the server using SSL and indicate where to find SSL keys andcertificates. See the section called “Command Options for Encrypted Connections”.
mysqlslap --ssl* ...
--tls-ciphersuites
The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separatedciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. Fordetails, see Section 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”.This option was added in MySQL 8.0.16.
mysqlslap --tls-ciphersuites ...
--tls-version
The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. Theprotocols 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”.
mysqlslap --tls-version ...
--user
The user name of the MySQL account to use for connecting to the server.
mysqlslap --user ...
--verbose
Verbose mode. Print more information about what the program does. This option can be used multiple times to increase the amountof information.
mysqlslap --verbose ...
--version
Display version information and exit.
mysqlslap --version ...