OS Manuals

/usr/bin/mysqlpump

The MySQL open source relational database

From mysql-8.0 8.0.46-r12 (enterprise-packages), captured 2026-11-08 by running mysqlpump --help (exit 0). permalink

Also provided by 3 other package versions
WARNING: mysqlpump is deprecated and will be removed in a future version. Use mysqldump instead.
mysqlpump  Ver 8.0.46 for Linux on x86_64 (Source distribution)
Copyright (c) 2014, 2026, Oracle and/or its affiliates.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

MySQL utility for dumping data from databases to external file.
Usage: mysqlpump [OPTIONS] [--all-databases]
OR     mysqlpump [OPTIONS] --databases DB1 [DB2 DB3...]
OR     mysqlpump [OPTIONS] database [tables]

Default options are read from the following files in the given order:
/etc/mysql/my.cnf /etc/my.cnf ~/.my.cnf
The following groups are read: client mysql_dump mysqlpump
The following options may be given as the first argument:
--print-defaults        Print the program argument list and exit.
--no-defaults           Don't read default options from any option file,
                        except for login file.
--defaults-file=#       Only read default options from the given file #.
--defaults-extra-file=# Read this file after the global files are read.
--defaults-group-suffix=#
                        Also read groups with concat(group, suffix)
--login-path=#          Read this path from the login file.
  -?, --help          Display this help message and exit.
  --add-drop-database Add a DROP DATABASE before each CREATE DATABASE.
  --add-drop-table    Add a DROP TABLE before each CREATE TABLE.
  --add-drop-user     Add a DROP USER before each CREATE USER.
  --add-locks         Wrap data inserts on table with write lock on that table
                      in output. This doesn't work with parallelism.
  -A, --all-databases Dump all databases. This is default behaviour if no
                      positional options are specified. Specifying this option
                      is mutually exclusive with --databases.
  --bind-address=name IP address to bind to.
  --character-sets-dir=name
                      Directory for character set files.
  --column-statistics Add an ANALYZE TABLE statement to regenerate any existing
                      column statistics.
  --complete-insert   Use complete insert statements, include column names.
  -C, --compress      Use compression in server/client protocol.
  --compress-output=name
                      Compresses all output files with LZ4 or ZLIB compression
                      algorithm.
  --compression-algorithms=name
                      Use compression algorithm in server/client protocol.
                      Valid values are any combination of
                      'zstd','zlib','uncompressed'
  -B, --databases     Dump selected databases, specified in positional options.
                      Specifying this option is mutually exclusive with
                      --all-databases.
  -#, --debug[=#]     This is a non-debug version. Catch this and exit.
  --debug-check[=#]   This is a non-debug version. Catch this and exit.
  --debug-info[=#]    This is a non-debug version. Catch this and exit.
  --default-character-set=name
                      Set the default character set.
  --default-parallelism=#
                      Specifies number of threads to process each parallel
                      queue for values N > 0. if N is 0 then no queue will be
                      used. Default value is 2. If N > 1 then objects in dump
                      file can have lines intersected. Usage of values greater
                      than 1 is mutually exclusive with --single-transaction.
  --default-auth=name Default authentication client-side plugin to use.
  --defer-table-indexes
                      Defer addition of indexes of table to be added after all
                      rows are dumped.
                      (Defaults to on; use --skip-defer-table-indexes to disable.)
  --events            Dump event scheduler events.
                      (Defaults to on; use --skip-events to disable.)
  --exclude-databases=name
                      Specifies comma-separated list of databases to exclude.
  --exclude-events=name
                      Specifies comma-separated list of events to exclude.
  --exclude-routines=name
                      Specifies comma-separated list of stored procedures or
                      functions to exclude.
  --exclude-tables=name
                      Specifies comma-separated list of tables to exclude.
  --exclude-triggers=name
                      Specifies comma-separated list of triggers to exclude.
  --exclude-users=name
                      Specifies comma-separated list of users to exclude.
  --extended-insert=# Allow usage of multiple-row INSERT syntax that include
                      several VALUES lists. Specifies number of rows to include
                      in single INSERT statement. Must be greater than 0
  --get-server-public-key
                      Get public key from server
  --hex-blob          Dump binary strings (in fields of type BINARY, VARBINARY,
                      BLOB, ...) in hexadecimal format.
  -h, --host=name     Connect to host.
  --include-databases=name
                      Specifies comma-separated list of databases and all of
                      its objects to include. If there are no exclusions then
                      only included objects will be dumped. Otherwise all
                      objects that are not on exclusion lists or are on
                      inclusion list will be dumped.
  --include-events=name
                      Specifies comma-separated list of events to include. If
                      there is no exclusions then only included objects will be
                      dumped. Otherwise all objects that are not on exclusion
                      lists or are on inclusion list will be dumped.
  --include-routines=name
                      Specifies comma-separated list of stored procedures or
                      functions to include. If there is no exclusions then only
                      included objects will be dumped. Otherwise all objects
                      that are not on exclusion lists or are on inclusion list
                      will be dumped.
  --include-tables=name
                      Specifies comma-separated list of tables to include. If
                      there is no exclusions then only included objects will be
                      dumped. Otherwise all objects that are not on exclusion
                      lists or are on inclusion list will be dumped.
  --include-triggers=name
                      Specifies comma-separated list of triggers to include. If
                      there is no exclusions then only included objects will be
                      dumped. Otherwise all objects that are not on exclusion
                      lists or are on inclusion list will be dumped.
  --include-users=name
                      Specifies comma-separated list of users to include. If
                      there is no exclusions then only included objects will be
                      dumped. Otherwise all objects that are not on exclusion
                      lists or are on inclusion list will be dumped.
  --insert-ignore     Use INSERT IGNORE INTO for dumped rows instead of INSERT
                      INTO.
  --log-error-file=name
                      Append warnings and errors to specified file.
  --max-allowed-packet=#
                      The maximum packet length to send to or receive from
                      server.
  --net-buffer-length=#
                      The buffer size for TCP/IP and socket communication.
  --no-create-db      Suppress CREATE DATABASE statements.
  -t, --no-create-info
                      Suppress CREATE TABLE statements.
  --parallel-schemas=name
                      [N:]<list of: schema_name separated with ','>. Process
                      tables in specified schemas using separate queue handled
                      by --default-parallelism threads or N threads, if N is
                      specified. Can be used multiple times to specify more
                      parallel processes.
  -p, --password[=name]
                      Password to use when connecting to server. If password is
                      not given, it's solicited on the tty.
  --password1[=name]  Password for first factor authentication plugin.
  --password2[=name]  Password for second factor authentication plugin.
  --password3[=name]  Password for third factor authentication plugin.
  --plugin-dir=name   Directory for client-side plugins.
  -P, --port=#        Port number to use for connection.
  --protocol=name     The protocol to use for connection (tcp, socket, pipe,
                      memory).
  --replace           Use REPLACE INTO for dumped rows instead of INSERT INTO.
  --result-file=name  Direct all output generated for all objects to a given
                      file.
  --routines          Dump stored procedures and functions.
                      (Defaults to on; use --skip-routines to disable.)
  --server-public-key-path=name
                      Path to file containing server public key
  --set-charset       Add 'SET NAMES default_character_set' to the output to
                      keep charsets consistent.
                      (Defaults to on; use --skip-set-charset to disable.)
  --set-gtid-purged=name
                      Add 'SET @@GLOBAL.GTID_PURGED' to the output. Possible
                      values for this option are ON, OFF and AUTO. If ON is
                      used and GTIDs are not enabled on the server, an error is
                      generated. If OFF is used, this option does nothing. If
                      AUTO is used and GTIDs are enabled on the server, 'SET
                      @@GLOBAL.GTID_PURGED' is added to the output. If GTIDs
                      are disabled, AUTO does nothing. If no value is supplied
                      then the default (AUTO) value will be considered.
  --single-transaction
                      Creates a consistent snapshot by dumping all tables in a
                      single transaction. Works ONLY for tables stored in
                      storage engines which support multiversioning (currently
                      only InnoDB does); the dump is NOT guaranteed to be
                      consistent for other storage engines. While a
                      --single-transaction dump is in process, to ensure a
                      valid dump file (correct table contents and binary log
                      position), no other connection should use the following
                      statements: ALTER TABLE, DROP TABLE, RENAME TABLE,
                      TRUNCATE TABLE, as consistent snapshot is not isolated
                      from them. This option is mutually exclusive with
                      --add-locks option.
  --skip-definer      Skip DEFINER and SQL SECURITY clauses for Views and
                      Stored Routines.
  -d, --skip-dump-rows
                      Skip dumping rows of all tables to output.
  --skip-generated-invisible-primary-key
                      Controls whether generated primary key and key column
                      should be dumped or not.
  -S, --socket=name   The socket file to use for connection.
  --ssl-ca=name       CA file in PEM format.
  --ssl-capath=name   CA directory.
  --ssl-cert=name     X509 cert in PEM format.
  --ssl-cipher=name   SSL cipher to use.
  --ssl-crl=name      Certificate revocation list.
  --ssl-crlpath=name  Certificate revocation list path.
  --ssl-fips-mode=name
                      SSL fips mode to use.
  --ssl-key=name      X509 key in PEM format.
  --ssl-mode=name     SSL connection mode.
  --ssl-session-data=name
                      Session data file to use to enable ssl session reuse
  --ssl-session-data-continue-on-failed-reuse
                      If set to ON, this option will allow connection to
                      succeed even if session data cannot be reused.
  --tls-ciphersuites=name
                      TLS v1.3 cipher to use.
  --tls-version=name  TLS version to use.
  --triggers          Dump triggers.
                      (Defaults to on; use --skip-triggers to disable.)
  --tz-utc            SET TIME_ZONE='+00:00' at top of dump to allow dumping of
                      TIMESTAMP data when a server has data in different time
                      zones or data is being moved between servers with
                      different time zones.
                      (Defaults to on; use --skip-tz-utc to disable.)
  -u, --user=name     User for login if not current user.
  --users             Dump users with their privileges in GRANT format.
                      Disabled by default.
  -V, --version       Output version information and exit.
  --watch-progress    Shows periodically dump process progress information on
                      error output. Progress information include both completed
                      and total number of tables, rows and other objects
                      collected.
                      (Defaults to on; use --skip-watch-progress to disable.)
  --zstd-compression-level=#
                      Use this compression level in the client/server protocol,
                      in case --compression-algorithms=zstd. Valid range is
                      between 1 and 22, inclusive. Default is 3.

Variables (--variable-name=value)
and boolean options {FALSE|TRUE}          Value (after reading options)
----------------------------------------- --------------------------------
add-drop-database                         FALSE
add-drop-table                            FALSE
add-drop-user                             FALSE
add-locks                                 FALSE
all-databases                             FALSE
bind-address                              (No default value)
character-sets-dir                        (No default value)
column-statistics                         FALSE
complete-insert                           FALSE
compress                                  FALSE
compress-output                           (No default value)
compression-algorithms                    (No default value)
databases                                 FALSE
default-character-set                     UTF8MB4
default-parallelism                       2
default-auth                              (No default value)
defer-table-indexes                       TRUE
events                                    TRUE
exclude-databases                         (No default value)
exclude-events                            (No default value)
exclude-routines                          (No default value)
exclude-tables                            (No default value)
exclude-triggers                          (No default value)
exclude-users                             (No default value)
extended-insert                           250
get-server-public-key                     FALSE
hex-blob                                  FALSE
host                                      (No default value)
include-databases                         (No default value)
include-events                            (No default value)
include-routines                          (No default value)
include-tables                            (No default value)
include-triggers                          (No default value)
include-users                             (No default value)
insert-ignore                             FALSE
log-error-file                            (No default value)
max-allowed-packet                        25165824
net-buffer-length                         1047552
no-create-db                              FALSE
no-create-info                            FALSE
parallel-schemas                          (No default value)
password                                  (No default value)
password1                                 (No default value)
password2                                 (No default value)
password3                                 (No default value)
plugin-dir                                (No default value)
port                                      0
protocol                                  (No default value)
replace                                   FALSE
result-file                               (No default value)
routines                                  TRUE
server-public-key-path                    (No default value)
set-charset                               TRUE
set-gtid-purged                           AUTO
single-transaction                        FALSE
skip-definer                              FALSE
skip-dump-rows                            FALSE
skip-generated-invisible-primary-key      FALSE
socket                                    (No default value)
ssl-ca                                    (No default value)
ssl-capath                                (No default value)
ssl-cert                                  (No default value)
ssl-cipher                                (No default value)
ssl-crl                                   (No default value)
ssl-crlpath                               (No default value)
ssl-fips-mode                             (No default value)
ssl-key                                   (No default value)
ssl-mode                                  (No default value)
ssl-session-data                          (No default value)
ssl-session-data-continue-on-failed-reuse FALSE
tls-ciphersuites                          (No default value)
tls-version                               (No default value)
triggers                                  TRUE
tz-utc                                    TRUE
user                                      (No default value)
users                                     FALSE
watch-progress                            TRUE
zstd-compression-level                    3
Options (83)
OptionDescriptionSource
--print-defaultsPrint the program argument list and exit.help
--no-defaultsDon't read default options from any option file, except for login file.help
--defaults-file #Only read default options from the given file #.help
--defaults-group-suffix #Also read groups with concat(group, suffix)help
--login-path #Read this path from the login file.help
-?, --helpDisplay this help message and exit.help
--add-drop-tableAdd a DROP TABLE before each CREATE TABLE.help
--add-drop-userAdd a DROP USER before each CREATE USER.help
--add-locks andWrap data inserts on table with write lock on that table in output.help + man
--character-sets-dir nameDirectory for character set files.help
--complete-insertUse complete insert statements, include column names.help
-C, --compressUse compression in server/client protocol.help
--compress-output nameCompresses all output files with LZ4 or ZLIB compression algorithm.help
--compression-algorithms nameUse compression algorithm in server/client protocol.help
-B, --databasesDump selected databases, specified in positional options.help
-#, --debug #This is a non-debug version.help
--debug-check #This is a non-debug version.help
--debug-info #This is a non-debug version.help
--default-character-set nameSet the default character set.help
--default-parallelism #Specifies number of threads to process each parallel queue for values N > 0.help
--defer-table-indexesDefer addition of indexes of table to be added after all rows are dumped.help
--eventsDump event scheduler events.help
--exclude-databases nameSpecifies comma-separated list of databases to exclude.help
--exclude-events nameSpecifies comma-separated list of events to exclude.help
--exclude-routines nameSpecifies comma-separated list of stored procedures or functions to exclude.help
--exclude-tables nameSpecifies comma-separated list of tables to exclude.help
--exclude-triggers nameSpecifies comma-separated list of triggers to exclude.help
--exclude-users nameSpecifies comma-separated list of users to exclude.help
--get-server-public-keyGet public key from serverhelp
--hex-blobDump binary strings (in fields of type BINARY, VARBINARY, BLOB, ...) in hexadecimal format.help
-h, --host nameConnect to host.help
--include-databases name•The --databases option causes mysqlpump to treat all name arguments as names of databases to dump.help + man
--include-events nameSpecifies comma-separated list of events to include.help
--include-routines nameSpecifies comma-separated list of stored procedures or functions to include.help
--include-tables nameSpecifies comma-separated list of tables to include.help
--include-triggers nameSpecifies comma-separated list of triggers to include.help
--include-users nameSpecifies comma-separated list of users to include.help
--insert-ignoreUse INSERT IGNORE INTO for dumped rows instead of INSERT INTO.help
--log-error-file nameAppend warnings and errors to specified file.help
--max-allowed-packet #The maximum packet length to send to or receive from server.help
--net-buffer-length #The buffer size for TCP/IP and socket communication.help
--no-create-dbSuppress CREATE DATABASE statements.help
-t, --no-create-infoSuppress CREATE TABLE statements.help
--parallel-schemas name[N:]<list of: schema_name separated with ','>.help
-p, --password namePassword to use when connecting to server.help
--password1 name•--password2[=pass_val] The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server.help + man
--password2 namePassword for second factor authentication plugin.help
--password3 namePassword for third factor authentication plugin.help
--plugin-dir nameDirectory for client-side plugins.help
-P, --port #Port number to use for connection.help
--protocol nameThe protocol to use for connection (tcp, socket, pipe, memory).help
--replaceUse REPLACE INTO for dumped rows instead of INSERT INTO.help
--result-file nameDirect all output generated for all objects to a given file.help
--routinesDump stored procedures and functions.help
--server-public-key-path namePath to file containing server public keyhelp
--set-charsetAdd 'SET NAMES default_character_set' to the output to keep charsets consistent.help
--set-gtid-purged nameAdd 'SET @@GLOBAL.GTID_PURGED' to the output.help
--single-transactionCreates a consistent snapshot by dumping all tables in a single transaction.help
--skip-definerSkip DEFINER and SQL SECURITY clauses for Views and Stored Routines.help
-d, --skip-dump-rowsSkip dumping rows of all tables to output.help
--skip-generated-invisible-primary-keyControls whether generated primary key and key column should be dumped or not.help
-S, --socket nameThe socket file to use for connection.help
--ssl-ca nameCA file in PEM format.help
--ssl-capath nameCA directory.help
--ssl-cert nameX509 cert in PEM format.help
--ssl-cipher nameSSL cipher to use.help
--ssl-crl nameCertificate revocation list.help
--ssl-crlpath nameCertificate revocation list path.help
--ssl-fips-mode nameSSL fips mode to use.help
--ssl-key nameX509 key in PEM format.help
--ssl-mode nameSSL connection mode.help
--ssl-session-data nameSession data file to use to enable ssl session reusehelp
--ssl-session-data-continue-on-failed-reuseIf set to ON, this option will allow connection to succeed even if session data cannot be reused.help
--tls-ciphersuites nameTLS v1.3 cipher to use.help
--tls-version nameTLS version to use.help
--triggersDump triggers.help
--tz-utcSET TIME_ZONE='+00:00' at top of dump to allow dumping of TIMESTAMP data when a server has data in different time zones or data is being moved between servers with different time zones.help
-u, --user nameUser for login if not current user.help
--usersDump users with their privileges in GRANT format.help
-V, --versionOutput version information and exit.help
--watch-progressShows periodically dump process progress information on error output.help
--zstd-compression-level #Use this compression level in the client/server protocol, in case --compression-algorithms=zstd.help
--all-databases andNote See the --add-drop-database description for information about an incompatibility of that option with --all-databases. (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.