mysqldump options in 10.3 CS¶

Option

Description

--add-drop-database

Add a DROP DATABASE before each create.

--add-drop-table

Add a DROP TABLE before each create. (Defaults to on; use --skip-add-drop-table to disable.)

--add-drop-trigger

Add a DROP TRIGGER before each create.

--add-locks

Add locks around INSERT statements. (Defaults to on; use --skip-add-locks to disable.)

--all-databases (-A)

Dump all the databases. This will be same as --databases with all databases selected.

--all-tablespaces (-Y)

Dump all the tablespaces.

--allow-keywords

Allow creation of column names that are keywords.

--apply-slave-statements

Adds 'STOP SLAVE' prior to 'CHANGE MASTER' and 'START SLAVE' to bottom of dump.

--character-sets-dir

Directory for character set files.

--comments (-i)

Write additional information. (Defaults to on; use --skip-comments to disable.)

--compact

Give less verbose output (useful for debugging). Disables structure comments and header/footer constructs. Enables options --skip-add-drop-table --skip-add-locks --skip-comments --skip-disable-keys --skip-set-charset.

--compatible

Change the dump to be compatible with a given mode. By default tables are dumped in a format optimized for MySQL. Legal modes are: ansi, mysql323, mysql40, postgresql, oracle, mssql, db2, maxdb, no_key_options, no_table_options, no_field_options. One can use several modes separated by commas. Note: Requires MySQL server version 4.1.0 or higher. This option is ignored with earlier server versions.

--complete-insert (-c)

Use complete insert statements.

--compress (-C)

Use compression in server/client protocol.

--create-options (-a)

Include all MySQL specific create options. (Defaults to on; use --skip-create-options to disable.)

--databases (-B)

Dump several databases. Note the difference in usage; in this case no tables are given. All name arguments are regarded as database names. 'USE db_name;' will be included in the output.

