{
    "content": [
        {
            "type": "text",
            "text": "# mysqlslap (man)\n\n## NAME\n\nmysqlslap - a load emulation client\n\n## SYNOPSIS\n\nmysqlslap [options]\n\n## DESCRIPTION\n\nmysqlslap is a diagnostic program designed to emulate client load for a MySQL server and to\nreport the timing of each stage. It works as if multiple clients are accessing the server.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **COPYRIGHT**\n- **SEE ALSO**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "mysqlslap",
        "section": "",
        "mode": "man",
        "summary": "mysqlslap - a load emulation client",
        "synopsis": "mysqlslap [options]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 897,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 15,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "mysqlslap - a load emulation client\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "mysqlslap [options]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "mysqlslap is a diagnostic program designed to emulate client load for a MySQL server and to\nreport the timing of each stage. It works as if multiple clients are accessing the server.\n\nInvoke mysqlslap like this:\n\nmysqlslap [options]\n\nSome options such as --create or --query enable you to specify a string containing an SQL\nstatement or a file containing statements. If you specify a file, by default it must contain\none statement per line. (That is, the implicit statement delimiter is the newline character.)\nUse the --delimiter option to specify a different delimiter, which enables you to specify\nstatements that span multiple lines or place multiple statements on a single line. You cannot\ninclude comments in a file; mysqlslap does not understand them.\n\nmysqlslap runs in three stages:\n\n1. Create schema, table, and optionally any stored programs or data to use for the test.\nThis stage uses a single client connection.\n\n2. Run the load test. This stage can use many client connections.\n\n3. Clean up (disconnect, drop table if specified). This stage uses a single client\nconnection.\n\nExamples:\n\nSupply your own create and query SQL statements, with 50 clients querying and 200 selects for\neach (enter the command on a single line):\n\nmysqlslap --delimiter=\";\"\n--create=\"CREATE TABLE a (b int);INSERT INTO a VALUES (23)\"\n--query=\"SELECT * FROM a\" --concurrency=50 --iterations=200\n\nLet mysqlslap build the query SQL statement with a table of two INT columns and three VARCHAR\ncolumns. Use five clients querying 20 times each. Do not create the table or insert the data\n(that is, use the previous test's schema and data):\n\nmysqlslap --concurrency=5 --iterations=20\n--number-int-cols=2 --number-char-cols=3\n--auto-generate-sql\n\nTell the program to load the create, insert, and query SQL statements from the specified\nfiles, where the create.sql file has multiple table creation statements delimited by ';' and\nmultiple insert statements delimited by ';'. The --query file should contain multiple queries\ndelimited by ';'. Run all the load statements, then run all the queries in the query file\nwith five clients (five times each):\n\nmysqlslap --concurrency=5\n--iterations=5 --query=query.sql --create=create.sql\n--delimiter=\";\"\n\nmysqlslap supports the following options, which can be specified on the command line or in\nthe [mysqlslap] and [client] groups of an option file. For information about option files\nused by MySQL programs, see Section 6.2.2.2, “Using Option Files”.\n\n•   --help, -?\n\n┌────────────────────┬────────┐\n│Command-Line Format │ --help │\n└────────────────────┴────────┘\nDisplay a help message and exit.\n\n•   --auto-generate-sql, -a\n\n┌────────────────────┬─────────────────────┐\n│Command-Line Format │ --auto-generate-sql │\n├────────────────────┼─────────────────────┤\n│Type                │ Boolean             │\n├────────────────────┼─────────────────────┤\n│Default Value       │ FALSE               │\n└────────────────────┴─────────────────────┘\nGenerate SQL statements automatically when they are not supplied in files or using\ncommand options.\n\n•   --auto-generate-sql-add-autoincrement\n\n┌────────────────────┬──────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-add- │\n│                    │ autoincrement            │\n├────────────────────┼──────────────────────────┤\n│Type                │ Boolean                  │\n├────────────────────┼──────────────────────────┤\n│Default Value       │ FALSE                    │\n└────────────────────┴──────────────────────────┘\nAdd an AUTOINCREMENT column to automatically generated tables.\n\n•   --auto-generate-sql-execute-number=N\n\n┌────────────────────┬──────────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-execute- │\n│                    │ number=#                     │\n├────────────────────┼──────────────────────────────┤\n│Type                │ Numeric                      │\n└────────────────────┴──────────────────────────────┘\nSpecify how many queries to generate automatically.\n\n•   --auto-generate-sql-guid-primary\n\n┌────────────────────┬──────────────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-guid-primary │\n├────────────────────┼──────────────────────────────────┤\n│Type                │ Boolean                          │\n├────────────────────┼──────────────────────────────────┤\n│Default Value       │ FALSE                            │\n└────────────────────┴──────────────────────────────────┘\nAdd a GUID-based primary key to automatically generated tables.\n\n•   --auto-generate-sql-load-type=type\n\n┌────────────────────┬───────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-load- │\n│                    │ type=type                 │\n├────────────────────┼───────────────────────────┤\n│Type                │ Enumeration               │\n├────────────────────┼───────────────────────────┤\n│Default Value       │ mixed                     │\n├────────────────────┼───────────────────────────┤\n│Valid Values        │                           │\n│                    │            read           │\n│                    │                           │\n│                    │            write          │\n│                    │                           │\n│                    │            key            │\n│                    │                           │\n│                    │            update         │\n│                    │                           │\n│                    │            mixed          │\n└────────────────────┴───────────────────────────┘\nSpecify the test load type. The permissible values are read (scan tables), write (insert\ninto tables), key (read primary keys), update (update primary keys), or mixed (half\ninserts, half scanning selects). The default is mixed.\n\n•   --auto-generate-sql-secondary-indexes=N\n\n┌────────────────────┬────────────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-secondary- │\n│                    │ indexes=#                      │\n├────────────────────┼────────────────────────────────┤\n│Type                │ Numeric                        │\n├────────────────────┼────────────────────────────────┤\n│Default Value       │ 0                              │\n└────────────────────┴────────────────────────────────┘\nSpecify how many secondary indexes to add to automatically generated tables. By default,\nnone are added.\n\n•   --auto-generate-sql-unique-query-number=N\n\n┌────────────────────┬───────────────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-unique-query- │\n│                    │ number=#                          │\n├────────────────────┼───────────────────────────────────┤\n│Type                │ Numeric                           │\n├────────────────────┼───────────────────────────────────┤\n│Default Value       │ 10                                │\n└────────────────────┴───────────────────────────────────┘\nHow many different queries to generate for automatic tests. For example, if you run a key\ntest that performs 1000 selects, you can use this option with a value of 1000 to run 1000\nunique queries, or with a value of 50 to perform 50 different selects. The default is 10.\n\n•   --auto-generate-sql-unique-write-number=N\n\n┌────────────────────┬───────────────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-unique-write- │\n│                    │ number=#                          │\n├────────────────────┼───────────────────────────────────┤\n│Type                │ Numeric                           │\n├────────────────────┼───────────────────────────────────┤\n│Default Value       │ 10                                │\n└────────────────────┴───────────────────────────────────┘\nHow many different queries to generate for --auto-generate-sql-write-number. The default\nis 10.\n\n•   --auto-generate-sql-write-number=N\n\n┌────────────────────┬────────────────────────────┐\n│Command-Line Format │ --auto-generate-sql-write- │\n│                    │ number=#                   │\n├────────────────────┼────────────────────────────┤\n│Type                │ Numeric                    │\n├────────────────────┼────────────────────────────┤\n│Default Value       │ 100                        │\n└────────────────────┴────────────────────────────┘\nHow many row inserts to perform. The default is 100.\n\n•   --commit=N\n\n┌────────────────────┬────────────┐\n│Command-Line Format │ --commit=# │\n├────────────────────┼────────────┤\n│Type                │ Numeric    │\n├────────────────────┼────────────┤\n│Default Value       │ 0          │\n└────────────────────┴────────────┘\nHow many statements to execute before committing. The default is 0 (no commits are done).\n\n•   --compress, -C\n\n┌────────────────────┬───────────────────────┐\n│Command-Line Format │ --compress[={OFF|ON}] │\n├────────────────────┼───────────────────────┤\n│Deprecated          │ 8.0.18                │\n├────────────────────┼───────────────────────┤\n│Type                │ Boolean               │\n├────────────────────┼───────────────────────┤\n│Default Value       │ OFF                   │\n└────────────────────┴───────────────────────┘\nCompress all information sent between the client and the server if possible. See\nSection 6.2.8, “Connection Compression Control”.\n\nAs of MySQL 8.0.18, this option is deprecated. Expect it to be removed in a future\nversion of MySQL. See the section called “Configuring Legacy Connection Compression”.\n\n•   --compression-algorithms=value\n\n┌────────────────────┬────────────────────────────────┐\n│Command-Line Format │ --compression-algorithms=value │\n├────────────────────┼────────────────────────────────┤\n│Introduced          │ 8.0.18                         │\n├────────────────────┼────────────────────────────────┤\n│Type                │ Set                            │\n├────────────────────┼────────────────────────────────┤\n│Default Value       │ uncompressed                   │\n├────────────────────┼────────────────────────────────┤\n│Valid Values        │                                │\n│                    │            zlib                │\n│                    │                                │\n│                    │            zstd                │\n│                    │                                │\n│                    │            uncompressed        │\n└────────────────────┴────────────────────────────────┘\nThe permitted compression algorithms for connections to the server. The available\nalgorithms are the same as for the protocolcompressionalgorithms system variable. The\ndefault value is uncompressed.\n\nFor more information, see Section 6.2.8, “Connection Compression Control”.\n\nThis option was added in MySQL 8.0.18.\n\n•   --concurrency=N, -c N\n\n┌────────────────────┬─────────────────┐\n│Command-Line Format │ --concurrency=# │\n├────────────────────┼─────────────────┤\n│Type                │ Numeric         │\n└────────────────────┴─────────────────┘\nThe number of parallel clients to simulate.\n\n•   --create=value\n\n┌────────────────────┬────────────────┐\n│Command-Line Format │ --create=value │\n├────────────────────┼────────────────┤\n│Type                │ String         │\n└────────────────────┴────────────────┘\nThe file or string containing the statement to use for creating the table.\n\n•   --create-schema=value\n\n┌────────────────────┬───────────────────────┐\n│Command-Line Format │ --create-schema=value │\n├────────────────────┼───────────────────────┤\n│Type                │ String                │\n└────────────────────┴───────────────────────┘\nThe schema in which to run the tests.\n\nNote\nIf the --auto-generate-sql option is also given, mysqlslap drops the schema at the\nend of the test run. To avoid this, use the --no-drop option as well.\n\n•   --csv[=filename]\n\n┌────────────────────┬──────────────┐\n│Command-Line Format │ --csv=[file] │\n├────────────────────┼──────────────┤\n│Type                │ File name    │\n└────────────────────┴──────────────┘\nGenerate output in comma-separated values format. The output goes to the named file, or\nto the standard output if no file is given.\n\n•   --debug[=debugoptions], -# [debugoptions]\n\n┌────────────────────┬────────────────────────────┐\n│Command-Line Format │ --debug[=debugoptions]    │\n├────────────────────┼────────────────────────────┤\n│Type                │ String                     │\n├────────────────────┼────────────────────────────┤\n│Default Value       │ d:t:o,/tmp/mysqlslap.trace │\n└────────────────────┴────────────────────────────┘\nWrite a debugging log. A typical debugoptions string is d:t:o,filename. The default is\nd:t:o,/tmp/mysqlslap.trace.\n\nThis option is available only if MySQL was built using WITHDEBUG. MySQL release binaries\nprovided by Oracle are not built using this option.\n\n•   --debug-check\n\n┌────────────────────┬───────────────┐\n│Command-Line Format │ --debug-check │\n├────────────────────┼───────────────┤\n│Type                │ Boolean       │\n├────────────────────┼───────────────┤\n│Default Value       │ FALSE         │\n└────────────────────┴───────────────┘\nPrint some debugging information when the program exits.\n\nThis option is available only if MySQL was built using WITHDEBUG. MySQL release binaries\nprovided by Oracle are not built using this option.\n\n•   --debug-info, -T\n\n┌────────────────────┬──────────────┐\n│Command-Line Format │ --debug-info │\n├────────────────────┼──────────────┤\n│Type                │ Boolean      │\n├────────────────────┼──────────────┤\n│Default Value       │ FALSE        │\n└────────────────────┴──────────────┘\nPrint debugging information and memory and CPU usage statistics when the program exits.\n\nThis option is available only if MySQL was built using WITHDEBUG. MySQL release binaries\nprovided by Oracle are not built using this option.\n\n•   --default-auth=plugin\n\n┌────────────────────┬───────────────────────┐\n│Command-Line Format │ --default-auth=plugin │\n├────────────────────┼───────────────────────┤\n│Type                │ String                │\n└────────────────────┴───────────────────────┘\nA hint about which client-side authentication plugin to use. See Section 8.2.17,\n“Pluggable Authentication”.\n\n•   --defaults-extra-file=filename\n\n┌────────────────────┬─────────────────────────────────┐\n│Command-Line Format │ --defaults-extra-file=filename │\n├────────────────────┼─────────────────────────────────┤\n│Type                │ File name                       │\n└────────────────────┴─────────────────────────────────┘\nRead this option file after the global option file but (on Unix) before the user option\nfile. If the file does not exist or is otherwise inaccessible, an error occurs. If\nfilename is not an absolute path name, it is interpreted relative to the current\ndirectory.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --defaults-file=filename\n\n┌────────────────────┬───────────────────────────┐\n│Command-Line Format │ --defaults-file=filename │\n├────────────────────┼───────────────────────────┤\n│Type                │ File name                 │\n└────────────────────┴───────────────────────────┘\nUse only the given option file. If the file does not exist or is otherwise inaccessible,\nan error occurs. If filename is not an absolute path name, it is interpreted relative to\nthe current directory.\n\nException: Even with --defaults-file, client programs read .mylogin.cnf.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --defaults-group-suffix=str\n\n┌────────────────────┬─────────────────────────────┐\n│Command-Line Format │ --defaults-group-suffix=str │\n├────────────────────┼─────────────────────────────┤\n│Type                │ String                      │\n└────────────────────┴─────────────────────────────┘\nRead not only the usual option groups, but also groups with the usual names and a suffix\nof str. For example, mysqlslap normally reads the [client] and [mysqlslap] groups. If\nthis option is given as --defaults-group-suffix=other, mysqlslap also reads the\n[clientother] and [mysqlslapother] groups.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --delimiter=str, -F str\n\n┌────────────────────┬─────────────────┐\n│Command-Line Format │ --delimiter=str │\n├────────────────────┼─────────────────┤\n│Type                │ String          │\n└────────────────────┴─────────────────┘\nThe delimiter to use in SQL statements supplied in files or using command options.\n\n•   --detach=N\n\n┌────────────────────┬────────────┐\n│Command-Line Format │ --detach=# │\n├────────────────────┼────────────┤\n│Type                │ Numeric    │\n├────────────────────┼────────────┤\n│Default Value       │ 0          │\n└────────────────────┴────────────┘\nDetach (close and reopen) each connection after each N statements. The default is 0\n(connections are not detached).\n\n•   --enable-cleartext-plugin\n\n┌────────────────────┬───────────────────────────┐\n│Command-Line Format │ --enable-cleartext-plugin │\n├────────────────────┼───────────────────────────┤\n│Type                │ Boolean                   │\n├────────────────────┼───────────────────────────┤\n│Default Value       │ FALSE                     │\n└────────────────────┴───────────────────────────┘\nEnable the mysqlclearpassword cleartext authentication plugin. (See Section 8.4.1.4,\n“Client-Side Cleartext Pluggable Authentication”.)\n\n•   --engine=enginename, -e enginename\n\n┌────────────────────┬──────────────────────┐\n│Command-Line Format │ --engine=enginename │\n├────────────────────┼──────────────────────┤\n│Type                │ String               │\n└────────────────────┴──────────────────────┘\nThe storage engine to use for creating tables.\n\n•   --get-server-public-key\n\n┌────────────────────┬─────────────────────────┐\n│Command-Line Format │ --get-server-public-key │\n├────────────────────┼─────────────────────────┤\n│Type                │ Boolean                 │\n└────────────────────┴─────────────────────────┘\nRequest from the server the RSA public key that it uses for key pair-based password\nexchange. This option applies to clients that connect to the server using an account that\nauthenticates with the cachingsha2password authentication plugin. For connections by\nsuch accounts, the server does not send the public key to the client unless requested.\nThe option is ignored for accounts that do not authenticate with that plugin. It is also\nignored if RSA-based password exchange is not needed, as is the case when the client\nconnects to the server using a secure connection.\n\nIf --server-public-key-path=filename is given and specifies a valid public key file, it\ntakes precedence over --get-server-public-key.\n\nFor information about the cachingsha2password plugin, see Section 8.4.1.2, “Caching\nSHA-2 Pluggable Authentication”.\n\n•   --host=hostname, -h hostname\n\n┌────────────────────┬──────────────────┐\n│Command-Line Format │ --host=hostname │\n├────────────────────┼──────────────────┤\n│Type                │ String           │\n├────────────────────┼──────────────────┤\n│Default Value       │ localhost        │\n└────────────────────┴──────────────────┘\nConnect to the MySQL server on the given host.\n\n•   --iterations=N, -i N\n\n┌────────────────────┬────────────────┐\n│Command-Line Format │ --iterations=# │\n├────────────────────┼────────────────┤\n│Type                │ Numeric        │\n└────────────────────┴────────────────┘\nThe number of times to run the tests.\n\n•   --login-path=name\n\n┌────────────────────┬───────────────────┐\n│Command-Line Format │ --login-path=name │\n├────────────────────┼───────────────────┤\n│Type                │ String            │\n└────────────────────┴───────────────────┘\nRead options from the named login path in the .mylogin.cnf login path file. A “login\npath” is an option group containing options that specify which MySQL server to connect to\nand which account to authenticate as. To create or modify a login path file, use the\nmysqlconfigeditor utility. See mysqlconfigeditor(1).\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --no-drop\n\n┌────────────────────┬───────────┐\n│Command-Line Format │ --no-drop │\n├────────────────────┼───────────┤\n│Type                │ Boolean   │\n├────────────────────┼───────────┤\n│Default Value       │ FALSE     │\n└────────────────────┴───────────┘\nPrevent mysqlslap from dropping any schema it creates during the test run.\n\n•   --no-defaults\n\n┌────────────────────┬───────────────┐\n│Command-Line Format │ --no-defaults │\n└────────────────────┴───────────────┘\nDo not read any option files. If program startup fails due to reading unknown options\nfrom an option file, --no-defaults can be used to prevent them from being read.\n\nThe exception is that the .mylogin.cnf file is read in all cases, if it exists. This\npermits passwords to be specified in a safer way than on the command line even when\n--no-defaults is used. To create .mylogin.cnf, use the mysqlconfigeditor utility. See\nmysqlconfigeditor(1).\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --number-char-cols=N, -x N\n\n┌────────────────────┬──────────────────────┐\n│Command-Line Format │ --number-char-cols=# │\n├────────────────────┼──────────────────────┤\n│Type                │ Numeric              │\n└────────────────────┴──────────────────────┘\nThe number of VARCHAR columns to use if --auto-generate-sql is specified.\n\n•   --number-int-cols=N, -y N\n\n┌────────────────────┬─────────────────────┐\n│Command-Line Format │ --number-int-cols=# │\n├────────────────────┼─────────────────────┤\n│Type                │ Numeric             │\n└────────────────────┴─────────────────────┘\nThe number of INT columns to use if --auto-generate-sql is specified.\n\n•   --number-of-queries=N\n\n┌────────────────────┬───────────────────────┐\n│Command-Line Format │ --number-of-queries=# │\n├────────────────────┼───────────────────────┤\n│Type                │ Numeric               │\n└────────────────────┴───────────────────────┘\nLimit each client to approximately this many queries. Query counting takes into account\nthe statement delimiter. For example, if you invoke mysqlslap as follows, the ; delimiter\nis recognized so that each instance of the query string counts as two queries. As a\nresult, 5 rows (not 10) are inserted.\n\nmysqlslap --delimiter=\";\" --number-of-queries=10\n--query=\"use test;insert into t values(null)\"\n\n•   --only-print\n\n┌────────────────────┬──────────────┐\n│Command-Line Format │ --only-print │\n├────────────────────┼──────────────┤\n│Type                │ Boolean      │\n├────────────────────┼──────────────┤\n│Default Value       │ FALSE        │\n└────────────────────┴──────────────┘\nDo not connect to databases.  mysqlslap only prints what it would have done.\n\n•   --password[=password], -p[password]\n\n┌────────────────────┬───────────────────────┐\n│Command-Line Format │ --password[=password] │\n├────────────────────┼───────────────────────┤\n│Type                │ String                │\n└────────────────────┴───────────────────────┘\nThe password of the MySQL account used for connecting to the server. The password value\nis optional. If not given, mysqlslap prompts for one. If given, there must be no space\nbetween --password= or -p and the password following it. If no password option is\nspecified, the default is to send no password.\n\nSpecifying a password on the command line should be considered insecure. To avoid giving\nthe password on the command line, use an option file. See Section 8.1.2.1, “End-User\nGuidelines for Password Security”.\n\nTo explicitly specify that there is no password and that mysqlslap should not prompt for\none, use the --skip-password option.\n\n•   --password1[=passval] The password for multifactor authentication factor 1 of the MySQL\naccount used for connecting to the server. The password value is optional. If not given,\nmysqlslap prompts for one. If given, there must be no space between --password1= and the\npassword following it. If no password option is specified, the default is to send no\npassword.\n\nSpecifying a password on the command line should be considered insecure. To avoid giving\nthe password on the command line, use an option file. See Section 8.1.2.1, “End-User\nGuidelines for Password Security”.\n\nTo explicitly specify that there is no password and that mysqlslap should not prompt for\none, use the --skip-password1 option.\n\n--password1 and --password are synonymous, as are --skip-password1 and --skip-password.\n\n•   --password2[=passval] The password for multifactor authentication factor 2 of the MySQL\naccount used for connecting to the server. The semantics of this option are similar to\nthe semantics for --password1; see the description of that option for details.\n\n•   --password3[=passval] The password for multifactor authentication factor 3 of the MySQL\naccount used for connecting to the server. The semantics of this option are similar to\nthe semantics for --password1; see the description of that option for details.\n\n•   --pipe, -W\n\n┌────────────────────┬────────┐\n│Command-Line Format │ --pipe │\n├────────────────────┼────────┤\n│Type                │ String │\n└────────────────────┴────────┘\nOn Windows, connect to the server using a named pipe. This option applies only if the\nserver was started with the namedpipe system variable enabled to support named-pipe\nconnections. In addition, the user making the connection must be a member of the Windows\ngroup specified by the namedpipefullaccessgroup system variable.\n\n•   --plugin-dir=dirname\n\n┌────────────────────┬───────────────────────┐\n│Command-Line Format │ --plugin-dir=dirname │\n├────────────────────┼───────────────────────┤\n│Type                │ Directory name        │\n└────────────────────┴───────────────────────┘\nThe directory in which to look for plugins. Specify this option if the --default-auth\noption is used to specify an authentication plugin but mysqlslap does not find it. See\nSection 8.2.17, “Pluggable Authentication”.\n\n•   --port=portnum, -P portnum\n\n┌────────────────────┬─────────────────┐\n│Command-Line Format │ --port=portnum │\n├────────────────────┼─────────────────┤\n│Type                │ Numeric         │\n├────────────────────┼─────────────────┤\n│Default Value       │ 3306            │\n└────────────────────┴─────────────────┘\nFor TCP/IP connections, the port number to use.\n\n•   --post-query=value\n\n┌────────────────────┬────────────────────┐\n│Command-Line Format │ --post-query=value │\n├────────────────────┼────────────────────┤\n│Type                │ String             │\n└────────────────────┴────────────────────┘\nThe file or string containing the statement to execute after the tests have completed.\nThis execution is not counted for timing purposes.\n\n•   --post-system=str\n\n┌────────────────────┬───────────────────┐\n│Command-Line Format │ --post-system=str │\n├────────────────────┼───────────────────┤\n│Type                │ String            │\n└────────────────────┴───────────────────┘\nThe string to execute using system() after the tests have completed. This execution is\nnot counted for timing purposes.\n\n•   --pre-query=value\n\n┌────────────────────┬───────────────────┐\n│Command-Line Format │ --pre-query=value │\n├────────────────────┼───────────────────┤\n│Type                │ String            │\n└────────────────────┴───────────────────┘\nThe file or string containing the statement to execute before running the tests. This\nexecution is not counted for timing purposes.\n\n•   --pre-system=str\n\n┌────────────────────┬──────────────────┐\n│Command-Line Format │ --pre-system=str │\n├────────────────────┼──────────────────┤\n│Type                │ String           │\n└────────────────────┴──────────────────┘\nThe string to execute using system() before running the tests. This execution is not\ncounted for timing purposes.\n\n•   --print-defaults\n\n┌────────────────────┬──────────────────┐\n│Command-Line Format │ --print-defaults │\n└────────────────────┴──────────────────┘\nPrint the program name and all options that it gets from option files.\n\nFor additional information about this and other option-file options, see Section 6.2.2.3,\n“Command-Line Options that Affect Option-File Handling”.\n\n•   --protocol={TCP|SOCKET|PIPE|MEMORY}\n\n┌────────────────────┬───────────────────┐\n│Command-Line Format │ --protocol=type   │\n├────────────────────┼───────────────────┤\n│Type                │ String            │\n├────────────────────┼───────────────────┤\n│Default Value       │ [see text]        │\n├────────────────────┼───────────────────┤\n│Valid Values        │                   │\n│                    │            TCP    │\n│                    │                   │\n│                    │            SOCKET │\n│                    │                   │\n│                    │            PIPE   │\n│                    │                   │\n│                    │            MEMORY │\n└────────────────────┴───────────────────┘\nThe transport protocol to use for connecting to the server. It is useful when the other\nconnection parameters normally result in use of a protocol other than the one you want.\nFor details on the permissible values, see Section 6.2.7, “Connection Transport\nProtocols”.\n\n•   --query=value, -q value\n\n┌────────────────────┬───────────────┐\n│Command-Line Format │ --query=value │\n├────────────────────┼───────────────┤\n│Type                │ String        │\n└────────────────────┴───────────────┘\nThe file or string containing the SELECT statement to use for retrieving data.\n\n•   --server-public-key-path=filename\n\n┌────────────────────┬──────────────────────┐\n│Command-Line Format │ --server-public-key- │\n│                    │ path=filename       │\n├────────────────────┼──────────────────────┤\n│Type                │ File name            │\n└────────────────────┴──────────────────────┘\nThe path name to a file in PEM format containing a client-side copy of the public key\nrequired by the server for RSA key pair-based password exchange. This option applies to\nclients that authenticate with the sha256password or cachingsha2password\nauthentication plugin. This option is ignored for accounts that do not authenticate with\none of those plugins. It is also ignored if RSA-based password exchange is not used, as\nis the case when the client connects to the server using a secure connection.\n\nIf --server-public-key-path=filename is given and specifies a valid public key file, it\ntakes precedence over --get-server-public-key.\n\nFor sha256password, this option applies only if MySQL was built using OpenSSL.\n\nFor information about the sha256password and cachingsha2password plugins, see\nSection 8.4.1.3, “SHA-256 Pluggable Authentication”, and Section 8.4.1.2, “Caching SHA-2\nPluggable Authentication”.\n\n•   --shared-memory-base-name=name\n\n┌────────────────────┬────────────────────────────────┐\n│Command-Line Format │ --shared-memory-base-name=name │\n├────────────────────┼────────────────────────────────┤\n│Platform Specific   │ Windows                        │\n└────────────────────┴────────────────────────────────┘\nOn Windows, the shared-memory name to use for connections made using shared memory to a\nlocal server. The default value is MYSQL. The shared-memory name is case-sensitive.\n\nThis option applies only if the server was started with the sharedmemory system variable\nenabled to support shared-memory connections.\n\n•   --silent, -s\n\n┌────────────────────┬──────────┐\n│Command-Line Format │ --silent │\n└────────────────────┴──────────┘\nSilent mode. No output.\n\n•   --socket=path, -S path\n\n┌────────────────────┬────────────────────────────────┐\n│Command-Line Format │ --socket={filename|pipename} │\n├────────────────────┼────────────────────────────────┤\n│Type                │ String                         │\n└────────────────────┴────────────────────────────────┘\nFor connections to localhost, the Unix socket file to use, or, on Windows, the name of\nthe named pipe to use.\n\nOn Windows, this option applies only if the server was started with the namedpipe system\nvariable enabled to support named-pipe connections. In addition, the user making the\nconnection must be a member of the Windows group specified by the\nnamedpipefullaccessgroup system variable.\n\n•   --sql-mode=mode\n\n┌────────────────────┬─────────────────┐\n│Command-Line Format │ --sql-mode=mode │\n├────────────────────┼─────────────────┤\n│Type                │ String          │\n└────────────────────┴─────────────────┘\nSet the SQL mode for the client session.\n\n•   --ssl* Options that begin with --ssl specify whether to connect to the server using\nencryption and indicate where to find SSL keys and certificates. See the section called\n“Command Options for Encrypted Connections”.\n\n•   --ssl-fips-mode={OFF|ON|STRICT}\n\n┌────────────────────┬─────────────────────────────────┐\n│Command-Line Format │ --ssl-fips-mode={OFF|ON|STRICT} │\n├────────────────────┼─────────────────────────────────┤\n│Deprecated          │ 8.0.34                          │\n├────────────────────┼─────────────────────────────────┤\n│Type                │ Enumeration                     │\n├────────────────────┼─────────────────────────────────┤\n│Default Value       │ OFF                             │\n├────────────────────┼─────────────────────────────────┤\n│Valid Values        │                                 │\n│                    │            OFF                  │\n│                    │                                 │\n│                    │            ON                   │\n│                    │                                 │\n│                    │            STRICT               │\n└────────────────────┴─────────────────────────────────┘\nControls whether to enable FIPS mode on the client side. The --ssl-fips-mode option\ndiffers from other --ssl-xxx options in that it is not used to establish encrypted\nconnections, but rather to affect which cryptographic operations to permit. See\nSection 8.8, “FIPS Support”.\n\nThese --ssl-fips-mode values are permitted:\n\n•   OFF: Disable FIPS mode.\n\n•   ON: Enable FIPS mode.\n\n•   STRICT: Enable “strict” FIPS mode.\n\n\nNote\nIf the OpenSSL FIPS Object Module is not available, the only permitted value for\n--ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes\nthe client to produce a warning at startup and to operate in non-FIPS mode.\nAs of MySQL 8.0.34, this option is deprecated. Expect it to be removed in a future\nversion of MySQL.\n\n•   --tls-ciphersuites=ciphersuitelist\n\n┌────────────────────┬───────────────────────────────┐\n│Command-Line Format │ --tls-                        │\n│                    │ ciphersuites=ciphersuitelist │\n├────────────────────┼───────────────────────────────┤\n│Introduced          │ 8.0.16                        │\n├────────────────────┼───────────────────────────────┤\n│Type                │ String                        │\n└────────────────────┴───────────────────────────────┘\nThe permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a\nlist of one or more colon-separated ciphersuite names. The ciphersuites that can be named\nfor this option depend on the SSL library used to compile MySQL. For details, see\nSection 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.\n\nThis option was added in MySQL 8.0.16.\n\n•   --tls-version=protocollist\n\n┌─────────────────────────┬──────────────────────────────────────────┐\n│Command-Line Format      │ --tls-version=protocollist              │\n├─────────────────────────┼──────────────────────────────────────────┤\n│Type                     │ String                                   │\n├─────────────────────────┼──────────────────────────────────────────┤\n│Default Value (≥≥ 8.0.16) │                                          │\n│                         │            TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 │\n│                         │            (OpenSSL 1.1.1 or             │\n│                         │            higher)                       │\n│                         │                                          │\n│                         │            TLSv1,TLSv1.1,TLSv1.2         │\n│                         │            (otherwise)                   │\n├─────────────────────────┼──────────────────────────────────────────┤\n│Default Value (≤≤ 8.0.15) │ TLSv1,TLSv1.1,TLSv1.2                    │\n└─────────────────────────┴──────────────────────────────────────────┘\nThe permissible TLS protocols for encrypted connections. The value is a list of one or\nmore comma-separated protocol names. The protocols that can be named for this option\ndepend on the SSL library used to compile MySQL. For details, see Section 8.3.2,\n“Encrypted Connection TLS Protocols and Ciphers”.\n\n•   --user=username, -u username\n\n┌────────────────────┬───────────────────┐\n│Command-Line Format │ --user=username, │\n├────────────────────┼───────────────────┤\n│Type                │ String            │\n└────────────────────┴───────────────────┘\nThe user name of the MySQL account to use for connecting to the server.\n\n•   --verbose, -v\n\n┌────────────────────┬───────────┐\n│Command-Line Format │ --verbose │\n└────────────────────┴───────────┘\nVerbose mode. Print more information about what the program does. This option can be used\nmultiple times to increase the amount of information.\n\n•   --version, -V\n\n┌────────────────────┬───────────┐\n│Command-Line Format │ --version │\n└────────────────────┴───────────┘\nDisplay version information and exit.\n\n•   --zstd-compression-level=level\n\n┌────────────────────┬────────────────────────────┐\n│Command-Line Format │ --zstd-compression-level=# │\n├────────────────────┼────────────────────────────┤\n│Introduced          │ 8.0.18                     │\n├────────────────────┼────────────────────────────┤\n│Type                │ Integer                    │\n└────────────────────┴────────────────────────────┘\nThe compression level to use for connections to the server that use the zstd compression\nalgorithm. The permitted levels are from 1 to 22, with larger values indicating\nincreasing levels of compression. The default zstd compression level is 3. The\ncompression level setting has no effect on connections that do not use zstd compression.\n\nFor more information, see Section 6.2.8, “Connection Compression Control”.\n\nThis option was added in MySQL 8.0.18.\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "Copyright © 1997, 2024, Oracle and/or its affiliates.\n\nThis documentation is free software; you can redistribute it and/or modify it only under the\nterms of the GNU General Public License as published by the Free Software Foundation; version\n2 of the License.\n\nThis documentation is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR\nPURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with the program; if\nnot, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA\n02110-1301 USA or see http://www.gnu.org/licenses/.\n\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "For more information, please refer to the MySQL Reference Manual, which may already be\ninstalled locally and which is also available online at http://dev.mysql.com/doc/.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Oracle Corporation (http://dev.mysql.com/).\n\n\n\nMySQL 8.0                                    12/13/2024                                 MYSQLSLAP(1)",
                "subsections": []
            }
        }
    }
}