Movatterモバイル変換

• Performance and Scalability Considerations

• Invocation Syntax

• Option Syntax - Alphabetical Summary

• Connection Options

• Option-File Options

• DDL Options

• Debug Options

• Help Options

• Internationalization Options

• Replication Options

• Format Options

• Filtering Options

• Performance Options

• Transactional Options

• Option Groups

• Examples

• Restrictions

A dump made using PowerShell on Windows with output redirection creates a file that has UTF-16 encoding:

mysqldump [options] > dump.sql

However, UTF-16 is not permitted as a connection character set (seeImpermissible Client Character Sets), so the dump file cannot be loaded correctly. To work around this issue, use the--result-file option, which creates the output in ASCII format:

mysqldump [options] --result-file=dump.sql

• If your tables are primarilyInnoDB tables, or if you have a mix ofInnoDB andMyISAM tables, consider using themysqlbackup command of the MySQL Enterprise Backup product. (Available as part of the Enterprise subscription.) It provides the best performance forInnoDB backups with minimal disruption; it can also back up tables fromMyISAM and other storage engines; and it provides a number of convenient options to accommodate different backup scenarios. SeeSection 28.1, “MySQL Enterprise Backup Overview”.

Table 4.16 mysqldump Options

• --bind-address=ip_address

  Command-Line Format	--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.

• --compress,-C

  Command-Line Format	--compress[={OFF|ON}]
  Type	Boolean
  Default Value	OFF

  Compress all information sent between the client and the server if possible. SeeSection 4.2.6, “Connection Compression Control”.

• --default-auth=plugin

  Command-Line Format	--default-auth=plugin
  Type	String

  A hint about which client-side authentication plugin to use. SeeSection 6.2.13, “Pluggable Authentication”.

• --enable-cleartext-plugin

  Command-Line Format	--enable-cleartext-plugin
  Introduced	5.7.10
  Type	Boolean
  Default Value	FALSE

  Enable themysql_clear_password cleartext authentication plugin. (SeeSection 6.4.1.6, “Client-Side Cleartext Pluggable Authentication”.)

  This option was added in MySQL 5.7.10.

• --get-server-public-key

  Command-Line Format	--get-server-public-key
  Introduced	5.7.23
  Type	Boolean

  Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with thecaching_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.

  If--server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over--get-server-public-key.

  For information about thecaching_sha2_password plugin, seeSection 6.4.1.4, “Caching SHA-2 Pluggable Authentication”.

  The--get-server-public-key option was added in MySQL 5.7.23.

• --host=host_name,-hhost_name

  Command-Line Format	--host

  Dump data from the MySQL server on the given host. The default host islocalhost.

• --login-path=name

  Command-Line Format	--login-path=name
  Type	String

  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 themysql_config_editor utility. SeeSection 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.

  For additional information about this and other option-file options, seeSection 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.

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

  Command-Line Format	--password[=password]
  Type	String

  The password of the MySQL account used for connecting to the server. The password value is optional. If not given,mysqldump prompts for one. If given, there must beno space between--password= or-p and the password following it. If no password option is specified, the default is to send no password.

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

  To explicitly specify that there is no password and thatmysqldump should not prompt for one, use the--skip-password option.

• --pipe,-W

  Command-Line Format	--pipe
  Type	String

  On Windows, connect to the server using a named pipe. This option applies only if the server was started with thenamed_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 thenamed_pipe_full_access_group system variable.

• --plugin-dir=dir_name

  Command-Line Format	--plugin-dir=dir_name
  Type	Directory name

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

• --port=port_num,-Pport_num

  Command-Line Format	--port=port_num
  Type	Numeric
  Default Value	3306

  For TCP/IP connections, the port number to use.

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

  Command-Line Format	--protocol=type
  Type	String
  Default Value	[see text]
  Valid Values	TCP SOCKET PIPE MEMORY

  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, seeSection 4.2.5, “Connection Transport Protocols”.

• --secure-auth

  Command-Line Format	--secure-auth
  Deprecated	Yes

  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.

  As of MySQL 5.7.5, this option is deprecated; expect it to 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. Before MySQL 5.7.5, this option is enabled by default but can be disabled.

  Note

  Passwords that use the pre-4.1 hashing method are less secure than passwords that use the native password hashing method and should be avoided. Pre-4.1 passwords are deprecated and support for them was removed in MySQL 5.7.5. For account upgrade instructions, seeSection 6.4.1.3, “Migrating Away from Pre-4.1 Password Hashing and the mysql_old_password Plugin”.

