mysqlpump Invocation Syntax

mysqlpump Option Summary

mysqlpump Option Descriptions

mysqlpump Object Selection

mysqlpump Parallel Processing

mysqlpump Restrictions

Parallel processing of databases, and of objects within databases, to speed up the dump process

Better control over which databases and database objects (tables, stored programs, user accounts) to dump

Dumping of user accounts as account-management statements (CREATE USER, GRANT) rather than as inserts into the mysql system database

Capability of creating compressed output

Progress indicator (the values are estimates)

For dump file reloading, faster secondary index creation for InnoDB tables by adding indexes after rows are inserted

--help, -?

Display a help message and exit.

--add-drop-database

Write a DROP DATABASE statement before each CREATE DATABASE statement.

--add-drop-table

Write a DROP TABLE statement before each CREATE TABLE statement.

--add-drop-user

Write a DROP USER statement before each CREATE USER statement.

--add-locks

Surround each table dump with LOCK TABLES and UNLOCK TABLES statements. This results in faster inserts when the dump file is reloaded. See Section 8.2.4.1, “Optimizing INSERT Statements”.

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.

--add-locks and --single-transaction are mutually exclusive.

--all-databases, -A

Dump all databases (with certain exceptions noted in mysqlpump Restrictions). This is the default behavior if no other is specified explicitly.

--all-databases and --databases are mutually exclusive.

--bind-address=ip_address

On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server.

--character-sets-dir=path

The directory where character sets are installed. See Section 10.5, “Character Set Configuration”.

--complete-insert

Write complete INSERT statements that include column names.

--compress, -C

Compress all information sent between the client and the server if both support compression.

--compress-output=algorithm

By default, mysqlpump does not compress output. This option specifies output compression using the specified algorithm. Permitted algorithms are LZ4 and ZLIB.

To uncompress compressed output, you must have an appropriate utility. If the system commands lz4 and openssl zlib are not available, as of MySQL 5.7.10, MySQL distributions include lz4_decompress and zlib_decompress utilities that can be used to decompress mysqlpump output that was compressed using the --compress-output=LZ4 and --compress-output=ZLIB options. For more information, see Section 4.8.1, “lz4_decompress — Decompress mysqlpump LZ4-Compressed Output”, and Section 4.8.5, “zlib_decompress — Decompress mysqlpump ZLIB-Compressed Output”.

Alternatives include the lz4 and openssl commands, if they are installed on your system. For example, lz4 can uncompress LZ4 output:

shell> lz4 -d input_file output_file

ZLIB output can be uncompresed like this:

shell> openssl zlib -d < input_file > output_file

--databases, -B

Normally, mysqlpump 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.

--all-databases and --databases are mutually exclusive.

--debug[=debug_options], -# [debug_options]

Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:O,/tmp/mysqlpump.trace.

--debug-check

Print some debugging information when the program exits.

--debug-info, -T

Print debugging information and memory and CPU usage statistics when the program exits.

--default-auth=plugin

A hint about the client-side authentication plugin to use. See Section 6.3.9, “Pluggable Authentication”.

--default-character-set=charset_name

Use charset_name as the default character set. See Section 10.5, “Character Set Configuration”. If no character set is specified, mysqlpump uses utf8.

--default-parallelism=N

The default number of threads for each parallel processing queue. The default is 2.

The --parallel-schemas option also affects parallelism and can be used to override the default number of threads. For more information, see mysqlpump Parallel Processing.

With --default-parallelism=0 and no --parallel-schemas options, mysqlpump runs as a single-threaded process and creates no queues.

With parallelism enabled, it is possible for output from different databases to be interleaved.

shell> mysqlpump --single-transaction --default-parallelism=0

--defaults-extra-file=file_name

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. file_name is interpreted relative to the current directory if given as a relative path name rather than a full path name.

--defaults-file=file_name

Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. file_name is interpreted relative to the current directory if given as a relative path name rather than a full path name.

Exception: Even with --defaults-file, client programs read .mylogin.cnf.

--defaults-group-suffix=str

Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysqlpump normally reads the [client] and [mysqlpump] groups. If the --defaults-group-suffix=_other option is given, mysqlpump also reads the [client_other] and [mysqlpump_other] groups.

--defer-table-indexes

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.

This option is enabled by default; use --skip-defer-table-indexes to disable it.

--events

Include Event Scheduler events for the dumped databases in the output. Event dumping requires the EVENT privileges for those databases.

The output generated by using --events contains CREATE EVENT statements to create the events. However, these statements do not include attributes such as the event creation and modification timestamps, so when the events are reloaded, they are created with timestamps equal to the reload time.

