OS Manuals

/usr/bin/mysqlslap

The MySQL open source relational database

From mysql-9.7 9.7.4-r4 (enterprise-packages), captured 2026-11-08 by running mysqlslap --help (exit 0). permalink

/usr/bin/mysqlslap  Ver 9.7.4 for Linux on x86_64 (Source distribution)
Copyright (c) 2005, 2026, Oracle and/or its affiliates.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Run a query multiple times against the server.

Usage: /usr/bin/mysqlslap [OPTIONS]

Default options are read from the following files in the given order:
/etc/mysql/my.cnf /etc/my.cnf ~/.my.cnf
The following groups are read: mysqlslap client
The following options may be given as the first argument:
--print-defaults        Print the program argument list and exit.
--no-defaults           Don't read default options from any option file,
                        except for login file.
--defaults-file=#       Only read default options from the given file #.
--defaults-extra-file=# Read this file after the global files are read.
--defaults-group-suffix=#
                        Also read groups with concat(group, suffix)
--login-path=#          Read this path from the login file.
--no-login-paths        Don't read login paths from the login path file.
  -?, --help          Display this help and exit.
  -a, --auto-generate-sql
                      Generate SQL where not supplied by file or command line.
  --auto-generate-sql-add-autoincrement
                      Add an AUTO_INCREMENT column to auto-generated tables.
  --auto-generate-sql-execute-number=#
                      Set this number to generate a set number of queries to
                      run.
  --auto-generate-sql-guid-primary
                      Add GUID based primary keys to auto-generated tables.
  --auto-generate-sql-load-type=name
                      Specify test load type: mixed, update, write, key, or
                      read; default is mixed.
  --auto-generate-sql-secondary-indexes=#
                      Number of secondary indexes to add to auto-generated
                      tables.
  --auto-generate-sql-unique-query-number=#
                      Number of unique queries to generate for automatic tests.
  --auto-generate-sql-unique-write-number=#
                      Number of unique queries to generate for
                      auto-generate-sql-write-number.
  --auto-generate-sql-write-number=#
                      Number of row inserts to perform for each thread (default
                      is 100).
  --commit=#          Commit records every X number of statements.
  -C, --compress      Use compression in server/client protocol.
  -c, --concurrency=name
                      Number of clients to simulate for query to run.
  --create=name       File or string to use create tables.
  --create-schema=name
                      Schema to run tests in.
  --csv[=name]        Generate CSV output to named file or to stdout if no file
                      is named.
  -#, --debug[=#]     This is a non-debug version. Catch this and exit.
  --debug-check       This is a non-debug version. Catch this and exit.
  -T, --debug-info    This is a non-debug version. Catch this and exit.
  --default-auth=name Default authentication client-side plugin to use.
  -F, --delimiter=name
                      Delimiter to use in SQL statements supplied in file or
                      command line.
  --detach=#          Detach (close and reopen) connections after X number of
                      requests.
  --enable-cleartext-plugin
                      Enable/disable the clear text authentication plugin.
  -e, --engine=name   Storage engine to use for creating the table.
  -h, --host=name     Connect to host.
  -i, --iterations=#  Number of times to run the tests.
  --no-drop           Do not drop the schema after the test.
  -x, --number-char-cols=name
                      Number of VARCHAR columns to create in table if
                      specifying --auto-generate-sql.
  -y, --number-int-cols=name
                      Number of INT columns to create in table if specifying
                      --auto-generate-sql.
  --number-of-queries=#
                      Limit each client to this number of queries (this is not
                      exact).
  --only-print        Do not connect to the databases, but instead print out
                      what would have been done.
  -p, --password[=name]
                      Password to use when connecting to server. If password is
                      not given it's asked from the tty.
  --password1[=name]  Password for first factor authentication plugin.
  --password2[=name]  Password for second factor authentication plugin.
  --password3[=name]  Password for third factor authentication plugin.
  --plugin-dir=name   Directory for client-side plugins.
  -P, --port=#        Port number to use for connection.
  --post-query=name   Query to run or file containing query to execute after
                      tests have completed.
  --post-system=name  system() string to execute after tests have completed.
  --pre-query=name    Query to run or file containing query to execute before
                      running tests.
  --pre-system=name   system() string to execute before running tests.
  --protocol=name     The protocol to use for connection (tcp, socket, pipe,
                      memory).
  -q, --query=name    Query to run or file containing query to run.
  -s, --silent        Run program in silent mode - no output.
  -S, --socket=name   The socket file to use for connection.
  --sql-mode=name     Specify sql-mode to run mysqlslap tool.
  --server-public-key-path=name
                      File path to the server public RSA key in PEM format.
  --get-server-public-key
                      Get server public key
  --ssl-mode=name     SSL connection mode.
  --ssl-ca=name       CA file in PEM format.
  --ssl-capath=name   CA directory.
  --ssl-cert=name     X509 cert in PEM format.
  --ssl-cipher=name   SSL cipher to use.
  --ssl-key=name      X509 key in PEM format.
  --ssl-crl=name      Certificate revocation list.
  --ssl-crlpath=name  Certificate revocation list path.
  --tls-version=name  TLS version to use, permitted values are: TLSv1.2,
                      TLSv1.3
  --ssl-fips-mode=name
                      SSL FIPS mode (applies only for OpenSSL); permitted
                      values are: OFF, ON, STRICT
  --tls-ciphersuites=name
                      TLS v1.3 cipher to use.
  --ssl-session-data=name
                      Session data file to use to enable ssl session reuse
  --ssl-session-data-continue-on-failed-reuse
                      If set to ON, this option will allow connection to
                      succeed even if session data cannot be reused.
  --tls-sni-servername=name
                      The SNI server name to pass to server
  -u, --user=name     User for login if not current user.
  -v, --verbose       More verbose output; you can use this multiple times to
                      get even more verbose output.
  -V, --version       Output version information and exit.
  --compression-algorithms=name
                      Use compression algorithm in server/client protocol.
                      Valid values are any combination of
                      'zstd','zlib','uncompressed'.
  --zstd-compression-level=#
                      Use this compression level in the client/server protocol,
                      in case --compression-algorithms=zstd. Valid range is
                      between 1 and 22, inclusive. Default is 3.