• --server-public-key-path=file_name

  Command-Line Format	--server-public-key-path=file_name
  Introduced	5.7.23
  Type	File name

  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 thesha256_password orcaching_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.

  If--server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over--get-server-public-key.

  Forsha256_password, this option applies only if MySQL was built using OpenSSL.

  For information about thesha256_password andcaching_sha2_password plugins, seeSection 6.4.1.5, “SHA-256 Pluggable Authentication”, andSection 6.4.1.4, “Caching SHA-2 Pluggable Authentication”.

  The--server-public-key-path option was added in MySQL 5.7.23.

• --skip-mysql-schema

  Command-Line Format	--skip-mysql-schema
  Introduced	5.7.36
  Type	Boolean

  Do not drop themysql schema when the dump file is restored. By default, the schema is dropped.

  This option was added in MySQL 5.7.36.

• --socket=path,-Spath

  Command-Line Format	--socket={file_name|pipe_name}
  Type	String

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

  On Windows, this option applies only if the server was started with thenamed_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 thenamed_pipe_full_access_group system variable.

• --ssl*

  Options that begin with--ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. SeeCommand Options for Encrypted Connections.

• --tls-version=protocol_list

  Command-Line Format	--tls-version=protocol_list
  Introduced	5.7.10
  Type	String
  Default Value (≥ 5.7.28)	TLSv1,TLSv1.1,TLSv1.2
  Default Value (≤ 5.7.27)	TLSv1,TLSv1.1,TLSv1.2 (OpenSSL) TLSv1,TLSv1.1 (yaSSL)

  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, seeSection 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

  This option was added in MySQL 5.7.10.

• --user=user_name,-uuser_name

  Command-Line Format	--user=user_name
  Type	String

  The user name of the MySQL account to use for connecting to the server.

• --defaults-extra-file=file_name

  Command-Line Format	--defaults-extra-file=file_name
  Type	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. Iffile_name is not an absolute path name, it is interpreted relative to the current directory.

  For additional information about this and other option-file options, seeSection 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --defaults-file=file_name

  Command-Line Format	--defaults-file=file_name
  Type	File name

  Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. Iffile_name is not an absolute path name, it is interpreted relative to the current directory.

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

  For additional information about this and other option-file options, seeSection 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --defaults-group-suffix=str

  Command-Line Format	--defaults-group-suffix=str
  Type	String

  Read not only the usual option groups, but also groups with the usual names and a suffix ofstr. For example,mysqldump normally reads the[client] and[mysqldump] groups. If this option is given as--defaults-group-suffix=_other,mysqldump also reads the[client_other] and[mysqldump_other] groups.

  For additional information about this and other option-file options, seeSection 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --no-defaults

  Command-Line Format	--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 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--no-defaults is used. To create.mylogin.cnf, use themysql_config_editor utility. SeeSection 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.

  For additional information about this and other option-file options, seeSection 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --print-defaults

  Command-Line Format	--print-defaults

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

  For additional information about this and other option-file options, seeSection 4.2.2.3, “Command-Line Options that Affect Option-File Handling”.

• --add-drop-database

  Command-Line Format	--add-drop-database

  Write aDROP DATABASE statement before eachCREATE DATABASE statement. This option is typically used in conjunction with the--all-databases or--databases option because noCREATE DATABASE statements are written unless one of those options is specified.

• --add-drop-table

  Command-Line Format	--add-drop-table

  Write aDROP TABLE statement before eachCREATE TABLE statement.

• --add-drop-trigger

  Command-Line Format	--add-drop-trigger

  Write aDROP TRIGGER statement before eachCREATE TRIGGER statement.

• --all-tablespaces,-Y

  Command-Line Format	--all-tablespaces

  Adds to a table dump all SQL statements needed to create any tablespaces used by anNDB table. This information is not otherwise included in the output frommysqldump. This option is currently relevant only to NDB Cluster tables, which are not supported in MySQL 5.7.

• --no-create-db,-n

  Command-Line Format	--no-create-db

  Suppress theCREATE DATABASE statements that are otherwise included in the output if the--databases or--all-databases option is given.