If you require events to be created with their original timestamp attributes, do not use --events. Instead, dump and reload the contents of the mysql.event table directly, using a MySQL account that has appropriate privileges for the mysql database.

This option is enabled by default; use --skip-events to disable it.

--exclude-databases=db_list

Do not dump the databases in db_list, which is a comma-separated list of one or more database names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--exclude-events=event_list

Do not dump the databases in event_list, which is a comma-separated list of one or more event names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--exclude-routines=routine_list

Do not dump the events in routine_list, which is a comma-separated list of one or more routine (stored procedure or function) names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--exclude-tables=table_list

Do not dump the tables in table_list, which is a comma-separated list of one or more table names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--exclude-triggers=trigger_list

Do not dump the triggers in trigger_list, which is a comma-separated list of one or more trigger names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--exclude-users=user_list

Do not dump the user accounts in user_list, which is a comma-separated list of one or more account names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--extended-insert=N

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.

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.

--hex-blob

Dump binary columns using hexadecimal notation (for example, 'abc' becomes 0x616263). The affected data types are BINARY, VARBINARY, the BLOB types, and BIT.

--host=host_name, -h host_name

Dump data from the MySQL server on the given host.

--include-databases=db_list

Dump the databases in db_list, which is a comma-separated list of one or more 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.

--include-events=event_list

Dump the events in event_list, which is a comma-separated list of one or more event names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--include-routines=routine_list

Dump the routines in routine_list, which is a comma-separated list of one or more routine (stored procedure or function) names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--include-tables=table_list

Dump the tables in table_list, which is a comma-separated list of one or more table names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--include-triggers=trigger_list

Dump the triggers in trigger_list, which is a comma-separated list of one or more trigger names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--include-users=user_list

Dump the user accounts in user_list, which is a comma-separated list of one or more user names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection.

--insert-ignore

Write INSERT IGNORE statements rather than INSERT statements.

--log-error-file=file_name

Log warnings and errors by appending them to the named file. If this option is not given, mysqlpump writes warnings and errors to the standard error output.

--login-path=name

Read options from the named login path in the .mylogin.cnf login path file. A “login path” 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 mysql_config_editor utility. See Section 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.

--max-allowed-packet=N

The maximum size of the buffer for client/server communication. The default is 24MB, the maximum is 1GB.

--net-buffer-length=N

The initial size of the buffer for client/server communication. When creating multiple-row INSERT statements (as with the --extended-insert option), mysqlpump creates rows up to N 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.

--no-create-db

Suppress any CREATE DATABASE statements that might otherwise be included in the output.

--no-create-info, -t

Do not write CREATE TABLE statements that create each dumped table.

--no-defaults

Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read.

The exception is that the .mylogin.cnf file, if it exists, is read in all cases. This permits passwords to be specified in a safer way than on the command line even when --no-defaults is used. (.mylogin.cnf is created by the mysql_config_editor utility. See Section 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.)

--parallel-schemas=[N:]db_list

Create a queue for processing the databases in db_list, which is a comma-separated list of one or more database names. If N is given, the queue uses N threads. If N is not given, the --default-parallelism option determines the number of queue threads.

Multiple instances of this option create multiple queues. mysqlpump also creates a default queue to use for databases not named in any --parallel-schemas option, and for dumping user definitions if command options select them. For more information, see mysqlpump Parallel Processing.

--password[=password], -p[password]

The password to use when connecting to the server. If you use the short option form (-p), you cannot have a space between the option and the password. If you omit the password value following the --password or -p option on the command line, mysqlpump prompts for one.

Specifying a password on the command line should be considered insecure. See Section 6.1.2.1, “End-User Guidelines for Password Security”. You can use an option file to avoid giving the password on the command line.

--plugin-dir=dir_name

The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authentication plugin but mysqlpump does not find it. See Section 6.3.9, “Pluggable Authentication”.

--port=port_num, -P port_num

The TCP/IP port number to use for the connection.

--print-defaults

Print the program name and all options that it gets from option files.

--protocol={TCP|SOCKET|PIPE|MEMORY}

The connection protocol to use for connecting to the server. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want. For details on the permissible values, see Section 4.2.2, “Connecting to the MySQL Server”.

--replace

Write REPLACE statements rather than INSERT statements.

--result-file=file_name

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.

This option should be used on Windows to prevent newline \n characters from being converted to \r\n carriage return/newline sequences.

--routines

Include stored routines (procedures and functions) for the dumped databases in the output. This option requires the SELECT privilege for the mysql.proc table.

The output generated by using --routines contains CREATE PROCEDURE and CREATE FUNCTION statements to create the routines. However, these statements do not include attributes such as the routine creation and modification timestamps, so when the routines are reloaded, they are created with timestamps equal to the reload time.

