4.5.7 mysqlslap — 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. mysqlslap is available as of MySQL 5.1.4.

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:

  1. Create schema, table, and optionally any stored programs or data to use for the test. This stage uses a single client connection.

  2. Run the load test. This stage can use many client connections.

  3. 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 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] groups of an option file. For information about option files, see Section 4.2.6, “Using Option Files”.

Table 4.8 mysqlslap Options

FormatOption FileDescriptionIntroducedRemoved
--auto-generate-sqlauto-generate-sqlGenerate SQL statements automatically when they are not supplied in files or using command options  
--auto-generate-sql-add-autoincrementauto-generate-sql-add-autoincrementAdd AUTO_INCREMENT column to automatically generated tables5.1.18 
--auto-generate-sql-execute-number=#auto-generate-sql-execute-numberSpecify how many queries to generate automatically5.1.18 
--auto-generate-sql-guid-primaryauto-generate-sql-guid-primaryAdd a GUID-based primary key to automatically generated tables5.1.18 
--auto-generate-sql-load-type=typeauto-generate-sql-load-typeSpecify how many queries to generate automatically5.1.16 
--auto-generate-sql-secondary-indexes=#auto-generate-sql-secondary-indexesSpecify how many secondary indexes to add to automatically generated tables5.1.18 
--auto-generate-sql-unique-query-number=#auto-generate-sql-unique-query-numberHow many different queries to generate for automatic tests.5.1.18 
--auto-generate-sql-unique-write-number=#auto-generate-sql-unique-write-numberHow many different queries to generate for --auto-generate-sql-write-number5.1.18 
--auto-generate-sql-write-number=#auto-generate-sql-write-numberHow many row inserts to perform on each thread5.1.16 
--commit=#commitHow many statements to execute before committing.5.1.21 
--compresscompressCompress all information sent between client and server  
--concurrency=#concurrencyNumber of clients to simulate when issuing the SELECT statement  
--create=valuecreateFile or string containing the statement to use for creating the table  
--create-schema=valuecreate-schemaSchema in which to run the tests5.1.5 
--csv=[file]csvGenerate output in comma-separated values format  
--debug[=debug_options]debugWrite a debugging log  
--debug-checkdebug-checkPrint debugging information when program exits5.1.21 
--debug-infodebug-infoPrint debugging information, memory, and CPU statistics when program exits5.1.21 
--defaults-extra-file=file_name Read option file in addition to usual option files  
--defaults-file=file_name Read only named option file  
--defaults-group-suffix=str Option group suffix value  
--delimiter=strdelimiterDelimiter to use in SQL statements  
--detach=#detachDetach (close and reopen) each connection after each N statements5.1.21 
--engine=engine_nameengineStorage engine to use for creating the table  
--help Display help message and exit  
--host=host_namehostConnect to MySQL server on given host  
--iterations=#iterationsNumber of times to run the tests  
--lock-directory=pathlock-directoryDirectory to use for storing locks5.1.55.1.18
--no-defaults Read no option files  
--no-dropno-dropDo not drop any schema created during the test run5.1.57 
--number-char-cols=#number-char-colsNumber of VARCHAR columns to use if --auto-generate-sql is specified  
--number-int-cols=#number-int-colsNumber of INT columns to use if --auto-generate-sql is specified  
--number-of-queries=#number-of-queriesLimit each client to approximately this number of queries5.1.5 
--only-printonly-printDo not connect to databases. mysqlslap only prints what it would have done5.1.5 
--password[=password]passwordPassword to use when connecting to server  
--pipepipeOn Windows, connect to server using named pipe  
--port=port_numportTCP/IP port number to use for connection  
--post-query=valuepost-queryFile or string containing the statement to execute after the tests have completed5.1.18 
--post-system=strpost-systemString to execute using system() after the tests have completed5.1.21 
--pre-query=valuepre-queryFile or string containing the statement to execute before running the tests5.1.18 
--pre-system=strpre-systemString to execute using system() before running the tests5.1.21 
--preserve-schemapreserve-schemaPreserve the schema from the mysqlslap run5.1.55.1.23
--print-defaults Print defaults  
--protocol=typeprotocolConnection protocol to use  
--query=valuequeryFile or string containing the SELECT statement to use for retrieving data  
--shared-memory-base-name=nameshared-memory-base-nameThe name of shared memory to use for shared-memory connections  
--silentsilentSilent mode  
--slaveslaveFollow master locks for other mysqlslap clients5.1.55.1.18
--socket=pathsocketFor connections to localhost, the Unix socket file to use  
--sslsslEnable SSL for connection  
--ssl-ca=file_namessl-caPath of file that contains list of trusted SSL CAs  
--ssl-capath=dir_namessl-capathPath of directory that contains trusted SSL CA certificates in PEM format  
--ssl-cert=file_namessl-certPath of file that contains X509 certificate in PEM format  
--ssl-cipher=cipher_listssl-cipherList of permitted ciphers to use for SSL encryption  
--ssl-key=file_namessl-keyPath of file that contains X509 key in PEM format5.1.11 
--ssl-verify-server-certssl-verify-server-certVerify server Common Name value in its certificate against host name used when connecting to server  
--use-threadsuse-threadsOn Unix, the default is to use fork() calls5.1.65.1.18
--user=user_name,userMySQL user name to use when connecting to server  
--verbose Verbose mode  
--version Display version information and exit