• --no-create-info,-t

  Command-Line Format	--no-create-info

  Do not writeCREATE TABLE statements that create each dumped table.

  Note

  This option doesnot exclude statements creating log file groups or tablespaces frommysqldump output; however, you can use the--no-tablespaces option for this purpose.

• --no-tablespaces,-y

  Command-Line Format	--no-tablespaces

  This option suppresses allCREATE LOGFILE GROUP andCREATE TABLESPACE statements in the output ofmysqldump.

• --replace

  Command-Line Format	--replace

  WriteREPLACE statements rather thanINSERT statements.

• --allow-keywords

  Command-Line Format	--allow-keywords

  Permit creation of column names that are keywords. This works by prefixing each column name with the table name.

• --comments,-i

  Command-Line Format	--comments

  Write additional information in the dump file such as program version, server version, and host. This option is enabled by default. To suppress this additional information, use--skip-comments.

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

  Command-Line Format	--debug[=debug_options]
  Type	String
  Default Value	d:t:o,/tmp/mysqldump.trace

  Write a debugging log. A typicaldebug_options string isd:t:o,file_name. The default value isd:t:o,/tmp/mysqldump.trace.

  This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

• --debug-check

  Command-Line Format	--debug-check
  Type	Boolean
  Default Value	FALSE

  Print some debugging information when the program exits.

  This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

• --debug-info

  Command-Line Format	--debug-info
  Type	Boolean
  Default Value	FALSE

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

  This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

• --dump-date

  Command-Line Format	--dump-date
  Type	Boolean
  Default Value	TRUE

  If the--comments option is given,mysqldump produces a comment at the end of the dump of the following form:

  -- Dump completed onDATE

  However, the date causes dump files taken at different times to appear to be different, even if the data are otherwise identical.--dump-date and--skip-dump-date control whether the date is added to the comment. The default is--dump-date (include the date in the comment).--skip-dump-date suppresses date printing.

• --force,-f

  Command-Line Format	--force

  Ignore all errors; continue even if an SQL error occurs during a table dump.

  One use for this option is to causemysqldump to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped. Without--force,mysqldump exits with an error message. With--force,mysqldump prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing.

  If the--ignore-error option is also given to ignore specific errors,--force takes precedence.

• --log-error=file_name

  Command-Line Format	--log-error=file_name
  Type	File name

  Log warnings and errors by appending them to the named file. The default is to do no logging.

• --skip-comments

  Command-Line Format	--skip-comments

  See the description for the--comments option.

• --verbose,-v

  Command-Line Format	--verbose

  Verbose mode. Print more information about what the program does.

• --help,-?

  Command-Line Format	--help

  Display a help message and exit.

• --version,-V

  Command-Line Format	--version

  Display version information and exit.

• --character-sets-dir=dir_name

  Command-Line Format	--character-sets-dir=dir_name
  Type	Directory name

  The directory where character sets are installed. SeeSection 10.15, “Character Set Configuration”.

• --default-character-set=charset_name

  Command-Line Format	--default-character-set=charset_name
  Type	String
  Default Value	utf8

  Usecharset_name as the default character set. SeeSection 10.15, “Character Set Configuration”. If no character set is specified,mysqldump usesutf8.

• --no-set-names,-N

  Command-Line Format	--no-set-names
  Deprecated	Yes

  Turns off the--set-charset setting, the same as specifying--skip-set-charset.

• --set-charset

  Command-Line Format	--set-charset
  Disabled by	skip-set-charset

  WriteSET NAMESdefault_character_set to the output. This option is enabled by default. To suppress theSET NAMES statement, use--skip-set-charset.

• --apply-slave-statements

  Command-Line Format	--apply-slave-statements
  Type	Boolean
  Default Value	FALSE

  For a replica dump produced with the--dump-slave option, add aSTOP SLAVE statement before theCHANGE MASTER TO statement and aSTART SLAVE statement at the end of the output.

• --delete-master-logs

  Command-Line Format	--delete-master-logs

  On a source replication server, delete the binary logs by sending aPURGE BINARY LOGS statement to the server after performing the dump operation. This option requires theRELOAD privilege as well as privileges sufficient to execute that statement. This option automatically enables--master-data.