--debug (-#)

This is a non-debug version. Catch this and exit.

--debug-check

Check memory and open file usage at exit.

--debug-info

Print some debug info at exit.

--default-auth

Default authentication client-side plugin to use.

--default-character-set

Set the default character set.

--defaults-extra-file

Read this file after the global files are read.

--defaults-file

Only read default options from the given file #.

--defaults-group-suffix

Additionally read default groups with # appended as a suffix.

--delayed-insert

Insert rows with INSERT DELAYED.

--delete-master-logs

Delete logs on master after backup. This automatically enables --master-data.

--disable-keys (-K)

'/*!40000 ALTER TABLE tb_name DISABLE KEYS */; and '/*!40000 ALTER TABLE tb_name ENABLE KEYS */; will be put in the output. (Defaults to on; use --skip-disable-keys to disable.)

--dump-date

Put a dump date to the end of the output. (Defaults to on; use --skip-dump-date to disable.)

--dump-slave

This causes the binary log position and filename of the master to be appended to the dumped data output. Setting the value to 1, will printit as a CHANGE MASTER command in the dumped data output; if equal to 2, that command will be prefixed with a comment symbol. This option will turn --lock-all-tables on, unless --single-transaction is specified too (in which case a global read lock is only taken a short time at the beginning of the dump - don't forget to read about --single-transaction below). In all cases any action on logs will happen at the exact moment of the dump.Option automatically turns --lock-tables off.

--events (-E)

Dump events.

--extended-insert (-e)

Use multiple-row INSERT syntax that include several VALUES lists. (Defaults to on; use --skip-extended-insert to disable.)

--fields-enclosed-by

Fields in the output file are enclosed by the given character.

--fields-escaped-by

Fields in the output file are escaped by the given character.

--fields-optionally-enclosed-by

Fields in the output file are optionally enclosed by the given character.

--fields-terminated-by

Fields in the output file are terminated by the given string.

--flush-logs (-F)

Flush logs file in server before starting dump. Note that if you dump many databases at once (using the option --databases= or --all-databases), the logs will be flushed for each database dumped. The exception is when using --lock-all-tables or --master-data: in this case the logs will be flushed only once, corresponding to the moment all tables are locked. So if you want your dump and the log flush to happen at the same exact moment you should use --lock-all-tables or --master-data with --flush-logs.

--flush-privileges

Emit a FLUSH PRIVILEGES statement after dumping the mysql database. This option should be used any time the dump contains the mysql database and any other database that depends on the data in the mysql database for proper restore.

--force (-f)

Continue even if we get an SQL error.

--gtid

Used together with --master-data=1 or --dump-slave=1.When enabled, the output from those options will set the GTID position instead of the binlog file and offset; the file/offset will appear only as a comment. When disabled, the GTID position will still appear in the output, but only commented.

--help (-?)

Display this help message and exit.

--hex-blob

Dump binary strings (BINARY, VARBINARY, BLOB) in hexadecimal format.

--host (-h)

Connect to host.

--ignore-database

Do not dump the specified database. To specify more than one database to ignore, use the directive multiple times, once for each database. Only takes effect when used together with --all-databases|-A

--ignore-table

Do not dump the specified table. To specify more than one table to ignore, use the directive multiple times, once for each table. Each table must be specified with both database and table names, e.g., --ignore-table=database.table.

--ignore-table-data

Do not dump the specified table data. To specify more than one table to ignore, use the directive multiple times, once for each table. Each table must be specified with both database and table names, e.g., --ignore-table-data=database.table.

--include-master-host-port

Adds 'MASTER_HOST=<host>, MASTER_PORT=<port>' to 'CHANGE MASTER TO..' in dump produced with --dump-slave.

--insert-ignore

Insert rows with INSERT IGNORE.

--lines-terminated-by

Lines in the output file are terminated by the given string.

--lock-all-tables (-x)

Locks all tables across all databases. This is achieved by taking a global read lock for the duration of the whole dump. Automatically turns --single-transaction and --lock-tables off.

--lock-tables (-l)

Lock all tables for read. (Defaults to on; use --skip-lock-tables to disable.)

--log-error

Append warnings and errors to given file.

--log-queries

When restoring the dump, the server will, if logging turned on, log the queries to the general and slow query log. (Defaults to on; use --skip-log-queries to disable.)

--master-data

This causes the binary log position and filename to be appended to the output. If equal to 1, will print it as a CHANGE MASTER command; if equal to 2, that command will be prefixed with a comment symbol. This option will turn --lock-all-tables on, unless --single-transaction is specified too (on servers before MariaDB 5.3 this will still take a global read lock for a short time at the beginning of the dump; don't forget to read about --single-transaction below). In all cases, any action on logs will happen at the exact moment of the dump. Option automatically turns --lock-tables off.

--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-autocommit

Wrap tables with autocommit/commit statements.

--no-create-db (-n)

Suppress the CREATE DATABASE ... IF EXISTS statement that normally is output for each dumped database if --all-databases or --databases is given.

--no-create-info (-t)

Don't write table creation info.

--no-data (-d)

No row information.

--no-data-med

No row information for engines that Manage External Data (MRG_MyISAM, MRG_ISAM, CONNECT, OQGRAPH, SPIDER, VP, FEDERATED). (Defaults to on; use --skip-no-data-med to disable.)

--no-defaults

Don't read default options from any option file.

--no-set-names (-N)

Same as --skip-set-charset.

--no-tablespaces (-y)

Do not dump any tablespace information.

--opt

Same as --add-drop-table, --add-locks, --create-options, --quick, --extended-insert, --lock-tables, --set-charset, and --disable-keys. Enabled by default, disable with --skip-opt.

--order-by-primary

Sorts each table's rows by primary key, or first unique key, if such a key exists. Useful when dumping a MyISAM table to be loaded into an InnoDB table, but will make the dump itself take considerably longer.

--password (-p)

Password to use when connecting to server. If password is not given it's solicited on the tty.

--plugin-dir

Directory for client-side plugins.

--port (-P)

Port number to use for connection.

--print-defaults

Print the program argument list and exit.

--protocol

The protocol to use for connection (tcp, socket, pipe, memory).

--quick (-q)

Don't buffer query, dump directly to stdout. (Defaults to on; use --skip-quick to disable.)

--quote-names (-Q)

Quote table and column names with backticks (`). (Defaults to on; use --skip-quote-names to disable.)

--replace

Use REPLACE INTO instead of INSERT INTO.

--result-file (-r)

Direct output to a given file. This option should be used in systems (e.g., DOS, Windows) that use carriage-return linefeed pairs (\r\n) to separate text lines. This option ensures that only a single newline is used.

--routines (-R)

Dump stored routines (functions and procedures).

--set-charset

Add 'SET NAMES default_character_set' to the output. (Defaults to on; use --skip-set-charset to disable.)

--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. Option automatically turns off --lock-tables.

--skip-opt

Disable --opt. Disables --add-drop-table, --add-locks, --create-options, --quick, --extended-insert, --lock-tables, --set-charset, and --disable-keys.

--socket (-S)

The socket file to use for connection.

--ssl

Enable SSL for connection (automatically enabled with other flags).

--ssl-ca

CA file in PEM format (check OpenSSL docs, implies --ssl).

--ssl-capath

CA directory (check OpenSSL docs, implies --ssl).

--ssl-cert

X509 cert in PEM format (implies --ssl).

--ssl-cipher

SSL cipher to use (implies --ssl).

--ssl-crl

Certificate revocation list (implies --ssl).

--ssl-crlpath

Certificate revocation list path (implies --ssl).

--ssl-key

X509 key in PEM format (implies --ssl).

--ssl-verify-server-cert

Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default.

--tab (-T)

Create tab-separated textfile for each table to given path. (Create .sql and .txt files.) NOTE: This only works if mysqldump is run on the same machine as the mysqld server.

--tables

Overrides option --databases (-B).

--triggers

Dump triggers for each dumped table. (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.)

--user (-u)

User for login if not current user.

--verbose (-v)

Print info about the various stages.

--version (-V)

Output version information and exit.

--where (-w)

Dump only selected records. Quotes are mandatory.

--xml (-X)

Dump a database as well formed XML.