If you require routines to be created with their original timestamp attributes, do not use --routines. Instead, dump and reload the contents of the mysql.proc table directly, using a MySQL account that has appropriate privileges for the mysql database.

This option is enabled by default; use --skip-routines to disable it.

--secure-auth

Do not send passwords to the server in old (pre-4.1) format. This prevents connections except for servers that use the newer password format.

This option is deprecated and will be removed in a future MySQL release. It is always enabled and attempting to disable it (--skip-secure-auth, --secure-auth=0) produces an error.

--set-charset

Write SET NAMES default_character_set to the output.

This option is enabled by default. To disable it and suppress the SET NAMES statement, use --skip-set-charset.

--set-gtid-purged=value

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.

The following table shows the permitted option values. The default value is AUTO.

The --set-gtid-purged option has the following effect on binary logging when the dump file is reloaded:

This option was added in MySQL 5.7.18.

--single-transaction

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.

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.

While a --single-transaction 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 mysqlpump to retrieve the table contents to obtain incorrect contents or fail.

--add-locks and --single-transaction are mutually exclusive.

shell> mysqlpump --single-transaction --default-parallelism=0

--skip-definer

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 23.6, “Access Control for Stored Programs and Views”.

--skip-dump-rows, -d

Do not dump table rows.

--socket={file_name|pipe_name}, -S {file_name|pipe_name}

For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.

--ssl*

Options that begin with --ssl specify whether to connect to the server using SSL and indicate where to find SSL keys and certificates. See Section 6.4.5, “Command Options for Secure Connections”.

--tls-version=protocol_list

The protocols permitted by the client for encrypted connections. The value is a comma-separated list containing one or more protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.4.3, “Secure Connection Protocols and Ciphers”.

This option was added in MySQL 5.7.10.

--triggers

Include triggers for each dumped table in the output.

This option is enabled by default; use --skip-triggers to disable it.

--tz-utc

This option enables TIMESTAMP columns to be dumped and reloaded between servers in different time zones. mysqlpump sets its connection time zone to UTC and adds SET TIME_ZONE='+00:00' 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. --tz-utc also protects against changes due to daylight saving time.

This option is enabled by default; use --skip-tz-utc to disable it.

--user=user_name, -u user_name

The MySQL user name to use when connecting to the server.

--users

Dump user accounts as logical definitions in the form of CREATE USER and GRANT statements.

User definitions are stored in the grant tables in the mysql system database. By default, mysqlpump does not include the grant tables in mysql database dumps. To dump the contents of the grant tables as logical definitions, use the --users option and suppress all database dumping:

shell> mysqlpump --exclude-databases=% --users

--version, -V

Display version information and exit.

This option was added in MySQL 5.7.9.

--watch-progress

Periodically display a progress indicator that provides information about the completed and total number of tables, rows, and other objects.

This option is enabled by default; use --skip-watch-progress to disable it.

--include-databases and --exclude-databases apply to databases and all objects within them.

--include-tables and --exclude-tables apply to tables. These options also affect triggers associated with tables unless the trigger-specific options are given.

--include-triggers and --exclude-triggers apply to triggers.

--include-routines and --exclude-routines 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.

--include-events and --exclude-events apply to Event Scheduler events.

--include-users and --exclude-users apply to user accounts.

% matches any sequence of zero or more characters.

_ matches any single character.

By default, with no inclusion or exclusion options, mysqlpump dumps all databases (with certain exceptions noted in mysqlpump Restrictions).

If inclusion options are given in the absence of exclusion options, only the objects named as included are dumped.

If exclusion options are given in the absence of inclusion options, all objects are dumped except those named as excluded.

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.

The --all-databases option dumps all databases (with certain exceptions noted in mysqlpump Restrictions). It is equivalent to specifying no object options at all (the default mysqlpump action is to dump everything).

--include-databases=% is similar to --all-databases, but selects all databases for dumping, even those that are exceptions for --all-databases.

The --databases option causes mysqlpump to treat all name arguments as names of databases to dump. It is equivalent to an --include-databases option that names the same databases.

--default-parallelism=N specifies the default number of threads used for each queue. In the absence of this option, N is 2.

The default queue always uses the default number of threads. Additional queues use the default number of threads unless you specify otherwise.

--parallel-schemas=[N:]db_list sets up a processing queue for dumping the databases named in db_list and optionally specifies how many threads the queue uses. db_list is a comma-separated list of database names. If the option argument begins with N:, the queue uses N threads. Otherwise, the --default-parallelism option determines the number of queue threads.

Multiple instances of the --parallel-schemas option create multiple queues.

Names in the database list are permitted to contain the same % and _ wildcard characters supported for filtering options (see mysqlpump Object Selection).