mirror of
https://github.com/MariaDB/server.git
synced 2025-01-15 19:42:28 +01:00
6f955c262a
For the sake of readable diffs this change is done separately from the previous commit and it changes all man page headers to: - Use correct syntax \fB and \fR to make titles bold instead of previous capitalized version that had no effect - Omit unnecessary \&. syntax, works fine without it - Bump version to 10.11 Ideally the version would automatically be inherited from the build/release, but for now at least update it manually to match what is in the VERSION file of this release branch. All new code of the whole pull request, including one or several files that are either new files or modified ones, are contributed under the BSD-new license. I am contributing on behalf of my employer Amazon Web Services, Inc.
1165 lines
23 KiB
Groff
1165 lines
23 KiB
Groff
'\" t
|
|
.\"
|
|
.TH "\fBMARIADB-SLAP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.\" mysqlslap
|
|
.\" load emulation
|
|
.SH "NAME"
|
|
mariadb-slap \- load emulation client (mysqlslap is now a symlink to mariadb-slap)
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBmysqlslap\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
|
|
\fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBmysqlslap\fR
|
|
is a diagnostic program designed to emulate client load for a MariaDB server and to report the timing of each stage\&. It works as if multiple clients are accessing the server\&.
|
|
.PP
|
|
Invoke
|
|
\fBmysqlslap\fR
|
|
like this:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
shell> \fBmysqlslap [\fR\fB\fIoptions\fR\fR\fB]\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Some options such as
|
|
\fB\-\-create\fR
|
|
or
|
|
\fB\-\-query\fR
|
|
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
|
|
\fB\-\-delimiter\fR
|
|
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;
|
|
\fBmysqlslap\fR
|
|
does not understand them\&.
|
|
.PP
|
|
\fBmysqlslap\fR
|
|
runs in three stages:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04' 1.\h'+01'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP " 1." 4.2
|
|
.\}
|
|
Create schema, table, and optionally any stored programs or data you want to using for the test\&. This stage uses a single client connection\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04' 2.\h'+01'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP " 2." 4.2
|
|
.\}
|
|
Run the load test\&. This stage can use many client connections\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04' 3.\h'+01'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP " 3." 4.2
|
|
.\}
|
|
Clean up (disconnect, drop table if specified)\&. This stage uses a single client connection\&.
|
|
.RE
|
|
.PP
|
|
Examples:
|
|
.PP
|
|
Supply your own create and query SQL statements, with 50 clients querying and 200 selects for each:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
mysqlslap \-\-delimiter=";" \e
|
|
\-\-create="CREATE TABLE a (b int);INSERT INTO a VALUES (23)" \e
|
|
\-\-query="SELECT * FROM a" \-\-concurrency=50 \-\-iterations=200
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Let
|
|
\fBmysqlslap\fR
|
|
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):
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
mysqlslap \-\-concurrency=5 \-\-iterations=20 \e
|
|
\-\-number\-int\-cols=2 \-\-number\-char\-cols=3 \e
|
|
\-\-auto\-generate\-sql
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
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
|
|
\fB\-\-query\fR
|
|
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):
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
mysqlslap \-\-concurrency=5 \e
|
|
\-\-iterations=5 \-\-query=query\&.sql \-\-create=create\&.sql \e
|
|
\-\-delimiter=";"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
\fBmysqlslap\fR
|
|
supports the following options, which can be specified on the command line or in the
|
|
[mysqlslap]
|
|
and
|
|
[client]
|
|
option file groups\&.
|
|
\fBmysqlslap\fR
|
|
also supports the options for processing option files\&.
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: help option
|
|
.\" help option: mysqlslap
|
|
\fB\-\-help\fR,
|
|
\fB\-?\fR
|
|
.sp
|
|
Display a help message and exit\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql option
|
|
.\" auto-generate-sql option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\fR,
|
|
\fB\-a\fR
|
|
.sp
|
|
Generate SQL statements automatically when they are not supplied in files or via command options\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-add-autoincrement option
|
|
.\" auto-generate-sql-add-autoincrement option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-add\-autoincrement\fR
|
|
.sp
|
|
Add an
|
|
AUTO_INCREMENT
|
|
column to automatically generated tables\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-execute-number option
|
|
.\" auto-generate-sql-execute-number option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-execute\-number=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
Specify how many queries to generate automatically\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-guid-primary option
|
|
.\" auto-generate-sql-guid-primary option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-guid\-primary\fR
|
|
.sp
|
|
Add a GUID\-based primary key to automatically generated tables\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-load-type option
|
|
.\" auto-generate-sql-load-type option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-load\-type=\fR\fB\fItype\fR\fR
|
|
.sp
|
|
Specify the test load type\&. The allowable 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\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-secondary-indexes option
|
|
.\" auto-generate-sql-secondary-indexes option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-secondary\-indexes=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
Specify how many secondary indexes to add to automatically generated tables\&. By default, none are added\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-unique-query-number option
|
|
.\" auto-generate-sql-unique-query-number option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-unique\-query\-number=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
How many different queries to generate for automatic tests\&. For example, if you run a
|
|
key
|
|
test 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\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-unique-write-number option
|
|
.\" auto-generate-sql-unique-write-number option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-unique\-write\-number=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
How many different queries to generate for
|
|
\fB\-\-auto\-generate\-sql\-write\-number\fR\&. The default is 10\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: auto-generate-sql-write-number option
|
|
.\" auto-generate-sql-write-number option: mysqlslap
|
|
\fB\-\-auto\-generate\-sql\-write\-number=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
How many row inserts to perform on each thread\&. The default is 100\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: commit option
|
|
.\" commit option: mysqlslap
|
|
\fB\-\-commit=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
How many statements to execute before committing\&. The default is 0 (no commits are done)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: compress option
|
|
.\" compress option: mysqlslap
|
|
\fB\-\-compress\fR,
|
|
\fB\-C\fR
|
|
.sp
|
|
Compress all information sent between the client and the server if both support compression\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: concurrency option
|
|
.\" concurrency option: mysqlslap
|
|
\fB\-\-concurrency=\fR\fB\fIN\fR\fR,
|
|
\fB\-c \fR\fB\fIN\fR\fR
|
|
.sp
|
|
The number of clients to simulate when issuing the
|
|
SELECT
|
|
statement\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: create option
|
|
.\" create option: mysqlslap
|
|
\fB\-\-create=\fR\fB\fIvalue\fR\fR
|
|
.sp
|
|
The file or string containing the statement to use for creating the table\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: create-schema option
|
|
.\" create-schema option: mysqlslap
|
|
\fB\-\-create\-schema=\fR\fB\fIvalue\fR\fR
|
|
.sp
|
|
The schema in which to run the tests\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: csv option
|
|
.\" csv option: mysqlslap
|
|
\fB\-\-csv[=\fR\fB\fIfile_name\fR\fR\fB]\fR
|
|
.sp
|
|
Generate output in comma\-separated values format\&. The output goes to the named file, or to the standard output if no file is given\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: debug option
|
|
.\" debug option: mysqlslap
|
|
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
|
|
\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
|
|
.sp
|
|
Write a debugging log\&. A typical
|
|
\fIdebug_options\fR
|
|
string is 'd:t:o,\fIfile_name\fR'. The default is 'd:t:o,/tmp/mysqlslap.trace'.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: debug-check option
|
|
.\" debug-check option: mysqlslap
|
|
\fB\-\-debug\-check\fR
|
|
.sp
|
|
Print some debugging information when the program exits\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: debug-info option
|
|
.\" debug-info option: mysqlslap
|
|
\fB\-\-debug\-info\fR,
|
|
\fB\-T\fR
|
|
.sp
|
|
Print debugging information and memory and CPU usage statistics when the program exits\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: default-auth option
|
|
.\" default-auth option: mysqlslap
|
|
\fB\-\-default\-auth=\fR\fB\fIname\fR
|
|
.sp
|
|
Default authentication client-side plugin to use\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: defaults-extra-file option
|
|
.\" defaults-extra-file option: mysqlslap
|
|
\fB\-\-defaults\-extra\-file=\fR\fB\fIfilename\fR\fR
|
|
.sp
|
|
Set \fB\fIfilename\fR\fR as the file to read default options from after the global defaults files has been
|
|
read\&. Must be given as first option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: defaults-file option
|
|
.\" defaults-file option: mysqlslap
|
|
\fB\-\-defaults\-file=\fR\fB\fIfilename\fR\fR
|
|
.sp
|
|
Set \fB\fIfilename\fR\fR as the file to read default options from, override global defaults files\&.
|
|
Must be given as first option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: delimiter option
|
|
.\" delimiter option: mysqlslap
|
|
\fB\-\-delimiter=\fR\fB\fIstr\fR\fR,
|
|
\fB\-F \fR\fB\fIstr\fR\fR
|
|
.sp
|
|
The delimiter to use in SQL statements supplied in files or via command options\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: detach option
|
|
.\" detach option: mysqlslap
|
|
\fB\-\-detach=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
Detach (close and reopen) each connection after each
|
|
\fIN\fR
|
|
statements\&. The default is 0 (connections are not detached)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: engine option
|
|
.\" engine option: mysqlslap
|
|
\fB\-\-engine=\fR\fB\fIengine_name\fR\fR,
|
|
\fB\-e \fR\fB\fIengine_name\fR\fR
|
|
.sp
|
|
Comma separated list of storage engines to use for creating the table\&. The test is run for
|
|
each engine\&. You can also specify an option for an engine after a colon, for example
|
|
\fBmemory:max_row=2300\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: host option
|
|
.\" host option: mysqlslap
|
|
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
|
|
\fB\-h \fR\fB\fIhost_name\fR\fR
|
|
.sp
|
|
Connect to the MariaDB server on the given host\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: init-command option
|
|
.\" init-command option: mysqlslap
|
|
\fB\-\-init\-command=str\fR
|
|
.sp
|
|
SQL Command to execute when connecting to MariaDB server\&. Will automatically be re\-executed when reconnecting\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: iterations option
|
|
.\" iterations option: mysqlslap
|
|
\fB\-\-iterations=\fR\fB\fIN\fR\fR,
|
|
\fB\-i \fR\fB\fIN\fR\fR
|
|
.sp
|
|
The number of times to run the tests\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: no-defaults option
|
|
.\" no-defaults option: mysqlslap
|
|
\fB\-\-no\-defaults\fR
|
|
.sp
|
|
Do not read default options from any option file\&. This must be given as the
|
|
first argument\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: no-drop option
|
|
.\" no-drop option: mysqlslap
|
|
\fB\-\-no\-drop\fR
|
|
.sp
|
|
Do not drop any schema created during the test after the test is complete\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: number-char-cols option
|
|
.\" number-char-cols option: mysqlslap
|
|
\fB\-\-number\-char\-cols=\fR\fB\fIN\fR\fR,
|
|
\fB\-x \fR\fB\fIN\fR\fR
|
|
.sp
|
|
The number of
|
|
VARCHAR
|
|
columns to use if
|
|
\fB\-\-auto\-generate\-sql\fR
|
|
is specified\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: number-int-cols option
|
|
.\" number-int-cols option: mysqlslap
|
|
\fB\-\-number\-int\-cols=\fR\fB\fIN\fR\fR,
|
|
\fB\-y \fR\fB\fIN\fR\fR
|
|
.sp
|
|
The number of
|
|
INT
|
|
columns to use if
|
|
\fB\-\-auto\-generate\-sql\fR
|
|
is specified\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: number-of-queries option
|
|
.\" number-of-queries option: mysqlslap
|
|
\fB\-\-number\-of\-queries=\fR\fB\fIN\fR\fR
|
|
.sp
|
|
Limit each client to approximately this many queries\&. Query counting takes into account the statement delimiter\&. For example, if you invoke
|
|
\fBmysqlslap\fR
|
|
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\&.
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
shell> \fBmysqlslap \-\-delimiter=";" \-\-number\-of\-queries=10\fR
|
|
\fB\-\-query="use test;insert into t values(null)"\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: only-print option
|
|
.\" only-print option: mysqlslap
|
|
\fB\-\-only\-print\fR
|
|
.sp
|
|
Do not connect to databases\&.
|
|
\fBmysqlslap\fR
|
|
only prints what it would have done\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: password option
|
|
.\" password option: mysqlslap
|
|
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
|
|
\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
|
|
.sp
|
|
The password to use when connecting to the server\&. If you use the short option form (\fB\-p\fR), you
|
|
\fIcannot\fR
|
|
have a space between the option and the password\&. If you omit the
|
|
\fIpassword\fR
|
|
value following the
|
|
\fB\-\-password\fR
|
|
or
|
|
\fB\-p\fR
|
|
option on the command line,
|
|
\fBmysqlslap\fR
|
|
prompts for one\&.
|
|
.sp
|
|
Specifying a password on the command line should be considered insecure\&. You can use an option file to avoid giving the password on the command line\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: pipe option
|
|
.\" pipe option: mysqlslap
|
|
\fB\-\-pipe\fR,
|
|
\fB\-W\fR
|
|
.sp
|
|
On Windows, connect to the server via a named pipe\&. This option applies only if the server supports named\-pipe connections\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: plugin-dir option
|
|
.\" plugin-dir option: mysqlslap
|
|
\fB\-\-plugin\-dir=\fIdir_name\fR
|
|
.sp
|
|
Directory for client-side plugins\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: port option
|
|
.\" port option: mysqlslap
|
|
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
|
|
\fB\-P \fR\fB\fIport_num\fR\fR
|
|
.sp
|
|
The TCP/IP port number to use for the connection\&.
|
|
Forces --protocol=tcp when specified on the command line without other connection properties\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: post-query option
|
|
.\" post-query option: mysqlslap
|
|
\fB\-\-post\-query=\fR\fB\fIvalue\fR\fR
|
|
.sp
|
|
The file or string containing the statement to execute after the tests have completed\&. This execution is not counted for timing purposes\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: post-system option
|
|
.\" post-system option: mysqlslap
|
|
\fB\-\-post\-system=\fR\fB\fIstr\fR\fR
|
|
.sp
|
|
The string to execute via
|
|
system()
|
|
after the tests have completed\&. This execution is not counted for timing purposes\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: pre-query option
|
|
.\" pre-query option: mysqlslap
|
|
\fB\-\-pre\-query=\fR\fB\fIvalue\fR\fR
|
|
.sp
|
|
The file or string containing the statement to execute before running the tests\&. This execution is not counted for timing purposes\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: pre-system option
|
|
.\" pre-system option: mysqlslap
|
|
\fB\-\-pre\-system=\fR\fB\fIstr\fR\fR
|
|
.sp
|
|
The string to execute via
|
|
system()
|
|
before running the tests\&. This execution is not counted for timing purposes\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: print-defaults option
|
|
.\" print-defaults option: mysqlslap
|
|
\fB\-\-print\-defaults\fR
|
|
.sp
|
|
Print the program argument list and exit\&.
|
|
This must be given as the first argument\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: protocol option
|
|
.\" protocol option: mysqlslap
|
|
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
|
|
.sp
|
|
The connection protocol to use for connecting to the server\&. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: query option
|
|
.\" query option: mysqlslap
|
|
\fB\-\-query=\fR\fB\fIvalue\fR\fR,
|
|
\fB\-q \fR\fB\fIvalue\fR\fR
|
|
.sp
|
|
The file or string containing the
|
|
SELECT
|
|
statement to use for retrieving data\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: shared-memory-base-name option
|
|
.\" shared-memory-base-name option: mysqlslap
|
|
\fB\-\-shared\-memory\-base\-name=\fR\fB\fIname\fR\fR
|
|
.sp
|
|
On Windows, the shared\-memory name to use, for connections made via shared memory to a local server\&. This option applies only if the server supports shared\-memory connections\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: silent option
|
|
.\" silent option: mysqlslap
|
|
\fB\-\-silent\fR,
|
|
\fB\-s\fR
|
|
.sp
|
|
Silent mode\&. No output\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: socket option
|
|
.\" socket option: mysqlslap
|
|
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
|
|
\fB\-S \fR\fB\fIpath\fR\fR
|
|
.sp
|
|
For connections to
|
|
localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&.
|
|
Forces --protocol=socket when specified on the command line without other connection properties; on Windows, forces --protocol=pipe\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL options
|
|
.\" SSL options: mysqlshow
|
|
\fB\-\-ssl\fR
|
|
.sp
|
|
Enable SSL for connection (automatically enabled with other flags). Disable with
|
|
\fB\-\-skip-ssl\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL CA option
|
|
.\" SSL CA option: mysqlshow
|
|
\fB\-\-ssl\-ca=\fIname\fR
|
|
.sp
|
|
CA file in PEM format (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL CA Path option
|
|
.\" SSL CA Path option: mysqlshow
|
|
\fB\-\-ssl\-capath=\fIname\fR
|
|
.sp
|
|
CA directory (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL Cert option
|
|
.\" SSL Cert option: mysqlshow
|
|
\fB\-\-ssl\-cert=\fIname\fR
|
|
.sp
|
|
X509 cert in PEM format (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL Cipher option
|
|
.\" SSL Cipher option: mysqlshow
|
|
\fB\-\-ssl\-cipher=\fIname\fR
|
|
.sp
|
|
SSL cipher to use (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL Key option
|
|
.\" SSL Key option: mysqlshow
|
|
\fB\-\-ssl\-key=\fIname\fR
|
|
.sp
|
|
X509 key in PEM format (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL Crl option
|
|
.\" SSL CRL option: mysqlshow
|
|
\fB\-\-ssl\-crl=\fIname\fR
|
|
.sp
|
|
Certificate revocation list (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL Crlpath option
|
|
.\" SSL Crlpath option: mysqlshow
|
|
\fB\-\-ssl\-crlpath=\fIname\fR
|
|
.sp
|
|
Certificate revocation list path (check OpenSSL docs, implies
|
|
\fB\-\-ssl\fR)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlshow: SSL Verify Server Cert option
|
|
.\" SSL Verify Server Cert option: mysqlshow
|
|
\fB\-\-ssl\-verify\-server\-cert\fR
|
|
.sp
|
|
Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: user option
|
|
.\" user option: mysqlslap
|
|
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
|
|
\fB\-u \fR\fB\fIuser_name\fR\fR
|
|
.sp
|
|
The MariaDB user name to use when connecting to the server\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: verbose option
|
|
.\" verbose option: mysqlslap
|
|
\fB\-\-verbose\fR,
|
|
\fB\-v\fR
|
|
.sp
|
|
Verbose mode\&. Print more information about what the program does\&. This option can be used multiple times to increase the amount of information\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" mysqlslap: version option
|
|
.\" version option: mysqlslap
|
|
\fB\-\-version\fR,
|
|
\fB\-V\fR
|
|
.sp
|
|
Display version information and exit\&.
|
|
.RE
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
.PP
|
|
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation
|
|
.PP
|
|
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
|
|
.PP
|
|
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
.PP
|
|
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA or see http://www.gnu.org/licenses/.
|
|
.sp
|
|
.SH "SEE ALSO"
|
|
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
|
|
.SH AUTHOR
|
|
MariaDB Foundation (http://www.mariadb.org/).
|