• --dump-slave[=value]

  Command-Line Format	--dump-slave[=value]
  Type	Numeric
  Default Value	1
  Valid Values	1 2

  This option is similar to--master-data except that it is used to dump a replication replica server to produce a dump file that can be used to set up another server as a replica that has the same source as the dumped server. It causes the dump output to include aCHANGE MASTER TO statement that indicates the binary log coordinates (file name and position) of the dumped replica's source. TheCHANGE MASTER TO statement reads the values ofRelay_Master_Log_File andExec_Master_Log_Pos from theSHOW SLAVE STATUS output and uses them forMASTER_LOG_FILE andMASTER_LOG_POS respectively. These are the source server coordinates from which the replica should start replicating.

  Note

  Inconsistencies in the sequence of transactions from the relay log which have been executed can cause the wrong position to be used. SeeSection 16.4.1.32, “Replication and Transaction Inconsistencies” for more information.

  --dump-slave causes the coordinates from the source to be used rather than those of the dumped server, as is done by the--master-data option. In addition, specifiying this option causes the--master-data option to be overridden, if used, and effectively ignored.

  Warning

  This option should not be used if the server where the dump is going to be applied usesgtid_mode=ON andMASTER_AUTOPOSITION=1.

  The option value is handled the same way as for--master-data (setting no value or 1 causes aCHANGE MASTER TO statement to be written to the dump, setting 2 causes the statement to be written but encased in SQL comments) and has the same effect as--master-data in terms of enabling or disabling other options and in how locking is handled.

  This option causesmysqldump to stop the replica SQL thread before the dump and restart it again after.

  --dump-slave sends aSHOW SLAVE STATUS statement to the server to obtain information, so it requires privileges sufficient to execute that statement.

  In conjunction with--dump-slave, the--apply-slave-statements and--include-master-host-port options can also be used.

• --include-master-host-port

  Command-Line Format	--include-master-host-port
  Type	Boolean
  Default Value	FALSE

  For theCHANGE MASTER TO statement in a replica dump produced with the--dump-slave option, addMASTER_HOST andMASTER_PORT options for the host name and TCP/IP port number of the replica's source.

• --master-data[=value]

  Command-Line Format	--master-data[=value]
  Type	Numeric
  Default Value	1
  Valid Values	1 2

  Use this option to dump a source replication server to produce a dump file that can be used to set up another server as a replica of the source. It causes the dump output to include aCHANGE MASTER TO statement that indicates the binary log coordinates (file name and position) of the dumped server. These are the source server coordinates from which the replica should start replicating after you load the dump file into the replica.

  If the option value is 2, theCHANGE MASTER TO statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded. If the option value is 1, the statement is not written as a comment and takes effect when the dump file is reloaded. If no option value is specified, the default value is 1.

  --master-data sends aSHOW MASTER STATUS statement to the server to obtain information, so it requires privileges sufficient to execute that statement. This option also requires theRELOAD privilege and the binary log must be enabled.

  The--master-data option automatically turns off--lock-tables. It also turns on--lock-all-tables, unless--single-transaction also is specified, in which case, a global read lock is acquired only for a short time at the beginning of the dump (see the description for--single-transaction). In all cases, any action on logs happens at the exact moment of the dump.

  It is also possible to set up a replica by dumping an existing replica of the source, using the--dump-slave option, which overrides--master-data and causes it to be ignored if both options are used.

• --set-gtid-purged=value

  Command-Line Format	--set-gtid-purged=value
  Type	Enumeration
  Default Value	AUTO
  Valid Values	OFF ON AUTO

  This option enables control over global transaction ID (GTID) information written to the dump file, by indicating whether to add aSET @@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 isAUTO.

  Value	Meaning
  OFF	Add noSET statement to the output.
  ON	Add aSET statement to the output. An error occurs if GTIDs are not enabled on the server.
  AUTO	Add aSET statement to the output if GTIDs are enabled on the server.

  A partial dump from a server that is using GTID-based replication requires the--set-gtid-purged={ON|OFF} option to be specified. UseON if the intention is to deploy a new replication replica using only some of the data from the dumped server. UseOFF if the intention is to repair a table by copying it within a topology. UseOFF if the intention is to copy a table between replication topologies that are disjoint and for them to remain so.

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

  • --set-gtid-purged=OFF:SET @@SESSION.SQL_LOG_BIN=0; is not added to the output.

  • --set-gtid-purged=ON:SET @@SESSION.SQL_LOG_BIN=0; is added to the output.

  • --set-gtid-purged=AUTO:SET @@SESSION.SQL_LOG_BIN=0; is added to the output if GTIDs are enabled on the server you are backing up (that is, ifAUTO evaluates toON).

  Using this option with the--single-transaction option can lead to inconsistencies in the output. If--set-gtid-purged=ON is required, it can be used with--lock-all-tables, but this can prevent parallel queries whilemysqldump is being run.

  It is not recommended to load a dump file when GTIDs are enabled on the server (gtid_mode=ON), if your dump file includes system tables.mysqldump issues DML instructions for the system tables which use the non-transactional MyISAM storage engine, and this combination is not permitted when GTIDs are enabled. Also be aware that loading a dump file from a server with GTIDs enabled, into another server with GTIDs enabled, causes different transaction identifiers to be generated.