Options (72)
OptionDescriptionSource
--print-defaultsPrint the program argument list and exit.help
--no-defaultsDon't read default options from any option file, except for login file.help
--defaults-file #Only read default options from the given file #.help
--defaults-group-suffix #Also read groups with concat(group, suffix)help
--login-path #Read this path from the login file.help
--no-login-pathsDon't read login paths from the login path file.help
-?, --helpDisplay this help and exit.help
-a, --auto-generate-sqlGenerate SQL where not supplied by file or command line.help
--auto-generate-sql-add-autoincrementAdd an AUTO_INCREMENT column to auto-generated tables.help
--auto-generate-sql-execute-number #Set this number to generate a set number of queries to run.help
--auto-generate-sql-guid-primaryAdd GUID based primary keys to auto-generated tables.help
--auto-generate-sql-load-type nameSpecify test load type: mixed, update, write, key, or read;help
--auto-generate-sql-secondary-indexes #Number of secondary indexes to add to auto-generated tables.help
--auto-generate-sql-unique-query-number #Number of unique queries to generate for automatic tests.help
--auto-generate-sql-unique-write-number #Number of unique queries to generate for auto-generate-sql-write-number.help
--auto-generate-sql-write-number #Number of row inserts to perform for each thread (default is 100).help
--commit #Commit records every X number of statements.help
-C, --compressUse compression in server/client protocol.help
-c, --concurrency nameNumber of clients to simulate for query to run.help
--create nameFile or string to use create tables.help
--create-schema nameSchema to run tests in.help
--csv nameGenerate CSV output to named file or to stdout if no file is named.help
-#, --debug #This is a non-debug version.help
--debug-checkThis is a non-debug version.help
-T, --debug-infoThis is a non-debug version.help
-F, --delimiter nameDelimiter to use in SQL statements supplied in file or command line.help
--detach #Detach (close and reopen) connections after X number of requests.help
--enable-cleartext-pluginEnable/disable the clear text authentication plugin.help
-e, --engine nameStorage engine to use for creating the table.help
-h, --host nameConnect to host.help
-i, --iterations #Number of times to run the tests.help
--no-dropDo not drop the schema after the test.help
-x, --number-char-cols nameNumber of VARCHAR columns to create in table if specifying --auto-generate-sql.help
-y, --number-int-cols nameNumber of INT columns to create in table if specifyinghelp
--number-of-queries #Limit each client to this number of queries (this is not exact).help
--only-printDo not connect to the databases, but instead print out what would have been done.help
-p, --password namePassword to use when connecting to server.help
--password1 name•--password2[=pass_val] The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server.help + man
--password2 namePassword for second factor authentication plugin.help
--password3 namePassword for third factor authentication plugin.help
--plugin-dir nameDirectory for client-side plugins.help
-P, --port #Port number to use for connection.help
--post-query nameQuery to run or file containing query to execute after tests have completed.help
--post-system namesystem() string to execute after tests have completed.help
--pre-query nameQuery to run or file containing query to execute before running tests.help
--pre-system namesystem() string to execute before running tests.help
--protocol nameThe protocol to use for connection (tcp, socket, pipe, memory).help
-q, --query nameQuery to run or file containing query to run.help
-s, --silentRun program in silent mode - no output.help
-S, --socket nameThe socket file to use for connection.help
--sql-mode nameSpecify sql-mode to run mysqlslap tool.help
--server-public-key-path nameFile path to the server public RSA key in PEM format.help
--get-server-public-keyGet server public keyhelp
--ssl-mode nameSSL connection mode.help
--ssl-ca nameCA file in PEM format.help
--ssl-capath nameCA directory.help
--ssl-cert nameX509 cert in PEM format.help
--ssl-cipher nameSSL cipher to use.help
--ssl-key nameX509 key in PEM format.help
--ssl-crl nameCertificate revocation list.help
--ssl-crlpath nameCertificate revocation list path.help
--tls-version nameTLS version to use, permitted values are: TLSv1.2, TLSv1.3help
--ssl-fips-mode nameSSL FIPS mode (applies only for OpenSSL);help
--tls-ciphersuites nameTLS v1.3 cipher to use.help
--ssl-session-data nameSession data file to use to enable ssl session reusehelp
--ssl-session-data-continue-on-failed-reuseIf set to ON, this option will allow connection to succeed even if session data cannot be reused.help
--tls-sni-servername nameThe SNI server name to pass to serverhelp
-u, --user nameUser for login if not current user.help
-v, --verboseMore verbose output;help
-V, --versionOutput version information and exit.help
--compression-algorithms nameUse compression algorithm in server/client protocol.help
--zstd-compression-level #Use this compression level in the client/server protocol, in case --compression-algorithms=zstd.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.