2538 lines
39 KiB
Groff
2538 lines
39 KiB
Groff
'\" t
|
|
.\" Title: mysqlslap
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 12/13/2024
|
|
.\" Manual: MySQL Database System
|
|
.\" Source: MySQL 8.4
|
|
.\" Language: English
|
|
.\"
|
|
.TH "MYSQLSLAP" "1" "12/13/2024" "MySQL 8\&.4" "MySQL Database System"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
mysqlslap \- a load emulation client
|
|
.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 MySQL 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
|
|
mysqlslap [\fIoptions\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 to use 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 (enter the command on a single line):
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
mysqlslap \-\-delimiter=";"
|
|
\-\-create="CREATE TABLE a (b int);INSERT INTO a VALUES (23)"
|
|
\-\-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\*(Aqs schema and data):
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
mysqlslap \-\-concurrency=5 \-\-iterations=20
|
|
\-\-number\-int\-cols=2 \-\-number\-char\-cols=3
|
|
\-\-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
|
|
\*(Aq;\*(Aq
|
|
and multiple insert statements delimited by
|
|
\*(Aq;\*(Aq\&. The
|
|
\fB\-\-query\fR
|
|
file should contain multiple queries delimited by
|
|
\*(Aq;\*(Aq\&. 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
|
|
\-\-iterations=5 \-\-query=query\&.sql \-\-create=create\&.sql
|
|
\-\-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]
|
|
groups of an option file\&. For information about option files used by MySQL programs, see
|
|
Section\ \&6.2.2.2, \(lqUsing Option Files\(rq\&.
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-help\fR,
|
|
\fB\-?\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--help
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\fR,
|
|
\fB\-a\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Generate SQL statements automatically when they are not supplied in files or using command options\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-add\-autoincrement\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-add-autoincrement
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-execute\-number=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-execute-number=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-guid\-primary\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-guid-primary
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-load\-type=\fR\fB\fItype\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-load-type=type
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Enumeration
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
mixed
|
|
T}
|
|
T{
|
|
Valid Values
|
|
T}:T{
|
|
.PP
|
|
read
|
|
.PP
|
|
write
|
|
.PP
|
|
key
|
|
.PP
|
|
update
|
|
.PP
|
|
mixed
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Specify the test load type\&. The permissible values are
|
|
read
|
|
(scan tables),
|
|
write
|
|
(insert into tables),
|
|
key
|
|
(read primary keys),
|
|
update
|
|
(update primary keys), or
|
|
mixed
|
|
(half inserts, half scanning selects)\&. The default is
|
|
mixed\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-secondary\-indexes=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-secondary-indexes=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
0
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-unique\-query\-number=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-unique-query-number=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
10
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-unique\-write\-number=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-unique-write-number=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
10
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-auto\-generate\-sql\-write\-number=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--auto-generate-sql-write-number=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
100
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
How many row inserts to perform\&. The default is 100\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-commit=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--commit=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
0
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-compress\fR,
|
|
\fB\-C\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--compress[={OFF|ON}]
|
|
T}
|
|
T{
|
|
Deprecated
|
|
T}:T{
|
|
Yes
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
OFF
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Compress all information sent between the client and the server if possible\&. See
|
|
Section\ \&6.2.8, \(lqConnection Compression Control\(rq\&.
|
|
.sp
|
|
This option is deprecated\&. Expect it to be removed in a future version of MySQL\&. See
|
|
the section called \(lqConfiguring Legacy Connection Compression\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-compression\-algorithms=\fR\fB\fIvalue\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--compression-algorithms=value
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Set
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
uncompressed
|
|
T}
|
|
T{
|
|
Valid Values
|
|
T}:T{
|
|
.PP
|
|
zlib
|
|
.PP
|
|
zstd
|
|
.PP
|
|
uncompressed
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The permitted compression algorithms for connections to the server\&. The available algorithms are the same as for the
|
|
protocol_compression_algorithms
|
|
system variable\&. The default value is
|
|
uncompressed\&.
|
|
.sp
|
|
For more information, see
|
|
Section\ \&6.2.8, \(lqConnection Compression Control\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-concurrency=\fR\fB\fIN\fR\fR,
|
|
\fB\-c \fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--concurrency=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The number of parallel clients to simulate\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-create=\fR\fB\fIvalue\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--create=value
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-create\-schema=\fR\fB\fIvalue\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--create-schema=value
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The schema in which to run the tests\&.
|
|
.if n \{\
|
|
.sp
|
|
.\}
|
|
.RS 4
|
|
.it 1 an-trap
|
|
.nr an-no-space-flag 1
|
|
.nr an-break-flag 1
|
|
.br
|
|
.ps +1
|
|
\fBNote\fR
|
|
.ps -1
|
|
.br
|
|
If the
|
|
\fB\-\-auto\-generate\-sql\fR
|
|
option is also given,
|
|
\fBmysqlslap\fR
|
|
drops the schema at the end of the test run\&. To avoid this, use the
|
|
\fB\-\-no\-drop\fR
|
|
option as well\&.
|
|
.sp .5v
|
|
.RE
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-csv[=\fR\fB\fIfile_name\fR\fR\fB]\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--csv=[file]
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,
|
|
\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--debug[=debug_options]
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
d:t:o,/tmp/mysqlslap.trace
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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\&.
|
|
.sp
|
|
This option is available only if MySQL was built using
|
|
\fBWITH_DEBUG\fR\&. MySQL release binaries provided by Oracle are
|
|
\fInot\fR
|
|
built using this option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-debug\-check\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--debug-check
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Print some debugging information when the program exits\&.
|
|
.sp
|
|
This option is available only if MySQL was built using
|
|
\fBWITH_DEBUG\fR\&. MySQL release binaries provided by Oracle are
|
|
\fInot\fR
|
|
built using this option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-debug\-info\fR,
|
|
\fB\-T\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--debug-info
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Print debugging information and memory and CPU usage statistics when the program exits\&.
|
|
.sp
|
|
This option is available only if MySQL was built using
|
|
\fBWITH_DEBUG\fR\&. MySQL release binaries provided by Oracle are
|
|
\fInot\fR
|
|
built using this option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-default\-auth=\fR\fB\fIplugin\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--default-auth=plugin
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
A hint about which client\-side authentication plugin to use\&. See
|
|
Section\ \&8.2.17, \(lqPluggable Authentication\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-defaults\-extra\-file=\fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--defaults-extra-file=file_name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Read this option file after the global option file but (on Unix) before the user option file\&. If the file does not exist or is otherwise inaccessible, an error occurs\&. If
|
|
\fIfile_name\fR
|
|
is not an absolute path name, it is interpreted relative to the current directory\&.
|
|
.sp
|
|
For additional information about this and other option\-file options, see
|
|
Section\ \&6.2.2.3, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-defaults\-file=\fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--defaults-file=file_name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Use only the given option file\&. If the file does not exist or is otherwise inaccessible, an error occurs\&. If
|
|
\fIfile_name\fR
|
|
is not an absolute path name, it is interpreted relative to the current directory\&.
|
|
.sp
|
|
Exception: Even with
|
|
\fB\-\-defaults\-file\fR, client programs read
|
|
\&.mylogin\&.cnf\&.
|
|
.sp
|
|
For additional information about this and other option\-file options, see
|
|
Section\ \&6.2.2.3, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-defaults\-group\-suffix=\fR\fB\fIstr\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--defaults-group-suffix=str
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Read not only the usual option groups, but also groups with the usual names and a suffix of
|
|
\fIstr\fR\&. For example,
|
|
\fBmysqlslap\fR
|
|
normally reads the
|
|
[client]
|
|
and
|
|
[mysqlslap]
|
|
groups\&. If this option is given as
|
|
\fB\-\-defaults\-group\-suffix=_other\fR,
|
|
\fBmysqlslap\fR
|
|
also reads the
|
|
[client_other]
|
|
and
|
|
[mysqlslap_other]
|
|
groups\&.
|
|
.sp
|
|
For additional information about this and other option\-file options, see
|
|
Section\ \&6.2.2.3, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-delimiter=\fR\fB\fIstr\fR\fR,
|
|
\fB\-F \fR\fB\fIstr\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--delimiter=str
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The delimiter to use in SQL statements supplied in files or using command options\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-detach=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--detach=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
0
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-enable\-cleartext\-plugin\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--enable-cleartext-plugin
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Enable the
|
|
mysql_clear_password
|
|
cleartext authentication plugin\&. (See
|
|
Section\ \&8.4.1.4, \(lqClient-Side Cleartext Pluggable Authentication\(rq\&.)
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-engine=\fR\fB\fIengine_name\fR\fR,
|
|
\fB\-e \fR\fB\fIengine_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--engine=engine_name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The storage engine to use for creating tables\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-get\-server\-public\-key\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--get-server-public-key
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Request from the server the RSA public key that it uses for key pair\-based password exchange\&. This option applies to clients that connect to the server using an account that authenticates with the
|
|
caching_sha2_password
|
|
authentication plugin\&. For connections by such accounts, the server does not send the public key to the client unless requested\&. The option is ignored for accounts that do not authenticate with that plugin\&. It is also ignored if RSA\-based password exchange is not needed, as is the case when the client connects to the server using a secure connection\&.
|
|
.sp
|
|
If
|
|
\fB\-\-server\-public\-key\-path=\fR\fB\fIfile_name\fR\fR
|
|
is given and specifies a valid public key file, it takes precedence over
|
|
\fB\-\-get\-server\-public\-key\fR\&.
|
|
.sp
|
|
For information about the
|
|
caching_sha2_password
|
|
plugin, see
|
|
Section\ \&8.4.1.2, \(lqCaching SHA-2 Pluggable Authentication\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-host=\fR\fB\fIhost_name\fR\fR,
|
|
\fB\-h \fR\fB\fIhost_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--host=host_name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
localhost
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Connect to the MySQL server on the given host\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-iterations=\fR\fB\fIN\fR\fR,
|
|
\fB\-i \fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--iterations=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-login\-path=\fR\fB\fIname\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--login-path=name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Read options from the named login path in the
|
|
\&.mylogin\&.cnf
|
|
login path file\&. A
|
|
\(lqlogin path\(rq
|
|
is an option group containing options that specify which MySQL server to connect to and which account to authenticate as\&. To create or modify a login path file, use the
|
|
\fBmysql_config_editor\fR
|
|
utility\&. See
|
|
mysql_config_editor(1)\&.
|
|
.sp
|
|
For additional information about this and other option\-file options, see
|
|
Section\ \&6.2.2.3, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-no\-login\-paths\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--no-login-paths
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Skips reading options from the login path file\&.
|
|
.sp
|
|
See
|
|
\fB\-\-login\-path\fR
|
|
for related information\&.
|
|
.sp
|
|
For additional information about this and other option\-file options, see
|
|
Section\ \&6.2.2.3, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-no\-drop\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--no-drop
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Prevent
|
|
\fBmysqlslap\fR
|
|
from dropping any schema it creates during the test run\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-no\-defaults\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--no-defaults
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Do not read any option files\&. If program startup fails due to reading unknown options from an option file,
|
|
\fB\-\-no\-defaults\fR
|
|
can be used to prevent them from being read\&.
|
|
.sp
|
|
The exception is that the
|
|
\&.mylogin\&.cnf
|
|
file is read in all cases, if it exists\&. This permits passwords to be specified in a safer way than on the command line even when
|
|
\fB\-\-no\-defaults\fR
|
|
is used\&. To create
|
|
\&.mylogin\&.cnf, use the
|
|
\fBmysql_config_editor\fR
|
|
utility\&. See
|
|
mysql_config_editor(1)\&.
|
|
.sp
|
|
For additional information about this and other option\-file options, see
|
|
Section\ \&6.2.2.3, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-number\-char\-cols=\fR\fB\fIN\fR\fR,
|
|
\fB\-x \fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--number-char-cols=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-number\-int\-cols=\fR\fB\fIN\fR\fR,
|
|
\fB\-y \fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--number-int-cols=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-number\-of\-queries=\fR\fB\fIN\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--number-of-queries=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
mysqlslap \-\-delimiter=";" \-\-number\-of\-queries=10
|
|
\-\-query="use test;insert into t values(null)"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-only\-print\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--only-print
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Boolean
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
FALSE
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,
|
|
\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--password[=password]
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The password of the MySQL account used for connecting to the server\&. The password value is optional\&. If not given,
|
|
\fBmysqlslap\fR
|
|
prompts for one\&. If given, there must be
|
|
\fIno space\fR
|
|
between
|
|
\fB\-\-password=\fR
|
|
or
|
|
\fB\-p\fR
|
|
and the password following it\&. If no password option is specified, the default is to send no password\&.
|
|
.sp
|
|
Specifying a password on the command line should be considered insecure\&. To avoid giving the password on the command line, use an option file\&. See
|
|
Section\ \&8.1.2.1, \(lqEnd-User Guidelines for Password Security\(rq\&.
|
|
.sp
|
|
To explicitly specify that there is no password and that
|
|
\fBmysqlslap\fR
|
|
should not prompt for one, use the
|
|
\fB\-\-skip\-password\fR
|
|
option\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-password1[=\fR\fB\fIpass_val\fR\fR\fB]\fR
|
|
The password for multifactor authentication factor 1 of the MySQL account used for connecting to the server\&. The password value is optional\&. If not given,
|
|
\fBmysqlslap\fR
|
|
prompts for one\&. If given, there must be
|
|
\fIno space\fR
|
|
between
|
|
\fB\-\-password1=\fR
|
|
and the password following it\&. If no password option is specified, the default is to send no password\&.
|
|
.sp
|
|
Specifying a password on the command line should be considered insecure\&. To avoid giving the password on the command line, use an option file\&. See
|
|
Section\ \&8.1.2.1, \(lqEnd-User Guidelines for Password Security\(rq\&.
|
|
.sp
|
|
To explicitly specify that there is no password and that
|
|
\fBmysqlslap\fR
|
|
should not prompt for one, use the
|
|
\fB\-\-skip\-password1\fR
|
|
option\&.
|
|
.sp
|
|
\fB\-\-password1\fR
|
|
and
|
|
\fB\-\-password\fR
|
|
are synonymous, as are
|
|
\fB\-\-skip\-password1\fR
|
|
and
|
|
\fB\-\-skip\-password\fR\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-password2[=\fR\fB\fIpass_val\fR\fR\fB]\fR
|
|
The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server\&. The semantics of this option are similar to the semantics for
|
|
\fB\-\-password1\fR; see the description of that option for details\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-password3[=\fR\fB\fIpass_val\fR\fR\fB]\fR
|
|
The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server\&. The semantics of this option are similar to the semantics for
|
|
\fB\-\-password1\fR; see the description of that option for details\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-pipe\fR,
|
|
\fB\-W\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--pipe
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
On Windows, connect to the server using a named pipe\&. This option applies only if the server was started with the
|
|
named_pipe
|
|
system variable enabled to support named\-pipe connections\&. In addition, the user making the connection must be a member of the Windows group specified by the
|
|
named_pipe_full_access_group
|
|
system variable\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-plugin\-dir=\fR\fB\fIdir_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--plugin-dir=dir_name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Directory name
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The directory in which to look for plugins\&. Specify this option if the
|
|
\fB\-\-default\-auth\fR
|
|
option is used to specify an authentication plugin but
|
|
\fBmysqlslap\fR
|
|
does not find it\&. See
|
|
Section\ \&8.2.17, \(lqPluggable Authentication\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-port=\fR\fB\fIport_num\fR\fR,
|
|
\fB\-P \fR\fB\fIport_num\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--port=port_num
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Numeric
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
3306
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
For TCP/IP connections, the port number to use\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-post\-query=\fR\fB\fIvalue\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--post-query=value
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-post\-system=\fR\fB\fIstr\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--post-system=str
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The string to execute using
|
|
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
|
|
.\}
|
|
\fB\-\-pre\-query=\fR\fB\fIvalue\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--pre-query=value
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-pre\-system=\fR\fB\fIstr\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--pre-system=str
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The string to execute using
|
|
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
|
|
.\}
|
|
\fB\-\-print\-defaults\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--print-defaults
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Print the program name and all options that it gets from option files\&.
|
|
.sp
|
|
For additional information about this and other option\-file options, see
|
|
Section\ \&6.2.2.3, \(lqCommand-Line Options that Affect Option-File Handling\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--protocol=type
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
[see text]
|
|
T}
|
|
T{
|
|
Valid Values
|
|
T}:T{
|
|
.PP
|
|
TCP
|
|
.PP
|
|
SOCKET
|
|
.PP
|
|
PIPE
|
|
.PP
|
|
MEMORY
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The transport protocol to use for connecting to the server\&. It is useful when the other connection parameters normally result in use of a protocol other than the one you want\&. For details on the permissible values, see
|
|
Section\ \&6.2.7, \(lqConnection Transport Protocols\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-query=\fR\fB\fIvalue\fR\fR,
|
|
\fB\-q \fR\fB\fIvalue\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--query=value
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-server\-public\-key\-path=\fR\fB\fIfile_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--server-public-key-path=file_name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
File name
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The path name to a file in PEM format containing a client\-side copy of the public key required by the server for RSA key pair\-based password exchange\&. This option applies to clients that authenticate with the
|
|
sha256_password
|
|
(deprecated) or
|
|
caching_sha2_password
|
|
authentication plugin\&. This option is ignored for accounts that do not authenticate with one of those plugins\&. It is also ignored if RSA\-based password exchange is not used, as is the case when the client connects to the server using a secure connection\&.
|
|
.sp
|
|
If
|
|
\fB\-\-server\-public\-key\-path=\fR\fB\fIfile_name\fR\fR
|
|
is given and specifies a valid public key file, it takes precedence over
|
|
\fB\-\-get\-server\-public\-key\fR\&.
|
|
.sp
|
|
For
|
|
sha256_password
|
|
(deprecated), this option applies only if MySQL was built using OpenSSL\&.
|
|
.sp
|
|
For information about the
|
|
sha256_password
|
|
and
|
|
caching_sha2_password
|
|
plugins, see
|
|
Section\ \&8.4.1.3, \(lqSHA-256 Pluggable Authentication\(rq, and
|
|
Section\ \&8.4.1.2, \(lqCaching SHA-2 Pluggable Authentication\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-shared\-memory\-base\-name=\fR\fB\fIname\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--shared-memory-base-name=name
|
|
T}
|
|
T{
|
|
Platform Specific
|
|
T}:T{
|
|
Windows
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
On Windows, the shared\-memory name to use for connections made using shared memory to a local server\&. The default value is
|
|
MYSQL\&. The shared\-memory name is case\-sensitive\&.
|
|
.sp
|
|
This option applies only if the server was started with the
|
|
shared_memory
|
|
system variable enabled to support shared\-memory connections\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-silent\fR,
|
|
\fB\-s\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--silent
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Silent mode\&. No output\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-socket=\fR\fB\fIpath\fR\fR,
|
|
\fB\-S \fR\fB\fIpath\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--socket={file_name|pipe_name}
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
For connections to
|
|
localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use\&.
|
|
.sp
|
|
On Windows, this option applies only if the server was started with the
|
|
named_pipe
|
|
system variable enabled to support named\-pipe connections\&. In addition, the user making the connection must be a member of the Windows group specified by the
|
|
named_pipe_full_access_group
|
|
system variable\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-sql\-mode=\fR\fB\fImode\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--sql-mode=mode
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Set the SQL mode for the client session\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ssl*\fR
|
|
Options that begin with
|
|
\fB\-\-ssl\fR
|
|
specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates\&. See
|
|
the section called \(lqCommand Options for Encrypted Connections\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-ssl\-fips\-mode={OFF|ON|STRICT}\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--ssl-fips-mode={OFF|ON|STRICT}
|
|
T}
|
|
T{
|
|
Deprecated
|
|
T}:T{
|
|
Yes
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Enumeration
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
OFF
|
|
T}
|
|
T{
|
|
Valid Values
|
|
T}:T{
|
|
.PP
|
|
OFF
|
|
.PP
|
|
ON
|
|
.PP
|
|
STRICT
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Controls whether to enable FIPS mode on the client side\&. The
|
|
\fB\-\-ssl\-fips\-mode\fR
|
|
option differs from other
|
|
\fB\-\-ssl\-\fR\fB\fIxxx\fR\fR
|
|
options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit\&. See
|
|
Section\ \&8.8, \(lqFIPS Support\(rq\&.
|
|
.sp
|
|
These
|
|
\fB\-\-ssl\-fips\-mode\fR
|
|
values are permitted:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
OFF: Disable FIPS mode\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
ON: Enable FIPS mode\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
STRICT: Enable
|
|
\(lqstrict\(rq
|
|
FIPS mode\&.
|
|
.RE
|
|
.sp
|
|
.if n \{\
|
|
.sp
|
|
.\}
|
|
.RS 4
|
|
.it 1 an-trap
|
|
.nr an-no-space-flag 1
|
|
.nr an-break-flag 1
|
|
.br
|
|
.ps +1
|
|
\fBNote\fR
|
|
.ps -1
|
|
.br
|
|
If the OpenSSL FIPS Object Module is not available, the only permitted value for
|
|
\fB\-\-ssl\-fips\-mode\fR
|
|
is
|
|
OFF\&. In this case, setting
|
|
\fB\-\-ssl\-fips\-mode\fR
|
|
to
|
|
ON
|
|
or
|
|
STRICT
|
|
causes the client to produce a warning at startup and to operate in non\-FIPS mode\&.
|
|
.sp .5v
|
|
.RE
|
|
This option is deprecated\&. Expect it to be removed in a future version of MySQL\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-tls\-ciphersuites=\fR\fB\fIciphersuite_list\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--tls-ciphersuites=ciphersuite_list
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The permissible ciphersuites for encrypted connections that use TLSv1\&.3\&. The value is a list of one or more colon\-separated ciphersuite names\&. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL\&. For details, see
|
|
Section\ \&8.3.2, \(lqEncrypted Connection TLS Protocols and Ciphers\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-tls\-sni\-servername=\fR\fB\fIserver_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--tls-sni-servername=server_name
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
When specified, the name is passed to the
|
|
libmysqlclient
|
|
C API library using the
|
|
MYSQL_OPT_TLS_SNI_SERVERNAME
|
|
option of
|
|
mysql_options()\&. The server name is not case\-sensitive\&. To show which server name the client specified for the current session, if any, check the
|
|
Tls_sni_server_name
|
|
status variable\&.
|
|
.sp
|
|
Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function)\&. The MySQL implementation of SNI represents the client\-side only\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-tls\-version=\fR\fB\fIprotocol_list\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--tls-version=protocol_list
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
T{
|
|
Default Value
|
|
T}:T{
|
|
.PP
|
|
TLSv1,TLSv1.1,TLSv1.2,TLSv1.3
|
|
(OpenSSL 1.1.1 or higher)
|
|
.PP
|
|
TLSv1,TLSv1.1,TLSv1.2
|
|
(otherwise)
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The permissible TLS protocols for encrypted connections\&. The value is a list of one or more comma\-separated protocol names\&. The protocols that can be named for this option depend on the SSL library used to compile MySQL\&. For details, see
|
|
Section\ \&8.3.2, \(lqEncrypted Connection TLS Protocols and Ciphers\(rq\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-user=\fR\fB\fIuser_name\fR\fR,
|
|
\fB\-u \fR\fB\fIuser_name\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--user=user_name,
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
String
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The user name of the MySQL account to use for connecting to the server\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-verbose\fR,
|
|
\fB\-v\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--verbose
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
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
|
|
.\}
|
|
\fB\-\-version\fR,
|
|
\fB\-V\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--version
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
Display version information and exit\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
\fB\-\-zstd\-compression\-level=\fR\fB\fIlevel\fR\fR
|
|
.TS
|
|
allbox tab(:);
|
|
lB l
|
|
lB l.
|
|
T{
|
|
Command-Line Format
|
|
T}:T{
|
|
--zstd-compression-level=#
|
|
T}
|
|
T{
|
|
Type
|
|
T}:T{
|
|
Integer
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
The compression level to use for connections to the server that use the
|
|
zstd
|
|
compression algorithm\&. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression\&. The default
|
|
zstd
|
|
compression level is 3\&. The compression level setting has no effect on connections that do not use
|
|
zstd
|
|
compression\&.
|
|
.sp
|
|
For more information, see
|
|
Section\ \&6.2.8, \(lqConnection Compression Control\(rq\&.
|
|
.RE
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
.PP
|
|
Copyright \(co 1997, 2024, Oracle and/or its affiliates.
|
|
.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-1301 USA or see http://www.gnu.org/licenses/.
|
|
.sp
|
|
.SH "SEE ALSO"
|
|
For more information, please refer to the MySQL Reference Manual,
|
|
which may already be installed locally and which is also available
|
|
online at http://dev.mysql.com/doc/.
|
|
.SH AUTHOR
|
|
Oracle Corporation (http://dev.mysql.com/).
|