• --compact

  Command-Line Format	--compact

  Produce more compact output. This option enables the--skip-add-drop-table,--skip-add-locks,--skip-comments,--skip-disable-keys, and--skip-set-charset options.

• --compatible=name

  Command-Line Format	--compatible=name[,name,...]
  Type	String
  Default Value	''
  Valid Values	ansi

  Produce output that is more compatible with other database systems or with older MySQL servers. The value ofname can beansi,mysql323,mysql40,postgresql,oracle,mssql,db2,maxdb,no_key_options,no_table_options, orno_field_options. To use several values, separate them by commas. These values have the same meaning as the corresponding options for setting the server SQL mode. SeeSection 5.1.10, “Server SQL Modes”.

  This option does not guarantee compatibility with other servers. It only enables those SQL mode values that are currently available for making dump output more compatible. For example,--compatible=oracle does not map data types to Oracle types or use Oracle comment syntax.

• --complete-insert,-c

  Command-Line Format	--complete-insert

  Use completeINSERT statements that include column names.

• --create-options

  Command-Line Format	--create-options

  Include all MySQL-specific table options in theCREATE TABLE statements.

• --fields-terminated-by=...,--fields-enclosed-by=...,--fields-optionally-enclosed-by=...,--fields-escaped-by=...

  Command-Line Format	--fields-terminated-by=string
  Type	String

  Command-Line Format	--fields-enclosed-by=string
  Type	String

  Command-Line Format	--fields-optionally-enclosed-by=string
  Type	String

  Command-Line Format	--fields-escaped-by
  Type	String

  These options are used with the--tab option and have the same meaning as the correspondingFIELDS clauses forLOAD DATA. SeeSection 13.2.6, “LOAD DATA Statement”.

• --hex-blob

  Command-Line Format	--hex-blob

  Dump binary columns using hexadecimal notation (for example,'abc' becomes0x616263). The affected data types areBINARY,VARBINARY,BLOB types,BIT, all spatial data types, and other non-binary data types when used with thebinary character set.

  The--hex-blob option is ignored when the--tab is used.

• --lines-terminated-by=...

  Command-Line Format	--lines-terminated-by=string
  Type	String

  This option is used with the--tab option and has the same meaning as the correspondingLINES clause forLOAD DATA. SeeSection 13.2.6, “LOAD DATA Statement”.

