mysqlpump.1

'\" t
.\"     Title: mysqlpump
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 09/17/2024
.\"    Manual: MySQL Database System
.\"    Source: MySQL 8.0
.\"  Language: English
.\"
.TH "MYSQLPUMP" "1" "09/17/2024" "MySQL 8\&.0" "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"
mysqlpump \- a database backup program
.SH "SYNOPSIS"
.HP \w'\fBmysqlpump\ [\fR\fB\fIoptions\fR\fR\fB]\ [\fR\fB\fIdb_name\fR\fR\fB\ [\fR\fB\fItbl_name\fR\fR\fB\ \&.\&.\&.]]\fR\ 'u
\fBmysqlpump [\fR\fB\fIoptions\fR\fR\fB] [\fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItbl_name\fR\fR\fB \&.\&.\&.]]\fR
.SH "DESCRIPTION"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
mysqlpump Invocation Syntax
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
mysqlpump Option Summary
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
mysqlpump Option Descriptions
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
mysqlpump Object Selection
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
mysqlpump Parallel Processing
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
mysqlpump Restrictions
.RE
.PP
The
\fBmysqlpump\fR
client utility performs
logical backups, producing a set of SQL statements that can be executed to reproduce the original database object definitions and table data\&. It dumps one or more MySQL databases for backup or transfer to another SQL server\&.
.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
.PP
\fBmysqlpump\fR
is deprecated as of MySQL 8\&.0\&.34; expect it to be removed in a future version of MySQL\&. You can use such MySQL programs as
\fBmysqldump\fR
and MySQL Shell to perform logical backups, dump databases, and similar tasks instead\&.
.sp .5v
.RE
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTip\fR
.ps -1
.br
.PP
Consider using the
\m[blue]\fBMySQL Shell dump utilities\fR\m[]\&\s-2\u[1]\d\s+2, which provide parallel dumping with multiple threads, file compression, and progress information display, as well as cloud features such as Oracle Cloud Infrastructure Object Storage streaming, and MySQL HeatWave Service compatibility checks and modifications\&. Dumps can be easily imported into a MySQL Server instance or a MySQL HeatWave Service DB System using the
\m[blue]\fBMySQL Shell load dump utilities\fR\m[]\&\s-2\u[2]\d\s+2\&. Installation instructions for MySQL Shell can be found
\m[blue]\fBhere\fR\m[]\&\s-2\u[3]\d\s+2\&.
.sp .5v
.RE
.PP
\fBmysqlpump\fR
features include:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Parallel processing of databases, and of objects within databases, to speed up the dump process
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Better control over which databases and database objects (tables, stored programs, user accounts) to dump
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Dumping of user accounts as account\-management statements (CREATE USER,
GRANT) rather than as inserts into the
mysql
system database
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Capability of creating compressed output
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Progress indicator (the values are estimates)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
For dump file reloading, faster secondary index creation for
InnoDB
tables by adding indexes after rows are inserted
.RE
.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
.PP
\fBmysqlpump\fR
uses MySQL features introduced in MySQL 5\&.7, and thus assumes use with MySQL 5\&.7 or higher\&.
.sp .5v
.RE
.PP
\fBmysqlpump\fR
requires at least the
SELECT
privilege for dumped tables,
SHOW VIEW
for dumped views,
TRIGGER
for dumped triggers, and
LOCK TABLES
if the
\fB\-\-single\-transaction\fR
option is not used\&. The
SELECT
privilege on the
mysql
system database is required to dump user definitions\&. Certain options might require other privileges as noted in the option descriptions\&.
.PP
To reload a dump file, you must have the privileges required to execute the statements that it contains, such as the appropriate
CREATE
privileges for objects created by those statements\&.
.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
.PP
A dump made using PowerShell on Windows with output redirection creates a file that has UTF\-16 encoding:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump [options] > dump\&.sql
.fi
.if n \{\
.RE
.\}
.PP
However, UTF\-16 is not permitted as a connection character set (see
Section\ \&12.4, \(lqConnection Character Sets and Collations\(rq), so the dump file cannot be loaded correctly\&. To work around this issue, use the
\fB\-\-result\-file\fR
option, which creates the output in ASCII format:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump [options] \-\-result\-file=dump\&.sql
.fi
.if n \{\
.RE
.\}
.sp .5v
.RE
mysqlpump Invocation Syntax
.PP
By default,
\fBmysqlpump\fR
dumps all databases (with certain exceptions noted in
mysqlpump Restrictions)\&. To specify this behavior explicitly, use the
\fB\-\-all\-databases\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-all\-databases
.fi
.if n \{\
.RE
.\}
.PP
To dump a single database, or certain tables within that database, name the database on the command line, optionally followed by table names:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \fIdb_name\fR
mysqlpump \fIdb_name tbl_name1 tbl_name2 \&.\&.\&.\fR
.fi
.if n \{\
.RE
.\}
.PP
To treat all name arguments as database names, use the
\fB\-\-databases\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-databases \fIdb_name1 db_name2\fR \&.\&.\&.
.fi
.if n \{\
.RE
.\}
.PP
By default,
\fBmysqlpump\fR
does not dump user account definitions, even if you dump the
mysql
system database that contains the grant tables\&. To dump grant table contents as logical definitions in the form of
CREATE USER
and
GRANT
statements, use the
\fB\-\-users\fR
option and suppress all database dumping:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-exclude\-databases=% \-\-users
.fi
.if n \{\
.RE
.\}
.PP
In the preceding command,
%
is a wildcard that matches all database names for the
\fB\-\-exclude\-databases\fR
option\&.
.PP
\fBmysqlpump\fR
supports several options for including or excluding databases, tables, stored programs, and user definitions\&. See
mysqlpump Object Selection\&.
.PP
To reload a dump file, execute the statements that it contains\&. For example, use the
\fBmysql\fR
client:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump [options] > dump\&.sql
mysql < dump\&.sql
.fi
.if n \{\
.RE
.\}
.PP
The following discussion provides additional
\fBmysqlpump\fR
usage examples\&.
.PP
To see a list of the options
\fBmysqlpump\fR
supports, issue the command
\fBmysqlpump \-\-help\fR\&.
mysqlpump Option Summary
.PP
\fBmysqlpump\fR
supports the following options, which can be specified on the command line or in the
[mysqlpump]
and
[client]
groups of an option file\&. (Prior to MySQL 8\&.0\&.20,
\fBmysqlpump\fR
read the
[mysql_dump]
group rather than
[mysqlpump]\&. As of 8\&.0\&.20,
[mysql_dump]
is still accepted but is deprecated\&.) For information about option files used by MySQL programs, see
Section\ \&6.2.2.2, \(lqUsing Option Files\(rq\&.
mysqlpump Option Descriptions
.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\-\-add\-drop\-database\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--add-drop-database
T}
.TE
.sp 1
Write a
DROP DATABASE
statement before each
CREATE DATABASE
statement\&.
.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
In MySQL 8\&.0, the
mysql
schema is considered a system schema that cannot be dropped by end users\&. If
\fB\-\-add\-drop\-database\fR
is used with
\fB\-\-all\-databases\fR
or with
\fB\-\-databases\fR
where the list of schemas to be dumped includes
mysql, the dump file contains a
DROP DATABASE `mysql`
statement that causes an error when the dump file is reloaded\&.
.sp
Instead, to use
\fB\-\-add\-drop\-database\fR, use
\fB\-\-databases\fR
with a list of schemas to be dumped, where the list does not include
mysql\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-add\-drop\-table\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--add-drop-table
T}
.TE
.sp 1
Write a
DROP TABLE
statement before each
CREATE TABLE
statement\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-add\-drop\-user\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--add-drop-user
T}
.TE
.sp 1
Write a
DROP USER
statement before each
CREATE USER
statement\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-add\-locks\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--add-locks
T}
.TE
.sp 1
Surround each table dump with
LOCK TABLES
and
UNLOCK TABLES
statements\&. This results in faster inserts when the dump file is reloaded\&. See
Section\ \&10.2.5.1, \(lqOptimizing INSERT Statements\(rq\&.
.sp
This option does not work with parallelism because
INSERT
statements from different tables can be interleaved and
UNLOCK TABLES
following the end of the inserts for one table could release locks on tables for which inserts remain\&.
.sp
\fB\-\-add\-locks\fR
and
\fB\-\-single\-transaction\fR
are mutually exclusive\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-all\-databases\fR,
\fB\-A\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--all-databases
T}
.TE
.sp 1
Dump all databases (with certain exceptions noted in
mysqlpump Restrictions)\&. This is the default behavior if no other is specified explicitly\&.
.sp
\fB\-\-all\-databases\fR
and
\fB\-\-databases\fR
are mutually exclusive\&.
.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
See the
\fB\-\-add\-drop\-database\fR
description for information about an incompatibility of that option with
\fB\-\-all\-databases\fR\&.
.sp .5v
.RE
Prior to MySQL 8\&.0, the
\fB\-\-routines\fR
and
\fB\-\-events\fR
options for
\fBmysqldump\fR
and
\fBmysqlpump\fR
were not required to include stored routines and events when using the
\fB\-\-all\-databases\fR
option: The dump included the
mysql
system database, and therefore also the
mysql\&.proc
and
mysql\&.event
tables containing stored routine and event definitions\&. As of MySQL 8\&.0, the
mysql\&.event
and
mysql\&.proc
tables are not used\&. Definitions for the corresponding objects are stored in data dictionary tables, but those tables are not dumped\&. To include stored routines and events in a dump made using
\fB\-\-all\-databases\fR, use the
\fB\-\-routines\fR
and
\fB\-\-events\fR
options explicitly\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-bind\-address=\fR\fB\fIip_address\fR\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--bind-address=ip_address
T}
.TE
.sp 1
On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--character-sets-dir=dir_name
T}
T{
Type
T}:T{
Directory name
T}
.TE
.sp 1
The directory where character sets are installed\&. See
Section\ \&12.15, \(lqCharacter Set Configuration\(rq\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-column\-statistics\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--column-statistics
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
OFF
T}
.TE
.sp 1
Add
ANALYZE TABLE
statements to the output to generate histogram statistics for dumped tables when the dump file is reloaded\&. This option is disabled by default because histogram generation for large tables can take a long time\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-complete\-insert\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--complete-insert
T}
.TE
.sp 1
Write complete
INSERT
statements that include column names\&.
.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{
8.0.18
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
As of MySQL 8\&.0\&.18, 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\-\-compress\-output=\fR\fB\fIalgorithm\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--compress-output=algorithm
T}
T{
Type
T}:T{
Enumeration
T}
T{
Valid Values
T}:T{
.PP
LZ4
.PP
ZLIB
T}
.TE
.sp 1
By default,
\fBmysqlpump\fR
does not compress output\&. This option specifies output compression using the specified algorithm\&. Permitted algorithms are
LZ4
and
ZLIB\&.
.sp
To uncompress compressed output, you must have an appropriate utility\&. If the system commands
\fBlz4\fR
and
\fBopenssl zlib\fR
are not available, MySQL distributions include
\fBlz4_decompress\fR
and
\fBzlib_decompress\fR
utilities that can be used to decompress
\fBmysqlpump\fR
output that was compressed using the
\fB\-\-compress\-output=LZ4\fR
and
\fB\-\-compress\-output=ZLIB\fR
options\&. For more information, see
lz4_decompress(1), and
zlib_decompress(1)\&.
.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
lB l.
T{
Command-Line Format
T}:T{
--compression-algorithms=value
T}
T{
Introduced
T}:T{
8.0.18
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\&.
.sp
This option was added in MySQL 8\&.0\&.18\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-databases\fR,
\fB\-B\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--databases
T}
.TE
.sp 1
Normally,
\fBmysqlpump\fR
treats the first name argument on the command line as a database name and any following names as table names\&. With this option, it treats all name arguments as database names\&.
CREATE DATABASE
statements are included in the output before each new database\&.
.sp
\fB\-\-all\-databases\fR
and
\fB\-\-databases\fR
are mutually exclusive\&.
.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
See the
\fB\-\-add\-drop\-database\fR
description for information about an incompatibility of that option with
\fB\-\-databases\fR\&.
.sp .5v
.RE
.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/mysqlpump.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/mysqlpump\&.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\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--default-character-set=charset_name
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
utf8
T}
.TE
.sp 1
Use
\fIcharset_name\fR
as the default character set\&. See
Section\ \&12.15, \(lqCharacter Set Configuration\(rq\&. If no character set is specified,
\fBmysqlpump\fR
uses
utf8mb4\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-default\-parallelism=\fR\fB\fIN\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--default-parallelism=N
T}
T{
Type
T}:T{
Integer
T}
T{
Default Value
T}:T{
2
T}
.TE
.sp 1
The default number of threads for each parallel processing queue\&. The default is 2\&.
.sp
The
\fB\-\-parallel\-schemas\fR
option also affects parallelism and can be used to override the default number of threads\&. For more information, see
mysqlpump Parallel Processing\&.
.sp
With
\fB\-\-default\-parallelism=0\fR
and no
\fB\-\-parallel\-schemas\fR
options,
\fBmysqlpump\fR
runs as a single\-threaded process and creates no queues\&.
.sp
With parallelism enabled, it is possible for output from different databases to be interleaved\&.
.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,
\fBmysqlpump\fR
normally reads the
[client]
and
[mysqlpump]
groups\&. If this option is given as
\fB\-\-defaults\-group\-suffix=_other\fR,
\fBmysqlpump\fR
also reads the
[client_other]
and
[mysqlpump_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\-\-defer\-table\-indexes\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--defer-table-indexes
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
TRUE
T}
.TE
.sp 1
In the dump output, defer index creation for each table until after its rows have been loaded\&. This works for all storage engines, but for
InnoDB
applies only for secondary indexes\&.
.sp
This option is enabled by default; use
\fB\-\-skip\-defer\-table\-indexes\fR
to disable it\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-events\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--events
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
TRUE
T}
.TE
.sp 1
Include Event Scheduler events for the dumped databases in the output\&. Event dumping requires the
EVENT
privileges for those databases\&.
.sp
The output generated by using
\fB\-\-events\fR
contains
CREATE EVENT
statements to create the events\&.
.sp
This option is enabled by default; use
\fB\-\-skip\-events\fR
to disable it\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-exclude\-databases=\fR\fB\fIdb_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--exclude-databases=db_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Do not dump the databases in
\fIdb_list\fR, which is a list of one or more comma\-separated database names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-exclude\-events=\fR\fB\fIevent_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--exclude-events=event_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Do not dump the databases in
\fIevent_list\fR, which is a list of one or more comma\-separated event names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-exclude\-routines=\fR\fB\fIroutine_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--exclude-routines=routine_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Do not dump the events in
\fIroutine_list\fR, which is a list of one or more comma\-separated routine (stored procedure or function) names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-exclude\-tables=\fR\fB\fItable_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--exclude-tables=table_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Do not dump the tables in
\fItable_list\fR, which is a list of one or more comma\-separated table names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-exclude\-triggers=\fR\fB\fItrigger_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--exclude-triggers=trigger_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Do not dump the triggers in
\fItrigger_list\fR, which is a list of one or more comma\-separated trigger names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-exclude\-users=\fR\fB\fIuser_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--exclude-users=user_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Do not dump the user accounts in
\fIuser_list\fR, which is a list of one or more comma\-separated account names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-extended\-insert=\fR\fB\fIN\fR\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--extended-insert=N
T}
.TE
.sp 1
Write
INSERT
statements using multiple\-row syntax that includes several
VALUES
lists\&. This results in a smaller dump file and speeds up inserts when the file is reloaded\&.
.sp
The option value indicates the number of rows to include in each
INSERT
statement\&. The default is 250\&. A value of 1 produces one
INSERT
statement per table row\&.
.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 public key required for RSA key pair\-based password exchange\&. This option applies to clients that authenticate with the
caching_sha2_password
authentication plugin\&. For that plugin, the server does not send the public key unless requested\&. This option is ignored for accounts that do not authenticate with that plugin\&. 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 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\-\-hex\-blob\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--hex-blob
T}
.TE
.sp 1
Dump binary columns using hexadecimal notation (for example,
\*(Aqabc\*(Aq
becomes
0x616263)\&. The affected data types are
BINARY,
VARBINARY,
BLOB
types,
BIT, all spatial data types, and other non\-binary data types when used with the
binary character set\&.
.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.
T{
Command-Line Format
T}:T{
--host
T}
.TE
.sp 1
Dump data from 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\-\-include\-databases=\fR\fB\fIdb_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--include-databases=db_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Dump the databases in
\fIdb_list\fR, which is a list of one or more comma\-separated database names\&. The dump includes all objects in the named databases\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-events=\fR\fB\fIevent_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--include-events=event_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Dump the events in
\fIevent_list\fR, which is a list of one or more comma\-separated event names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-routines=\fR\fB\fIroutine_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--include-routines=routine_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Dump the routines in
\fIroutine_list\fR, which is a list of one or more comma\-separated routine (stored procedure or function) names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-tables=\fR\fB\fItable_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--include-tables=table_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Dump the tables in
\fItable_list\fR, which is a list of one or more comma\-separated table names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-triggers=\fR\fB\fItrigger_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--include-triggers=trigger_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Dump the triggers in
\fItrigger_list\fR, which is a list of one or more comma\-separated trigger names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-users=\fR\fB\fIuser_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--include-users=user_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Dump the user accounts in
\fIuser_list\fR, which is a list of one or more comma\-separated user names\&. Multiple instances of this option are additive\&. For more information, see
mysqlpump Object Selection\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-insert\-ignore\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--insert-ignore
T}
.TE
.sp 1
Write
INSERT IGNORE
statements rather than
INSERT
statements\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-log\-error\-file=\fR\fB\fIfile_name\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--log-error-file=file_name
T}
T{
Type
T}:T{
File name
T}
.TE
.sp 1
Log warnings and errors by appending them to the named file\&. If this option is not given,
\fBmysqlpump\fR
writes warnings and errors to the standard error output\&.
.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\-\-max\-allowed\-packet=\fR\fB\fIN\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--max-allowed-packet=N
T}
T{
Type
T}:T{
Numeric
T}
T{
Default Value
T}:T{
25165824
T}
.TE
.sp 1
The maximum size of the buffer for client/server communication\&. The default is 24MB, the maximum is 1GB\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-net\-buffer\-length=\fR\fB\fIN\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--net-buffer-length=N
T}
T{
Type
T}:T{
Numeric
T}
T{
Default Value
T}:T{
1047552
T}
.TE
.sp 1
The initial size of the buffer for client/server communication\&. When creating multiple\-row
INSERT
statements (as with the
\fB\-\-extended\-insert\fR
option),
\fBmysqlpump\fR
creates rows up to
\fIN\fR
bytes long\&. If you use this option to increase the value, ensure that the MySQL server
net_buffer_length
system variable has a value at least this large\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-no\-create\-db\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--no-create-db
T}
.TE
.sp 1
Suppress any
CREATE DATABASE
statements that might otherwise be included in the output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-no\-create\-info\fR,
\fB\-t\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--no-create-info
T}
.TE
.sp 1
Do not write
CREATE TABLE
statements that create each dumped table\&.
.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\-\-parallel\-schemas=[\fR\fB\fIN\fR\fR\fB:]\fR\fB\fIdb_list\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--parallel-schemas=[N:]schema_list
T}
T{
Type
T}:T{
String
T}
.TE
.sp 1
Create a queue for processing the databases in
\fIdb_list\fR, which is a list of one or more comma\-separated database names\&. If
\fIN\fR
is given, the queue uses
\fIN\fR
threads\&. If
\fIN\fR
is not given, the
\fB\-\-default\-parallelism\fR
option determines the number of queue threads\&.
.sp
Multiple instances of this option create multiple queues\&.
\fBmysqlpump\fR
also creates a default queue to use for databases not named in any
\fB\-\-parallel\-schemas\fR
option, and for dumping user definitions if command options select them\&. For more information, see
mysqlpump Parallel Processing\&.
.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,
\fBmysqlpump\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
\fBmysqlpump\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,
\fBmysqlpump\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
\fBmysqlpump\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\-\-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
\fBmysqlpump\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\-\-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\-\-replace\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--replace
T}
.TE
.sp 1
Write
REPLACE
statements rather than
INSERT
statements\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--result-file=file_name
T}
T{
Type
T}:T{
File name
T}
.TE
.sp 1
Direct output to the named file\&. The result file is created and its previous contents overwritten, even if an error occurs while generating the dump\&.
.sp
This option should be used on Windows to prevent newline
\en
characters from being converted to
\er\en
carriage return/newline sequences\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-routines\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--routines
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
TRUE
T}
.TE
.sp 1
Include stored routines (procedures and functions) for the dumped databases in the output\&. This option requires the global
SELECT
privilege\&.
.sp
The output generated by using
\fB\-\-routines\fR
contains
CREATE PROCEDURE
and
CREATE FUNCTION
statements to create the routines\&.
.sp
This option is enabled by default; use
\fB\-\-skip\-routines\fR
to disable it\&.
.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
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, 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\-\-set\-charset\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--set-charset
T}
.TE
.sp 1
Write
SET NAMES \fIdefault_character_set\fR
to the output\&.
.sp
This option is enabled by default\&. To disable it and suppress the
SET NAMES
statement, use
\fB\-\-skip\-set\-charset\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-set\-gtid\-purged=\fR\fB\fIvalue\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--set-gtid-purged=value
T}
T{
Type
T}:T{
Enumeration
T}
T{
Default Value
T}:T{
AUTO
T}
T{
Valid Values
T}:T{
.PP
OFF
.PP
ON
.PP
AUTO
T}
.TE
.sp 1
This option enables control over global transaction ID (GTID) information written to the dump file, by indicating whether to add a
SET @@GLOBAL\&.gtid_purged
statement to the output\&. This option may also cause a statement to be written to the output that disables binary logging while the dump file is being reloaded\&.
.sp
The following table shows the permitted option values\&. The default value is
AUTO\&.
.TS
allbox tab(:);
lB lB.
T{
Value
T}:T{
Meaning
T}
.T&
l l
l l
l l.
T{
OFF
T}:T{
Add no SET statement to the output.
T}
T{
ON
T}:T{
Add a SET statement to the output. An error occurs if
                  GTIDs are not enabled on the server.
T}
T{
AUTO
T}:T{
Add a SET statement to the output if GTIDs are
                  enabled on the server.
T}
.TE
.sp 1
The
\fB\-\-set\-gtid\-purged\fR
option has the following effect on binary logging when the dump file is reloaded:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-set\-gtid\-purged=OFF\fR:
SET @@SESSION\&.SQL_LOG_BIN=0;
is not added to the output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-set\-gtid\-purged=ON\fR:
SET @@SESSION\&.SQL_LOG_BIN=0;
is added to the output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-set\-gtid\-purged=AUTO\fR:
SET @@SESSION\&.SQL_LOG_BIN=0;
is added to the output if GTIDs are enabled on the server you are backing up (that is, if
AUTO
evaluates to
ON)\&.
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-single\-transaction\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--single-transaction
T}
.TE
.sp 1
This option sets the transaction isolation mode to
REPEATABLE READ
and sends a
START TRANSACTION
SQL statement to the server before dumping data\&. It is useful only with transactional tables such as
InnoDB, because then it dumps the consistent state of the database at the time when
START TRANSACTION
was issued without blocking any applications\&.
.sp
When using this option, you should keep in mind that only
InnoDB
tables are dumped in a consistent state\&. For example, any
MyISAM
or
MEMORY
tables dumped while using this option may still change state\&.
.sp
While a
\fB\-\-single\-transaction\fR
dump is in process, to ensure a valid dump file (correct table contents and binary log coordinates), no other connection should use the following statements:
ALTER TABLE,
CREATE TABLE,
DROP TABLE,
RENAME TABLE,
TRUNCATE TABLE\&. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the
SELECT
that is performed by
\fBmysqlpump\fR
to retrieve the table contents to obtain incorrect contents or fail\&.
.sp
\fB\-\-add\-locks\fR
and
\fB\-\-single\-transaction\fR
are mutually exclusive\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-skip\-definer\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--skip-definer
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
FALSE
T}
.TE
.sp 1
Omit
DEFINER
and
SQL SECURITY
clauses from the
CREATE
statements for views and stored programs\&. The dump file, when reloaded, creates objects that use the default
DEFINER
and
SQL SECURITY
values\&. See
Section\ \&27.6, \(lqStored Object Access Control\(rq\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-skip\-dump\-rows\fR,
\fB\-d\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--skip-dump-rows
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
FALSE
T}
.TE
.sp 1
Do not dump table rows\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-skip\-generated\-invisible\-primary\-key\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--skip-generated-invisible-primary-key
T}
T{
Introduced
T}:T{
8.0.30
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
FALSE
T}
.TE
.sp 1
This option is available beginning with MySQL 8\&.0\&.30, and causes generated invisible primary keys (GIPKs) to be excluded from the dump\&. See
Section\ \&15.1.20.11, \(lqGenerated Invisible Primary Keys\(rq, for more information about GIPKs and GIPK mode\&.
.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\-\-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{
8.0.34
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
As of MySQL 8\&.0\&.34, 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
lB l.
T{
Command-Line Format
T}:T{
--tls-ciphersuites=ciphersuite_list
T}
T{
Introduced
T}:T{
8.0.16
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\&.
.sp
This option was added in MySQL 8\&.0\&.16\&.
.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
lB l.
T{
Command-Line Format
T}:T{
--tls-version=protocol_list
T}
T{
Type
T}:T{
String
T}
T{
Default Value (≥ 8.0.16)
T}:T{
.PP
TLSv1,TLSv1.1,TLSv1.2,TLSv1.3
(OpenSSL 1.1.1 or higher)
.PP
TLSv1,TLSv1.1,TLSv1.2
(otherwise)
T}
T{
Default Value (≤ 8.0.15)
T}:T{
TLSv1,TLSv1.1,TLSv1.2
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\-\-triggers\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--triggers
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
TRUE
T}
.TE
.sp 1
Include triggers for each dumped table in the output\&.
.sp
This option is enabled by default; use
\fB\-\-skip\-triggers\fR
to disable it\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-tz\-utc\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--tz-utc
T}
.TE
.sp 1
This option enables
TIMESTAMP
columns to be dumped and reloaded between servers in different time zones\&.
\fBmysqlpump\fR
sets its connection time zone to UTC and adds
SET TIME_ZONE=\*(Aq+00:00\*(Aq
to the dump file\&. Without this option,
TIMESTAMP
columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change if the servers are in different time zones\&.
\fB\-\-tz\-utc\fR
also protects against changes due to daylight saving time\&.
.sp
This option is enabled by default; use
\fB\-\-skip\-tz\-utc\fR
to disable it\&.
.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\&.
.sp
If you are using the
Rewriter
plugin with MySQL 8\&.0\&.31 or later, you should grant this user the
SKIP_QUERY_REWRITE
privilege\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-users\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--users
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
FALSE
T}
.TE
.sp 1
Dump user accounts as logical definitions in the form of
CREATE USER
and
GRANT
statements\&.
.sp
User definitions are stored in the grant tables in the
mysql
system database\&. By default,
\fBmysqlpump\fR
does not include the grant tables in
mysql
database dumps\&. To dump the contents of the grant tables as logical definitions, use the
\fB\-\-users\fR
option and suppress all database dumping:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-exclude\-databases=% \-\-users
.fi
.if n \{\
.RE
.\}
.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\-\-watch\-progress\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--watch-progress
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
TRUE
T}
.TE
.sp 1
Periodically display a progress indicator that provides information about the completed and total number of tables, rows, and other objects\&.
.sp
This option is enabled by default; use
\fB\-\-skip\-watch\-progress\fR
to disable it\&.
.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
lB l.
T{
Command-Line Format
T}:T{
--zstd-compression-level=#
T}
T{
Introduced
T}:T{
8.0.18
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\&.
.sp
This option was added in MySQL 8\&.0\&.18\&.
.RE
mysqlpump Object Selection
.PP
\fBmysqlpump\fR
has a set of inclusion and exclusion options that enable filtering of several object types and provide flexible control over which objects to dump:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-databases\fR
and
\fB\-\-exclude\-databases\fR
apply to databases and all objects within them\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-tables\fR
and
\fB\-\-exclude\-tables\fR
apply to tables\&. These options also affect triggers associated with tables unless the trigger\-specific options are given\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-triggers\fR
and
\fB\-\-exclude\-triggers\fR
apply to triggers\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-routines\fR
and
\fB\-\-exclude\-routines\fR
apply to stored procedures and functions\&. If a routine option matches a stored procedure name, it also matches a stored function of the same name\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-events\fR
and
\fB\-\-exclude\-events\fR
apply to Event Scheduler events\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-include\-users\fR
and
\fB\-\-exclude\-users\fR
apply to user accounts\&.
.RE
.PP
Any inclusion or exclusion option may be given multiple times\&. The effect is additive\&. Order of these options does not matter\&.
.PP
The value of each inclusion and exclusion option is a list of comma\-separated names of the appropriate object type\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
\-\-exclude\-databases=test,world
\-\-include\-tables=customer,invoice
.fi
.if n \{\
.RE
.\}
.PP
Wildcard characters are permitted in the object names:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%
matches any sequence of zero or more characters\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
_
matches any single character\&.
.RE
.PP
For example,
\fB\-\-include\-tables=t%,__tmp\fR
matches all table names that begin with
t
and all five\-character table names that end with
tmp\&.
.PP
For users, a name specified without a host part is interpreted with an implied host of
%\&. For example,
u1
and
u1@%
are equivalent\&. This is the same equivalence that applies in MySQL generally (see
Section\ \&8.2.4, \(lqSpecifying Account Names\(rq)\&.
.PP
Inclusion and exclusion options interact as follows:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
By default, with no inclusion or exclusion options,
\fBmysqlpump\fR
dumps all databases (with certain exceptions noted in
mysqlpump Restrictions)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If inclusion options are given in the absence of exclusion options, only the objects named as included are dumped\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If exclusion options are given in the absence of inclusion options, all objects are dumped except those named as excluded\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If inclusion and exclusion options are given, all objects named as excluded and not named as included are not dumped\&. All other objects are dumped\&.
.RE
.PP
If multiple databases are being dumped, it is possible to name tables, triggers, and routines in a specific database by qualifying the object names with the database name\&. The following command dumps databases
db1
and
db2, but excludes tables
db1\&.t1
and
db2\&.t2:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-include\-databases=db1,db2 \-\-exclude\-tables=db1\&.t1,db2\&.t2
.fi
.if n \{\
.RE
.\}
.PP
The following options provide alternative ways to specify which databases to dump:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
\fB\-\-all\-databases\fR
option dumps all databases (with certain exceptions noted in
mysqlpump Restrictions)\&. It is equivalent to specifying no object options at all (the default
\fBmysqlpump\fR
action is to dump everything)\&.
.sp
\fB\-\-include\-databases=%\fR
is similar to
\fB\-\-all\-databases\fR, but selects all databases for dumping, even those that are exceptions for
\fB\-\-all\-databases\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
\fB\-\-databases\fR
option causes
\fBmysqlpump\fR
to treat all name arguments as names of databases to dump\&. It is equivalent to an
\fB\-\-include\-databases\fR
option that names the same databases\&.
.RE
mysqlpump Parallel Processing
.PP
\fBmysqlpump\fR
can use parallelism to achieve concurrent processing\&. You can select concurrency between databases (to dump multiple databases simultaneously) and within databases (to dump multiple objects from a given database simultaneously)\&.
.PP
By default,
\fBmysqlpump\fR
sets up one queue with two threads\&. You can create additional queues and control the number of threads assigned to each one, including the default queue:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-default\-parallelism=\fR\fB\fIN\fR\fR
specifies the default number of threads used for each queue\&. In the absence of this option,
\fIN\fR
is 2\&.
.sp
The default queue always uses the default number of threads\&. Additional queues use the default number of threads unless you specify otherwise\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-parallel\-schemas=[\fR\fB\fIN\fR\fR\fB:]\fR\fB\fIdb_list\fR\fR
sets up a processing queue for dumping the databases named in
\fIdb_list\fR
and optionally specifies how many threads the queue uses\&.
\fIdb_list\fR
is a list of comma\-separated database names\&. If the option argument begins with
\fIN\fR:, the queue uses
\fIN\fR
threads\&. Otherwise, the
\fB\-\-default\-parallelism\fR
option determines the number of queue threads\&.
.sp
Multiple instances of the
\fB\-\-parallel\-schemas\fR
option create multiple queues\&.
.sp
Names in the database list are permitted to contain the same
%
and
_
wildcard characters supported for filtering options (see
mysqlpump Object Selection)\&.
.RE
.PP
\fBmysqlpump\fR
uses the default queue for processing any databases not named explicitly with a
\fB\-\-parallel\-schemas\fR
option, and for dumping user definitions if command options select them\&.
.PP
In general, with multiple queues,
\fBmysqlpump\fR
uses parallelism between the sets of databases processed by the queues, to dump multiple databases simultaneously\&. For a queue that uses multiple threads,
\fBmysqlpump\fR
uses parallelism within databases, to dump multiple objects from a given database simultaneously\&. Exceptions can occur; for example,
\fBmysqlpump\fR
may block queues while it obtains from the server lists of objects in databases\&.
.PP
With parallelism enabled, it is possible for output from different databases to be interleaved\&. For example,
INSERT
statements from multiple tables dumped in parallel can be interleaved; the statements are not written in any particular order\&. This does not affect reloading because output statements qualify object names with database names or are preceded by
USE
statements as required\&.
.PP
The granularity for parallelism is a single database object\&. For example, a single table cannot be dumped in parallel using multiple threads\&.
.PP
Examples:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-parallel\-schemas=db1,db2 \-\-parallel\-schemas=db3
.fi
.if n \{\
.RE
.\}
.PP
\fBmysqlpump\fR
sets up a queue to process
db1
and
db2, another queue to process
db3, and a default queue to process all other databases\&. All queues use two threads\&.
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-parallel\-schemas=db1,db2 \-\-parallel\-schemas=db3
          \-\-default\-parallelism=4
.fi
.if n \{\
.RE
.\}
.PP
This is the same as the previous example except that all queues use four threads\&.
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump \-\-parallel\-schemas=5:db1,db2 \-\-parallel\-schemas=3:db3
.fi
.if n \{\
.RE
.\}
.PP
The queue for
db1
and
db2
uses five threads, the queue for
db3
uses three threads, and the default queue uses the default of two threads\&.
.PP
As a special case, with
\fB\-\-default\-parallelism=0\fR
and no
\fB\-\-parallel\-schemas\fR
options,
\fBmysqlpump\fR
runs as a single\-threaded process and creates no queues\&.
mysqlpump Restrictions
.PP
\fBmysqlpump\fR
does not dump the
performance_schema,
ndbinfo, or
sys
schema by default\&. To dump any of these, name them explicitly on the command line\&. You can also name them with the
\fB\-\-databases\fR
or
\fB\-\-include\-databases\fR
option\&.
.PP
\fBmysqlpump\fR
does not dump the
INFORMATION_SCHEMA
schema\&.
.PP
\fBmysqlpump\fR
does not dump
InnoDB
CREATE TABLESPACE
statements\&.
.PP
\fBmysqlpump\fR
dumps user accounts in logical form using
CREATE USER
and
GRANT
statements (for example, when you use the
\fB\-\-include\-users\fR
or
\fB\-\-users\fR
option)\&. For this reason, dumps of the
mysql
system database do not by default include the grant tables that contain user definitions:
user,
db,
tables_priv,
columns_priv,
procs_priv, or
proxies_priv\&. To dump any of the grant tables, name the
mysql
database followed by the table names:
.sp
.if n \{\
.RS 4
.\}
.nf
mysqlpump mysql user db \&.\&.\&.
.fi
.if n \{\
.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 "NOTES"
.IP " 1." 4
MySQL Shell dump utilities
.RS 4
\%https://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-utilities-dump-instance-schema.html
.RE
.IP " 2." 4
MySQL Shell load dump utilities
.RS 4
\%https://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-utilities-load-dump.html
.RE
.IP " 3." 4
here
.RS 4
\%https://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-install.html
.RE
.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/).