• --quote-names,-Q

  Command-Line Format	--quote-names
  Disabled by	skip-quote-names

  Quote identifiers (such as database, table, and column names) within` characters. If theANSI_QUOTES SQL mode is enabled, identifiers are quoted within" characters. This option is enabled by default. It can be disabled with--skip-quote-names, but this option should be given after any option such as--compatible that may enable--quote-names.

• --result-file=file_name,-rfile_name

  Command-Line Format	--result-file=file_name
  Type	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.

• --tab=dir_name,-Tdir_name

  Command-Line Format	--tab=dir_name
  Type	Directory name

  Produce tab-separated text-format data files. For each dumped table,mysqldump creates atbl_name.sql file that contains theCREATE TABLE statement that creates the table, and the server writes atbl_name.txt file that contains its data. The option value is the directory in which to write the files.

  Note

  This option should be used only whenmysqldump is run on the same machine as themysqld server. Because the server creates*.txt files in the directory that you specify, the directory must be writable by the server and the MySQL account that you use must have theFILE privilege. Becausemysqldump creates*.sql in the same directory, it must be writable by your system login account.

  By default, the.txt data files are formatted using tab characters between column values and a newline at the end of each line. The format can be specified explicitly using the--fields-xxx and--lines-terminated-by options.

  Column values are converted to the character set specified by the--default-character-set option.

• --tz-utc

  Command-Line Format	--tz-utc
  Disabled by	skip-tz-utc

  This option enablesTIMESTAMP columns to be dumped and reloaded between servers in different time zones.mysqldump sets its connection time zone to UTC and addsSET 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.--tz-utc is enabled by default. To disable it, use--skip-tz-utc.

• --xml,-X

  Command-Line Format	--xml

  Write dump output as well-formed XML.

  NULL,'NULL', and Empty Values: For a column namedcolumn_name, theNULL value, an empty string, and the string value'NULL' are distinguished from one another in the output generated by this option as follows.

  Value:	XML Representation:
  NULL (unknown value)	<field name="column_name" xsi:nil="true" />
  '' (empty string)	<field name="column_name"></field>
  'NULL' (string value)	<field name="column_name">NULL</field>

  The output from themysql client when run using the--xml option also follows the preceding rules. (SeeSection 4.5.1.1, “mysql Client Options”.)

  XML output frommysqldump includes the XML namespace, as shown here:

  $> mysqldump --xml -u root world City<?xml version="1.0"?><mysqldump xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><database name="world"><table_structure name="City"><field Field="ID" Type="int(11)" Null="NO" Key="PRI" Extra="auto_increment" /><field Field="Name" Type="char(35)" Null="NO" Key="" Default="" Extra="" /><field Field="CountryCode" Type="char(3)" Null="NO" Key="" Default="" Extra="" /><field Field="District" Type="char(20)" Null="NO" Key="" Default="" Extra="" /><field Field="Population" Type="int(11)" Null="NO" Key="" Default="0" Extra="" /><key Table="City" Non_unique="0" Key_name="PRIMARY" Seq_in_index="1" Column_name="ID"Collation="A" Cardinality="4079" Null="" Index_type="BTREE" Comment="" /><options Name="City" Engine="MyISAM" Version="10" Row_format="Fixed" Rows="4079"Avg_row_length="67" Data_length="273293" Max_data_length="18858823439613951"Index_length="43008" Data_free="0" Auto_increment="4080"Create_time="2007-03-31 01:47:01" Update_time="2007-03-31 01:47:02"Collation="latin1_swedish_ci" Create_options="" Comment="" /></table_structure><table_data name="City"><row><field name="ID">1</field><field name="Name">Kabul</field><field name="CountryCode">AFG</field><field name="District">Kabol</field><field name="Population">1780000</field></row>...<row><field name="ID">4079</field><field name="Name">Rafah</field><field name="CountryCode">PSE</field><field name="District">Rafah</field><field name="Population">92020</field></row></table_data></database></mysqldump>

• --all-databases,-A

  Command-Line Format	--all-databases

  Dump all tables in all databases. This is the same as using the--databases option and naming all the databases on the command line.

• --databases,-B

  Command-Line Format	--databases

  Dump several databases. Normally,mysqldump treats the first name argument on the command line as a database name and following names as table names. With this option, it treats all name arguments as database names.CREATE DATABASE andUSE statements are included in the output before each new database.

  This option may be used to dump theINFORMATION_SCHEMA andperformance_schema databases, which normally are not dumped even with the--all-databases option. (Also use the--skip-lock-tables option.)

• --events,-E

  Command-Line Format	--events

  Include Event Scheduler events for the dumped databases in the output. This option requires theEVENT privileges for those databases.

  The output generated by using--events containsCREATE 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 themysql.event table directly, using a MySQL account that has appropriate privileges for themysql database.

• --ignore-error=error[,error]...

  Command-Line Format	--ignore-error=error[,error]...
  Type	String

  Ignore the specified errors. The option value is a list of comma-separated error numbers specifying the errors to ignore duringmysqldump execution. If the--force option is also given to ignore all errors,--force takes precedence.

• --ignore-table=db_name.tbl_name

  Command-Line Format	--ignore-table=db_name.tbl_name
  Type	String

  Do not dump the given table, which must be specified using both the database and table names. To ignore multiple tables, use this option multiple times. This option also can be used to ignore views.

• --no-data,-d

  Command-Line Format	--no-data

  Do not write any table row information (that is, do not dump table contents). This is useful if you want to dump only theCREATE TABLE statement for the table (for example, to create an empty copy of the table by loading the dump file).

• --routines,-R

  Command-Line Format	--routines

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

  The output generated by using--routines containsCREATE PROCEDURE andCREATE 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 themysql.proc table directly, using a MySQL account that has appropriate privileges for themysql database.

• --tables

  Command-Line Format	--tables

  Override the--databases or-B option.mysqldump regards all name arguments following the option as table names.

• --triggers

  Command-Line Format	--triggers
  Disabled by	skip-triggers

  Include triggers for each dumped table in the output. This option is enabled by default; disable it with--skip-triggers.

  To be able to dump a table's triggers, you must have theTRIGGER privilege for the table.

  Multiple triggers are permitted.mysqldump dumps triggers in activation order so that when the dump file is reloaded, triggers are created in the same activation order. However, if amysqldump dump file contains multiple triggers for a table that have the same trigger event and action time, an error occurs for attempts to load the dump file into an older server that does not support multiple triggers. (For a workaround, seeSection 2.11.3, “Downgrade Notes”; you can convert triggers to be compatible with older servers.)

• --where='where_condition',-w 'where_condition'

  Command-Line Format	--where='where_condition'

  Dump only rows selected by the givenWHERE condition. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter.

  Examples:

  --where="user='jimf'"-w"userid>1"-w"userid<1"

• --disable-keys,-K

  Command-Line Format	--disable-keys

  For each table, surround theINSERT statements with/*!40000 ALTER TABLEtbl_name DISABLE KEYS */; and/*!40000 ALTER TABLEtbl_name ENABLE KEYS */; statements. This makes loading the dump file faster because the indexes are created after all rows are inserted. This option is effective only for nonunique indexes ofMyISAM tables.

• --extended-insert,-e

  Command-Line Format	--extended-insert
  Disabled by	skip-extended-insert

  WriteINSERT statements using multiple-row syntax that includes severalVALUES lists. This results in a smaller dump file and speeds up inserts when the file is reloaded.

• --insert-ignore

  Command-Line Format	--insert-ignore

  WriteINSERT IGNORE statements rather thanINSERT statements.

• --max-allowed-packet=value

  Command-Line Format	--max-allowed-packet=value
  Type	Numeric
  Default Value	25165824

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

  Note

  The value of this option is specific tomysqldump and should not be confused with the MySQL server'smax_allowed_packet system variable; the server value cannot be exceeded by a single packet frommysqldump, regardless of any setting for themysqldump option, even if the latter is larger.

• --net-buffer-length=value

  Command-Line Format	--net-buffer-length=value
  Type	Numeric
  Default Value	16384

  The initial size of the buffer for client/server communication. When creating multiple-rowINSERT statements (as with the--extended-insert or--opt option),mysqldump creates rows up to--net-buffer-length bytes long. If you increase this variable, ensure that the MySQL servernet_buffer_length system variable has a value at least this large.

• --opt

  Command-Line Format	--opt
  Disabled by	skip-opt

  This option, enabled by default, is shorthand for the combination of--add-drop-table--add-locks--create-options--disable-keys--extended-insert--lock-tables--quick--set-charset. It gives a fast dump operation and produces a dump file that can be reloaded into a MySQL server quickly.

  Because the--opt option is enabled by default, you only specify its converse, the--skip-opt to turn off several default settings. See the discussion ofmysqldump option groups for information about selectively enabling or disabling a subset of the options affected by--opt.

• --quick,-q

  Command-Line Format	--quick
  Disabled by	skip-quick

  This option is useful for dumping large tables. It forcesmysqldump to retrieve rows for a table from the server a row at a time rather than retrieving the entire row set and buffering it in memory before writing it out.

• --skip-opt

  Command-Line Format	--skip-opt

  See the description for the--opt option.

• --add-locks

  Command-Line Format	--add-locks

  Surround each table dump withLOCK TABLES andUNLOCK TABLES statements. This results in faster inserts when the dump file is reloaded. SeeSection 8.2.4.1, “Optimizing INSERT Statements”.

• --flush-logs,-F

  Command-Line Format	--flush-logs

  Flush the MySQL server log files before starting the dump. This option requires theRELOAD privilege. If you use this option in combination with the--all-databases option, the logs are flushedfor each database dumped. The exception is when using--lock-all-tables,--master-data, or--single-transaction: In this case, the logs are flushed only once, corresponding to the moment that all tables are locked byFLUSH TABLES WITH READ LOCK. If you want your dump and the log flush to happen at exactly the same moment, you should use--flush-logs together with--lock-all-tables,--master-data, or--single-transaction.

• --flush-privileges

  Command-Line Format	--flush-privileges

  Add aFLUSH PRIVILEGES statement to the dump output after dumping themysql database. This option should be used any time the dump contains themysql database and any other database that depends on the data in themysql database for proper restoration.

  Because the dump file contains aFLUSH PRIVILEGES statement, reloading the file requires privileges sufficient to execute that statement.

  Note

  For upgrades to MySQL 5.7 or higher from older versions, do not use--flush-privileges. For upgrade instructions in this case, seeSection 2.10.3, “Changes in MySQL 5.7”.

• --lock-all-tables,-x

  Command-Line Format	--lock-all-tables

  Lock all tables across all databases. This is achieved by acquiring a global read lock for the duration of the whole dump. This option automatically turns off--single-transaction and--lock-tables.

• --lock-tables,-l

  Command-Line Format	--lock-tables

  For each dumped database, lock all tables to be dumped before dumping them. The tables are locked withREAD LOCAL to permit concurrent inserts in the case ofMyISAM tables. For transactional tables such asInnoDB,--single-transaction is a much better option than--lock-tables because it does not need to lock the tables at all.

  Because--lock-tables locks tables for each database separately, this option does not guarantee that the tables in the dump file are logically consistent between databases. Tables in different databases may be dumped in completely different states.

  Some options, such as--opt, automatically enable--lock-tables. If you want to override this, use--skip-lock-tables at the end of the option list.

• --no-autocommit

  Command-Line Format	--no-autocommit

  Enclose theINSERT statements for each dumped table withinSET autocommit = 0 andCOMMIT statements.

• --order-by-primary

  Command-Line Format	--order-by-primary

  Dump each table's rows sorted by its primary key, or by its first unique index, if such an index exists. This is useful when dumping aMyISAM table to be loaded into anInnoDB table, but makes the dump operation take considerably longer.

• --shared-memory-base-name=name

  Command-Line Format	--shared-memory-base-name=name
  Platform Specific	Windows

  On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value isMYSQL. The shared-memory name is case-sensitive.

  This option applies only if the server was started with theshared_memory system variable enabled to support shared-memory connections.

• --single-transaction

  Command-Line Format	--single-transaction

  This option sets the transaction isolation mode toREPEATABLE READ and sends aSTART TRANSACTION SQL statement to the server before dumping data. It is useful only with transactional tables such asInnoDB, because then it dumps the consistent state of the database at the time whenSTART TRANSACTION was issued without blocking any applications.

  The RELOAD or FLUSH_TABLES privilege is required with--single-transaction if both gtid_mode=ON and --set-gtid=purged=ON|AUTO. This requirement was added in MySQL 8.0.32.

  When using this option, you should keep in mind that onlyInnoDB tables are dumped in a consistent state. For example, anyMyISAM orMEMORY 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 theSELECT that is performed bymysqldump to retrieve the table contents to obtain incorrect contents or fail.

  The--single-transaction option and the--lock-tables option are mutually exclusive becauseLOCK TABLES causes any pending transactions to be committed implicitly.

  Using--single-transaction together with the--set-gtid-purged option is not recommended; doing so can lead to inconsistencies in the output ofmysqldump.

  To dump large tables, combine the--single-transaction option with the--quick option.

• The--opt option turns on several settings that work together to perform a fast dump operation. All of these settings are on by default, because--opt is on by default. Thus you rarely if ever specify--opt. Instead, you can turn these settings off as a group by specifying--skip-opt, then optionally re-enable certain settings by specifying the associated options later on the command line.

• The--compact option turns off several settings that control whether optional statements and comments appear in the output. Again, you can follow this option with other options that re-enable certain settings, or turn all the settings on by using the--skip-compact form.

• To select the effect of--opt except for some features, use the--skip option for each feature. To disable extended inserts and memory buffering, use--opt--skip-extended-insert--skip-quick. (Actually,--skip-extended-insert--skip-quick is sufficient because--opt is on by default.)

• To reverse--opt for all features except index disabling and table locking, use--skip-opt--disable-keys--lock-tables.