文档主页
MySQL 8.4 参考手册
相关文档 下载本手册
PDF (US Ltr) - 39.9Mb
PDF (A4) - 40.0Mb
手册页 (TGZ) - 258.5Kb
手册页 (Zip) - 365.5Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


MySQL 8.4 参考手册  /  ...  /  mysqldump — 数据库备份程序

6.5.4 mysqldump — 数据库备份程序

mysqldump 客户端实用程序执行 逻辑备份,生成一组可以执行以复制原始数据库对象定义和表数据的 SQL 语句。它转储一个或多个 MySQL 数据库以进行备份或传输到另一个 SQL 服务器。 mysqldump 命令还可以以 CSV、其他分隔文本或 XML 格式生成输出。

提示

考虑使用 MySQL Shell 转储工具,它提供使用多个线程的并行转储、文件压缩和进度信息显示,以及云功能,例如 Oracle Cloud Infrastructure Object Storage 流式传输,以及 MySQL HeatWave 服务兼容性检查和修改。使用 MySQL Shell 加载转储工具 可以轻松地将转储导入 MySQL Server 实例或 MySQL HeatWave 服务数据库系统。MySQL Shell 的安装说明可以 在这里 找到。

mysqldump 至少需要转储表的 SELECT 权限,转储视图的 SHOW VIEW 权限,转储触发器的 TRIGGER 权限,如果未使用 --single-transaction 选项,则需要 LOCK TABLES 权限,如果未使用 --no-tablespaces 选项,则需要 PROCESS 权限,如果 gtid_mode=ONgtid_purged=ON|AUTO 同时启用,则需要 RELOADFLUSH_TABLES 权限,并使用 --single-transaction。某些选项可能需要其他权限,如选项描述中所述。

要重新加载转储文件,您必须具有执行其中包含的语句所需的权限,例如对由这些语句创建的对象的适当 CREATE 权限。

mysqldump 输出可能包括更改数据库排序规则的 ALTER DATABASE 语句。这些语句可以在转储存储程序时使用以保留其字符编码。要重新加载包含此类语句的转储文件,需要对受影响数据库的 ALTER 权限。

注意

在 Windows 上使用 PowerShell 进行转储并进行输出重定向会在创建的文件中使用 UTF-16 编码

mysqldump [options] > dump.sql

但是,UTF-16 不允许作为连接字符集(参见 不允许的客户端字符集),因此转储文件无法正确加载。要解决此问题,请使用 --result-file 选项,该选项以 ASCII 格式创建输出

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

如果您的转储文件包含系统表,则不建议在服务器上启用 GTID 时加载转储文件(gtid_mode=ON)。mysqldump 对使用非事务性 MyISAM 存储引擎的系统表发出 DML 指令,而当启用 GTID 时,此组合不允许。

性能和可扩展性注意事项

mysqldump 的优势包括在恢复之前查看甚至编辑输出的便利性和灵活性。您可以克隆数据库以进行开发和 DBA 工作,或生成现有数据库的细微变化以进行测试。它并非旨在用作备份大量数据的快速或可扩展解决方案。对于大型数据,即使备份步骤花费合理的时间,恢复数据也可能非常缓慢,因为重放 SQL 语句会涉及用于插入、索引创建等的磁盘 I/O。

对于大规模备份和恢复, 物理 备份更合适,以原始格式复制数据文件,以便能够快速恢复。

如果您的表主要是 InnoDB 表,或者您混合使用 InnoDBMyISAM 表,请考虑使用 mysqlbackup,它是作为 MySQL 企业版的一部分提供的。此工具为 InnoDB 备份提供高性能,并最大程度地减少中断;它还可以备份来自 MyISAM 和其他存储引擎的表;它还提供许多方便的选项来适应不同的备份场景。参见 第 32.1 节,“MySQL 企业版备份概述”

mysqldump 可以逐行检索和转储表内容,或者可以检索表的整个内容并将其缓冲到内存中,然后再转储。如果你要转储大型表,则内存缓冲可能是个问题。要逐行转储表,请使用 --quick 选项(或 --opt,它将启用 --quick)。--opt 选项(因此 --quick)默认情况下是启用的,因此要启用内存缓冲,请使用 --skip-quick

如果你使用的是较新版本的 mysqldump 来生成一个要重新加载到非常旧的 MySQL 服务器中的转储文件,请使用 --skip-opt 选项,而不是使用 --opt--extended-insert 选项。

有关 mysqldump 的更多信息,请参见 第 9.4 节,“使用 mysqldump 进行备份”

调用语法

通常有三种方法可以使用 mysqldump,以便转储一组一个或多个表、一组一个或多个完整数据库或整个 MySQL 服务器,如下所示

mysqldump [options] db_name [tbl_name ...]
mysqldump [options] --databases db_name ...
mysqldump [options] --all-databases

要转储整个数据库,请不要在 db_name 后面命名任何表,或者使用 --databases--all-databases 选项。

要查看你使用的 mysqldump 版本支持的选项列表,请发出命令 mysqldump --help

选项语法 - 按字母顺序排列的摘要

mysqldump 支持以下选项,这些选项可以在命令行或选项文件中指定 [mysqldump][client] 组。有关 MySQL 程序使用的选项文件的信息,请参见 第 6.2.2.2 节,“使用选项文件”

表 6.13 mysqldump 选项

选项名称 说明
--add-drop-database 在每个 CREATE DATABASE 语句之前添加 DROP DATABASE 语句
--add-drop-table 在每个 CREATE TABLE 语句之前添加 DROP TABLE 语句
--add-drop-trigger 在每个 CREATE TRIGGER 语句之前添加 DROP TRIGGER 语句
--add-locks 用 LOCK TABLES 和 UNLOCK TABLES 语句包围每个表转储
--all-databases 转储所有数据库中的所有表
--allow-keywords 允许创建作为关键字的列名
--apply-replica-statements 在 CHANGE REPLICATION SOURCE TO 语句之前包含 STOP REPLICA,并在输出的末尾包含 START REPLICA
--apply-slave-statements 在 CHANGE MASTER 语句之前包含 STOP SLAVE,并在输出的末尾包含 START SLAVE
--bind-address 使用指定的网络接口连接到 MySQL 服务器
--character-sets-dir 安装字符集的目录
--column-statistics 写入 ANALYZE TABLE 语句以生成统计直方图
--comments 向转储文件添加注释
--compact 生成更紧凑的输出
--compatible 生成与其他数据库系统或旧版 MySQL 服务器更兼容的输出
--complete-insert 使用包含列名的完整 INSERT 语句
--compress 压缩客户端和服务器之间发送的所有信息
--compression-algorithms 允许连接到服务器的压缩算法
--create-options 在 CREATE TABLE 语句中包含所有特定于 MySQL 的表选项
--databases 将所有名称参数解释为数据库名称
--debug 写入调试日志
--debug-check 在程序退出时打印调试信息
--debug-info 在程序退出时打印调试信息、内存和 CPU 统计信息
--default-auth 要使用的身份验证插件
--default-character-set 指定默认字符集
--defaults-extra-file 除了通常的选项文件外,还读取命名的选项文件
--defaults-file 只读取命名的选项文件
--defaults-group-suffix 选项组后缀值
--delete-master-logs 在复制源服务器上,在执行转储操作后删除二进制日志
--delete-source-logs 在复制源服务器上,在执行转储操作后删除二进制日志
--disable-keys 对于每个表,在 INSERT 语句周围使用语句来禁用和启用键
--dump-date 如果给出 --comments,则将转储日期作为 "Dump completed on" 注释包含在内
--dump-replica 包含 CHANGE REPLICATION SOURCE TO 语句,该语句列出副本源的二进制日志坐标
--dump-slave 包含 CHANGE MASTER 语句,该语句列出副本源的二进制日志坐标
--enable-cleartext-plugin 启用明文身份验证插件
--events 转储转储数据库中的事件
--extended-insert 使用多行 INSERT 语法
--fields-enclosed-by 此选项与 --tab 选项一起使用,其含义与 LOAD DATA 的相应子句相同
--fields-escaped-by 此选项与 --tab 选项一起使用,其含义与 LOAD DATA 的相应子句相同
--fields-optionally-enclosed-by 此选项与 --tab 选项一起使用,其含义与 LOAD DATA 的相应子句相同
--fields-terminated-by 此选项与 --tab 选项一起使用,其含义与 LOAD DATA 的相应子句相同
--flush-logs 在开始转储之前刷新 MySQL 服务器日志文件
--flush-privileges 在转储 mysql 数据库后发出 FLUSH PRIVILEGES 语句
--force 即使在表转储期间发生 SQL 错误,也继续执行
--get-server-public-key 从服务器请求 RSA 公钥
--help 显示帮助消息并退出
--hex-blob 使用十六进制表示法转储二进制列
--host MySQL 服务器所在的地址
--ignore-error 忽略指定的错误
--ignore-table 不要转储给定的表
--ignore-views 跳过转储表视图
--include-master-host-port 在使用 --dump-slave 生成的 CHANGE MASTER 语句中包含 MASTER_HOST/MASTER_PORT 选项
--include-source-host-port 在使用 --dump-replica 生成的 CHANGE REPLICATION SOURCE TO 语句中包含 SOURCE_HOST 和 SOURCE_PORT 选项
--init-command 连接或重新连接到 MySQL 服务器后执行的单个 SQL 语句;重置现有的定义命令
--init-command-add 添加一个额外的 SQL 语句,在连接或重新连接到 MySQL 服务器后执行
--insert-ignore 写入 INSERT IGNORE 而不是 INSERT 语句
--lines-terminated-by 此选项与 --tab 选项一起使用,其含义与 LOAD DATA 的相应子句相同
--lock-all-tables 锁定所有数据库中的所有表
--lock-tables 在转储表之前锁定所有表
--log-error 将警告和错误追加到命名文件
--login-path 从 .mylogin.cnf 读取登录路径选项
--master-data 将二进制日志文件名和位置写入输出
--max-allowed-packet 发送到或从服务器接收的最大数据包长度
--mysqld-long-query-time 慢查询阈值的会话值
--net-buffer-length TCP/IP 和套接字通信的缓冲区大小
--network-timeout 增加网络超时以允许转储更大的表
--no-autocommit 将每个转储表的 INSERT 语句括在 SET autocommit = 0 和 COMMIT 语句中
--no-create-db 不写入 CREATE DATABASE 语句
--no-create-info 不写入重新创建每个转储表的 CREATE TABLE 语句
--no-data 不转储表内容
--no-defaults 不读取任何选项文件
--no-login-paths 不从登录路径文件读取登录路径
--no-set-names 与 --skip-set-charset 相同
--no-tablespaces 在输出中不写入任何 CREATE LOGFILE GROUP 或 CREATE TABLESPACE 语句
--opt 是 --add-drop-table --add-locks --create-options --disable-keys --extended-insert --lock-tables --quick --set-charset 的简写
--order-by-primary 按每个表的 primary key(主键)或第一个唯一索引对表的行进行转储
--output-as-version 确定转储中使用的副本和事件术语;为了与旧版本兼容
--password 连接到服务器时使用的密码
--password1 连接到服务器时使用的第一个多因素身份验证密码
--password2 连接到服务器时使用的第二个多因素身份验证密码
--password3 连接到服务器时使用的第三个多因素身份验证密码
--pipe 使用命名管道连接到服务器(仅限 Windows)
--plugin-authentication-kerberos-client-mode 允许通过 Windows 上的 MIT Kerberos 库进行 GSSAPI 可插拔身份验证
--plugin-dir 安装插件的目录
--port 连接的 TCP/IP 端口号
--print-defaults 打印默认选项
--protocol 要使用的传输协议
--quick 一次从服务器检索表的行
--quote-names 在反引号字符内引用标识符
--replace 写入 REPLACE 语句而不是 INSERT 语句
--result-file 将输出直接到给定文件
--routines 转储转储数据库中的存储例程(过程和函数)
--server-public-key-path 包含 RSA 公钥的文件的路径名
--set-charset 向输出添加 SET NAMES default_character_set
--set-gtid-purged 是否将 SET @@GLOBAL.GTID_PURGED 添加到输出
--shared-memory-base-name 共享内存连接的共享内存名称(仅限 Windows)
--show-create-skip-secondary-engine 从 CREATE TABLE 语句中排除 SECONDARY ENGINE 子句
--single-transaction 在从服务器转储数据之前发出 BEGIN SQL 语句
--skip-add-drop-table 不要在每个 CREATE TABLE 语句之前添加 DROP TABLE 语句
--skip-add-locks 不要添加锁
--skip-comments 不要向转储文件添加注释
--skip-compact 不要生成更紧凑的输出
--skip-disable-keys 不要禁用键
--skip-extended-insert 关闭 extended-insert
--skip-generated-invisible-primary-key 不要在转储文件中包含生成的不可见主键
--skip-opt 关闭由 --opt 设置的选项
--skip-quick 不要一次从服务器检索表的行
--skip-quote-names 不要引用标识符
--skip-set-charset 不写入 SET NAMES 语句
--skip-triggers 不要转储触发器
--skip-tz-utc 关闭 tz-utc
--socket 要使用的 Unix 套接字文件或 Windows 命名管道
--source-data 将二进制日志文件名和位置写入输出
--ssl-ca 包含受信任的 SSL 证书颁发机构列表的文件
--ssl-capath 包含受信任的 SSL 证书颁发机构证书文件的目录
--ssl-cert 包含 X.509 证书的文件
--ssl-cipher 允许连接加密的密码
--ssl-crl 包含证书吊销列表的文件
--ssl-crlpath 包含证书吊销列表文件的目录
--ssl-fips-mode 是否在客户端启用 FIPS 模式
--ssl-key 包含 X.509 密钥的文件
--ssl-mode 连接到服务器所需的安全性状态
--ssl-session-data 包含 SSL 会话数据的文件
--ssl-session-data-continue-on-failed-reuse 是否在会话重用失败时建立连接
--tab 生成制表符分隔的数据文件
--tables 覆盖--databases或-B选项
--tls-ciphersuites 加密连接允许的 TLSv1.3 密码套件
--tls-sni-servername 客户端提供的服务器名称
--tls-version 加密连接允许的 TLS 协议
--triggers 为每个转储的表转储触发器
--tz-utc 在转储文件中添加 SET TIME_ZONE='+00:00'
--user 连接到服务器时要使用的 MySQL 用户名
--verbose 详细模式
--version 显示版本信息并退出
--where 仅转储由给定 WHERE 条件选定的行
--xml 生成 XML 输出
--zstd-compression-level 使用 zstd 压缩连接到服务器的压缩级别

连接选项

mysqldump 命令登录到 MySQL 服务器以提取信息。以下选项指定如何连接到 MySQL 服务器,无论是在同一台机器上还是在远程系统上。

  • --bind-address=ip_address

    命令行格式 --bind-address=ip_address

    在具有多个网络接口的计算机上,使用此选项选择用于连接到 MySQL 服务器的接口。

  • --compress, -C

    命令行格式 --compress[={OFF|ON}]
    已弃用
    类型 布尔值
    默认值 OFF

    如果可能,压缩客户端和服务器之间发送的所有信息。见 第 6.2.8 节,“连接压缩控制”.

    此选项已弃用。预计它将在 MySQL 的未来版本中被删除。见 配置旧版连接压缩.

  • --compression-algorithms=value

    命令行格式 --compression-algorithms=value
    类型 设置
    默认值 未压缩
    有效值

    zlib

    zstd

    未压缩

    连接到服务器的允许压缩算法。可用算法与 protocol_compression_algorithms 系统变量相同。默认值为 uncompressed

    有关更多信息,请参见 第 6.2.8 节,“连接压缩控制”.

  • --default-auth=plugin

    命令行格式 --default-auth=plugin
    类型 字符串

    关于要使用哪个客户端身份验证插件的提示。见 第 8.2.17 节,“可插拔身份验证”.

  • --enable-cleartext-plugin

    命令行格式 --enable-cleartext-plugin
    类型 布尔值
    默认值 FALSE

    启用 mysql_clear_password 明文身份验证插件。(见 第 8.4.1.4 节,“客户端明文可插拔身份验证”。)

  • --get-server-public-key

    命令行格式 --get-server-public-key
    类型 布尔值

    从服务器请求基于 RSA 密钥对的密码交换所需的公钥。此选项适用于使用 caching_sha2_password 身份验证插件进行身份验证的客户端。对于该插件,服务器不会发送公钥,除非请求。此选项将被忽略,用于不使用该插件进行身份验证的帐户。如果未使用基于 RSA 的密码交换,它也会被忽略,例如,当客户端使用安全连接连接到服务器时。

    如果 --server-public-key-path=file_name 被给出并指定一个有效的公钥文件,它优先于 --get-server-public-key.

    有关 caching_sha2_password 插件的信息,请参见 第 8.4.1.2 节,“缓存 SHA-2 可插拔身份验证”.

  • --host=host_name, -h host_name

    命令行格式 --host

    从给定主机上的 MySQL 服务器转储数据。默认主机是 localhost

  • --login-path=name

    命令行格式 --login-path=name
    类型 字符串

    .mylogin.cnf 登录路径文件中名为登录路径的选项组中读取选项。一个 登录路径 是一个选项组,其中包含指定要连接到哪个 MySQL 服务器以及以哪个帐户进行身份验证的选项。要创建或修改登录路径文件,请使用 mysql_config_editor 实用程序。见 第 6.6.7 节,“mysql_config_editor — MySQL 配置实用程序”.

    有关此选项和其他选项文件选项的更多信息,请参见 第 6.2.2.3 节,“影响选项文件处理的命令行选项”.

  • --no-login-paths

    命令行格式 --no-login-paths

    跳过从登录路径文件读取选项。

    --login-path 以获取相关信息。

    有关此选项和其他选项文件选项的更多信息,请参见 第 6.2.2.3 节,“影响选项文件处理的命令行选项”.

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

    命令行格式 --password[=password]
    类型 字符串

    用于连接到服务器的 MySQL 帐户的密码。密码值是可选的。如果没有给出,mysqldump 会提示输入一个。如果给出,--password=-p 和后面的密码之间必须 没有空格。如果没有指定密码选项,则默认值为不发送密码。

    在命令行上指定密码应该被认为是不安全的。为了避免在命令行上给出密码,请使用选项文件。见 第 8.1.2.1 节,“最终用户密码安全指南”.

    要显式指定没有密码以及 mysqldump 不应该提示输入密码,请使用 --skip-password 选项。

  • --password1[=pass_val]

    用于连接到服务器的 MySQL 帐户的多因素身份验证因子 1 的密码。密码值是可选的。如果没有给出,mysqldump 会提示输入一个。如果给出,--password1= 和后面的密码之间必须 没有空格。如果没有指定密码选项,则默认值为不发送密码。

    在命令行上指定密码应该被认为是不安全的。为了避免在命令行上给出密码,请使用选项文件。见 第 8.1.2.1 节,“最终用户密码安全指南”.

    要显式指定没有密码以及 mysqldump 不应该提示输入密码,请使用 --skip-password1 选项。

    --password1--password 是同义词,--skip-password1--skip-password 也是如此。

  • --password2[=pass_val]

    用于连接到服务器的 MySQL 帐户的多因素身份验证因子 2 的密码。此选项的语义与 --password1 的语义类似;有关详细信息,请参阅该选项的描述。

  • --password3[=pass_val]

    用于连接到服务器的 MySQL 帐户的多因素身份验证因子 3 的密码。此选项的语义与 --password1 的语义类似;有关详细信息,请参阅该选项的描述。

  • --pipe, -W

    命令行格式 --pipe
    类型 字符串

    在 Windows 上,使用命名管道连接到服务器。此选项仅在服务器使用 named_pipe 系统变量启用以支持命名管道连接的情况下适用。此外,进行连接的用户必须是 named_pipe_full_access_group 系统变量指定的 Windows 组的成员。

  • --plugin-authentication-kerberos-client-mode=value

    命令行格式 --plugin-authentication-kerberos-client-mode
    类型 字符串
    默认值 SSPI
    有效值 GSSAPI

    在 Windows 上,authentication_kerberos_client 身份验证插件支持此插件选项。它提供了客户端用户可以在运行时设置的两个可能值:SSPIGSSAPI

    客户端插件选项的默认值使用安全支持提供程序接口 (SSPI),它能够从 Windows 内存缓存中获取凭据。或者,客户端用户可以选择支持通用安全服务应用程序编程接口 (GSSAPI) 的模式,通过 Windows 上的 MIT Kerberos 库。GSSAPI 能够获取之前使用 kinit 命令生成的缓存凭据。

    有关更多信息,请参见 GSSAPI 模式下 Windows 客户端的命令.

  • --plugin-dir=dir_name

    命令行格式 --plugin-dir=dir_name
    类型 目录名称

    要查找插件的目录。如果 --default-auth 选项用于指定身份验证插件,但 mysqldump 没有找到它,则指定此选项。见 第 8.2.17 节,“可插拔身份验证”.

  • --port=port_num, -P port_num

    命令行格式 --port=port_num
    类型 数字
    默认值 3306

    对于 TCP/IP 连接,要使用的端口号。

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

    命令行格式 --protocol=type
    类型 字符串
    默认值 [见文本]
    有效值

    TCP

    SOCKET

    PIPE

    MEMORY

    用于连接到服务器的传输协议。当其他连接参数通常导致使用除您想要的协议之外的协议时,它很有用。有关允许值的详细信息,请参见 第 6.2.7 节,“连接传输协议”.

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

    命令行格式 --server-public-key-path=file_name
    类型 文件名

    包含用于基于 RSA 密钥对的密码交换的服务器所需的公钥的客户端副本的 PEM 格式文件的路径名。此选项适用于使用 sha256_password(已弃用)或 caching_sha2_password 身份验证插件进行身份验证的客户端。对于不使用这些插件之一进行身份验证的帐户,此选项将被忽略。如果未使用基于 RSA 的密码交换(例如,客户端通过安全连接连接到服务器时),此选项也会被忽略。

    如果 --server-public-key-path=file_name 被给出并指定一个有效的公钥文件,它优先于 --get-server-public-key.

    对于 sha256_password(已弃用),此选项仅在使用 OpenSSL 构建 MySQL 时适用。

    有关 sha256_passwordcaching_sha2_password 插件的信息,请参见 第 8.4.1.3 节,“SHA-256 可插拔身份验证”第 8.4.1.2 节,“缓存 SHA-2 可插拔身份验证”

  • --socket=path, -S path

    命令行格式 --socket={file_name|pipe_name}
    类型 字符串

    对于连接到 localhost,要使用的 Unix 套接字文件,或者在 Windows 上,要使用的命名管道的名称。

    在 Windows 上,此选项仅在服务器启动时使用 named_pipe 系统变量启用以支持命名管道连接时适用。此外,进行连接的用户必须是 named_pipe_full_access_group 系统变量指定的 Windows 组的成员。

  • --ssl*

    --ssl 开头的选项指定是否使用加密连接到服务器,并指示在何处查找 SSL 密钥和证书。请参见 加密连接的命令选项

  • --ssl-fips-mode={OFF|ON|STRICT}

    命令行格式 --ssl-fips-mode={OFF|ON|STRICT}
    已弃用
    类型 枚举
    默认值 OFF
    有效值

    OFF

    ON

    STRICT

    控制是否在客户端启用 FIPS 模式。 --ssl-fips-mode 选项不同于其他 --ssl-xxx 选项,因为它不用于建立加密连接,而是用于影响允许的加密操作。请参见 第 8.8 节,“FIPS 支持”

    允许以下 --ssl-fips-mode

    • OFF: 禁用 FIPS 模式。

    • ON: 启用 FIPS 模式。

    • STRICT: 启用“严格”FIPS 模式。

    注意

    如果 OpenSSL FIPS 对象模块不可用,则 --ssl-fips-mode 唯一允许的值为 OFF。在这种情况下,将 --ssl-fips-mode 设置为 ONSTRICT 将导致客户端在启动时生成警告并在非 FIPS 模式下运行。

    此选项已弃用。预计它将在 MySQL 的未来版本中删除。

  • --tls-ciphersuites=ciphersuite_list

    命令行格式 --tls-ciphersuites=ciphersuite_list
    类型 字符串

    使用 TLSv1.3 的加密连接的允许密码套件。该值是一个或多个冒号分隔的密码套件名称列表。此选项可以命名的密码套件取决于用于编译 MySQL 的 SSL 库。有关详细信息,请参见 第 8.3.2 节,“加密连接 TLS 协议和密码”

  • --tls-sni-servername=server_name

    命令行格式 --tls-sni-servername=server_name
    类型 字符串

    如果指定,则使用 mysql_options()MYSQL_OPT_TLS_SNI_SERVERNAME 选项将名称传递给 libmysqlclient C API 库。服务器名称不区分大小写。要显示客户端为当前会话指定的服务器名称(如果有),请检查 Tls_sni_server_name 状态变量。

    服务器名称指示 (SNI) 是 TLS 协议的扩展(OpenSSL 必须使用 TLS 扩展编译才能使此选项起作用)。MySQL 对 SNI 的实现仅代表客户端。

  • --tls-version=protocol_list

    命令行格式 --tls-version=protocol_list
    类型 字符串
    默认值

    TLSv1,TLSv1.1,TLSv1.2,TLSv1.3(OpenSSL 1.1.1 或更高版本)

    TLSv1,TLSv1.1,TLSv1.2(否则)

    加密连接的允许 TLS 协议。该值是一个或多个逗号分隔的协议名称列表。此选项可以命名的协议取决于用于编译 MySQL 的 SSL 库。有关详细信息,请参见 第 8.3.2 节,“加密连接 TLS 协议和密码”

  • --user=user_name, -u user_name

    命令行格式 --user=user_name
    类型 字符串

    用于连接到服务器的 MySQL 帐户的用户名。

    如果您使用的是 Rewriter 插件,您应该授予此用户 SKIP_QUERY_REWRITE 权限。

  • --zstd-compression-level=level

    命令行格式 --zstd-compression-level=#
    类型 整数

    用于使用 zstd 压缩算法连接到服务器的压缩级别。允许的级别为 1 到 22,值越大表示压缩级别越高。默认 zstd 压缩级别为 3。压缩级别设置对不使用 zstd 压缩的连接没有影响。

    有关更多信息,请参见 第 6.2.8 节,“连接压缩控制”.

选项文件选项

这些选项用于控制要读取哪些选项文件。

DDL 选项

mysqldump 的使用场景包括设置一个全新的 MySQL 实例(包括数据库表)以及将现有实例中的数据替换为现有的数据库和表。以下选项允许您通过在转储文件中编码各种 DDL 语句来指定在还原转储时要拆除和设置哪些内容。

调试选项

以下选项打印调试信息,在转储文件中编码调试信息,或者无论出现潜在问题,都让转储操作继续进行。

  • --allow-keywords

    命令行格式 --allow-keywords

    允许创建作为关键字的列名。这通过在每个列名前面加上表名前缀来实现。

  • --comments, -i

    命令行格式 --comments

    在转储文件中写入其他信息,例如程序版本、服务器版本和主机。此选项默认启用。要抑制此附加信息,请使用 --skip-comments

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

    命令行格式 --debug[=debug_options]
    类型 字符串
    默认值 d:t:o,/tmp/mysqldump.trace

    写入调试日志。典型的 debug_options 字符串是 d:t:o,file_name。默认值为 d:t:o,/tmp/mysqldump.trace

    此选项仅在使用 WITH_DEBUG 构建 MySQL 时可用。Oracle 提供的 MySQL 发布版二进制文件没有使用此选项构建。

  • --debug-check

    命令行格式 --debug-check
    类型 布尔值
    默认值 FALSE

    程序退出时打印一些调试信息。

    此选项仅在使用 WITH_DEBUG 构建 MySQL 时可用。Oracle 提供的 MySQL 发布版二进制文件没有使用此选项构建。

  • --debug-info

    命令行格式 --debug-info
    类型 布尔值
    默认值 FALSE

    程序退出时打印调试信息以及内存和 CPU 使用情况统计信息。

    此选项仅在使用 WITH_DEBUG 构建 MySQL 时可用。Oracle 提供的 MySQL 发布版二进制文件没有使用此选项构建。

  • --dump-date

    命令行格式 --dump-date
    类型 布尔值
    默认值 TRUE

    如果指定了 --comments 选项,则 mysqldump 在转储末尾生成以下形式的注释

    -- Dump completed on DATE

    但是,日期会导致在不同时间进行的转储文件显示为不同,即使数据在其他方面相同。 --dump-date--skip-dump-date 控制是否将日期添加到注释中。默认值为 --dump-date(在注释中包含日期)。 --skip-dump-date 会抑制日期打印。

  • --force, -f

    命令行格式 --force

    忽略所有错误;即使在表转储期间发生 SQL 错误,也继续执行。

    此选项的一个用途是让 mysqldump 即使遇到无效的视图(因为定义引用了已删除的表)也能继续执行。如果没有 --force,则 mysqldump 会退出并显示错误消息。使用 --forcemysqldump 会打印错误消息,但也会将包含视图定义的 SQL 注释写入转储输出并继续执行。

    如果还指定了 --ignore-error 选项以忽略特定错误,则 --force 优先。

  • --log-error=file_name

    命令行格式 --log-error=file_name
    类型 文件名

    通过将警告和错误追加到指定的文件中来记录警告和错误。默认情况下不进行任何记录。

  • --skip-comments

    命令行格式 --skip-comments

    请参阅 --comments 选项的说明。

  • --verbose, -v

    命令行格式 --verbose

    详细模式。打印有关程序执行情况的更多信息。

帮助选项

以下选项显示有关 mysqldump 命令本身的信息。

  • --help, -?

    命令行格式 --help

    显示帮助消息并退出。

  • --version, -V

    命令行格式 --version

    显示版本信息并退出。

国际化选项

以下选项更改 mysqldump 命令如何使用国家语言设置表示字符数据。

SET NAMES default_character_set 写入输出。此选项默认启用。要抑制 SET NAMES 语句,请使用 --skip-set-charset

复制选项

  • mysqldump 命令通常用于在复制配置中的从服务器上创建一个空实例或一个包含数据的实例。以下选项适用于在复制源服务器和从服务器上转储和还原数据。

    命令行格式 --apply-replica-statements
    类型 布尔值
    默认值 FALSE

    --apply-replica-statements

  • 对于使用 --dump-replica 选项生成的从服务器转储,此选项在包含二进制日志坐标的语句之前添加一个 STOP REPLICA 语句,并在输出的末尾添加一个 START REPLICA 语句。

    命令行格式 --apply-slave-statements
    已弃用
    类型 布尔值
    默认值 FALSE

    --apply-slave-statements

  • 这是 --apply-replica-statements 的弃用别名。

    命令行格式 --delete-source-logs

    --delete-source-logs

  • 在复制源服务器上,通过在执行转储操作后向服务器发送 PURGE BINARY LOGS 语句来删除二进制日志。这些选项需要 RELOAD 权限以及执行该语句的足够权限。此选项会自动启用 --source-data

    命令行格式 --delete-master-logs
    已弃用

    --delete-master-logs

  • 这是 --delete-source-logs 的弃用别名。

    命令行格式 --dump-replica[=value]
    类型 数字
    默认值 1
    有效值

    1

    2

    此选项类似于 --source-data,但用于转储副本服务器以生成转储文件,该文件可用于将另一个服务器设置为与转储服务器具有相同源的副本。该选项导致转储输出包含一个 CHANGE REPLICATION SOURCE TO 语句,该语句指示转储副本源的二进制日志坐标(文件名和位置)。CHANGE REPLICATION SOURCE TO 语句从 SHOW REPLICA STATUS 输出中读取 Relay_Master_Log_FileExec_Master_Log_Pos 的值,并分别用于 SOURCE_LOG_FILESOURCE_LOG_POS。这些是副本开始复制的复制源服务器坐标。

    注意

    中继日志中已执行的事务序列中的不一致可能会导致使用错误的位置。有关更多信息,请参见 第 19.5.1.34 节,“复制和事务不一致”

    --dump-replica 导致使用源的坐标而不是转储服务器的坐标,如 --source-data 选项所做的那样。此外,指定此选项会覆盖 --source-data 选项。

    警告

    如果要应用转储的服务器使用 gtid_mode=ONSOURCE_AUTO_POSITION=1,则不应使用 --dump-replica

    选项值以与 --source-data 相同的方式处理。设置无值或 1 会导致 CHANGE REPLICATION SOURCE TO 语句写入转储。设置 2 会导致语句被写入,但被封装在 SQL 注释中。就启用或禁用其他选项以及如何处理锁定而言,它与 --source-data 具有相同的效果。

    --dump-replica 导致 mysqldump 在转储之前停止复制 SQL 线程,并在之后重新启动它。

    --dump-replica 向服务器发送 SHOW REPLICA STATUS 语句以获取信息,因此它们需要足够的权限来执行该语句。

    --apply-replica-statements--include-source-host-port 选项可以与 --dump-replica 结合使用。

  • --dump-slave[=value]

    命令行格式 --dump-slave[=value]
    已弃用
    类型 数字
    默认值 1
    有效值

    1

    2

    这是 --dump-replica 的已弃用别名。

  • --include-source-host-port

    命令行格式 --include-source-host-port
    类型 布尔值
    默认值 FALSE

    SOURCE_HOSTSOURCE_PORT 选项添加到副本源的主机名和 TCP/IP 端口号,到使用 --dump-replica 选项生成的副本转储中的 CHANGE REPLICATION SOURCE TO 语句中。

  • --include-master-host-port

    命令行格式 --include-master-host-port
    已弃用
    类型 布尔值
    默认值 FALSE

    这是 --include-source-host-port 的已弃用别名。

  • --master-data[=value]

    命令行格式 --master-data[=value]
    已弃用
    类型 数字
    默认值 1
    有效值

    1

    2

    这是 --source-data 的已弃用别名。

  • --output-as-version=value

    命令行格式 --output-as-version=value
    类型 枚举
    默认值 SERVER
    有效值

    BEFORE_8_0_23

    BEFORE_8_2_0

    确定与副本和事件相关的语句所使用的术语级别,从而可以创建与不支持较新术语的旧版 MySQL 兼容的转储。此选项可以采用以下任一值,其效果如下所示

    • SERVER:读取服务器版本,并使用与该版本兼容的最新版本语句。这是默认值。

    • BEFORE_8_0_23:使用弃用术语(例如“slave”和“master”)的复制 SQL 语句将写入输出,以代替那些使用“replica”和“source”的语句,如 8.0.23 之前的 MySQL 版本。

      此选项还会复制 BEFORE_8_2_0SHOW CREATE EVENT 输出的影响。

    • BEFORE_8_2_0:此选项导致 SHOW CREATE EVENT 反映事件在 8.2.0 之前的 MySQL 服务器中是如何创建的,显示 DISABLE ON SLAVE 而不是 DISABLE ON REPLICA

    此选项影响来自 --events--dump-replica--source-data--apply-replica-statements--include-source-host-port 的输出。

  • --source-data[=value]

    命令行格式 --source-data[=value]
    类型 数字
    默认值 1
    有效值

    1

    2

    用于转储复制源服务器以生成转储文件,该文件可用于将另一个服务器设置为源的副本。这些选项导致转储输出包含一个 CHANGE REPLICATION SOURCE TO 语句,该语句指示转储服务器的二进制日志坐标(文件名和位置)。这些是复制源服务器坐标,副本应在您将转储文件加载到副本中后开始从中复制。

    如果选项值为 2,则 CHANGE REPLICATION SOURCE TO 语句将作为 SQL 注释写入,因此仅供参考;它在重新加载转储文件时无效。如果选项值为 1,则该语句不会作为注释写入,并在重新加载转储文件时生效。如果未指定选项值,则默认值为 1。

    --source-data 向服务器发送 SHOW BINARY LOG STATUS 语句以获取信息,因此它们需要足够的权限来执行该语句。此选项还需要 RELOAD 权限,并且必须启用二进制日志。

    --source-data 会自动关闭 --lock-tables。它们还会打开 --lock-all-tables,除非还指定了 --single-transaction,在这种情况下,仅在转储开始时短暂地获取全局读锁(请参见 --single-transaction 的描述)。在所有情况下,任何对日志的操作都发生在转储的精确时刻。

    还可以使用 --dump-replica 选项转储源的现有副本,以设置副本,该选项会覆盖 --source-data 使其被忽略。

  • --set-gtid-purged=value

    命令行格式 --set-gtid-purged=value
    类型 枚举
    默认值 AUTO
    有效值

    OFF

    ON

    AUTO

    此选项适用于使用基于 GTID 的复制的服务器 (gtid_mode=ON)。它控制 SET @@GLOBAL.gtid_purged 语句在转储输出中的包含,该语句更新了在重新加载转储文件的服务器上 gtid_purged 的值,以添加来自源服务器的 gtid_executed 系统变量的 GTID 集。 gtid_purged 保存已在服务器上应用但不存在于服务器上的任何二进制日志文件中的所有事务的 GTID。因此,mysqldump 添加在源服务器上执行的事务的 GTID,以便目标服务器将这些事务记录为已应用,尽管它没有将它们包含在其二进制日志中。 --set-gtid-purged 还控制 SET @@SESSION.sql_log_bin=0 语句的包含,该语句在重新加载转储文件时禁用二进制日志记录。此语句防止在执行转储文件中的事务时生成和分配新的 GTID,以便使用事务的原始 GTID。

    如果您不设置 --set-gtid-purged 选项,则默认为如果在您要备份的服务器上启用了 GTID,并且全局 gtid_executed 系统变量的值集不为空,则转储输出中将包含 SET @@GLOBAL.gtid_purged 语句。如果在服务器上启用了 GTID,则还会包含 SET @@SESSION.sql_log_bin=0 语句。

    您可以用指定的 GTID 集替换 gtid_purged 的值,或者在语句中添加一个加号 (+) 以将指定的 GTID 集附加到 gtid_purged 已保存的 GTID 集。由 mysqldump 记录的 SET @@GLOBAL.gtid_purged 语句在一个版本特定的注释中包含一个加号 (+),这样 MySQL 会将来自转储文件的 GTID 集添加到现有的 gtid_purged 值。

    需要注意的是,mysqldumpSET @@GLOBAL.gtid_purged 语句中包含的值包括服务器上 gtid_executed 集中所有事务的 GTID,即使这些事务更改了数据库中被抑制的部分,或服务器上未包含在部分转储中的其他数据库。这意味着在目标服务器上重放转储文件后更新 gtid_purged 值后,将存在与目标服务器上任何数据无关的 GTID。如果不在目标服务器上重放任何其他转储文件,这些多余的 GTID 不会对服务器的未来操作造成任何问题,但它们会使比较或协调复制拓扑中不同服务器上的 GTID 集变得更加困难。如果确实在目标服务器上重放包含相同 GTID 的另一个转储文件(例如,来自同一个源服务器的另一个部分转储),则第二个转储文件中的任何 SET @@GLOBAL.gtid_purged 语句都会失败。在这种情况下,可以在重放转储文件之前手动删除该语句,或者在不使用该语句的情况下输出转储文件。

    如果 SET @@GLOBAL.gtid_purged 语句在目标服务器上不会产生预期结果,可以从输出中排除该语句,或者包含该语句但将其注释掉,以便它不会自动执行。还可以包含该语句,但在转储文件中手动编辑它以实现预期结果。

    --set-gtid-purged 选项的可能值如下所示。

    AUTO

    默认值。如果在您备份的服务器上启用了 GTID,并且 gtid_executed 不为空,则 SET @@GLOBAL.gtid_purged 将添加到输出中,其中包含来自 gtid_executed 的 GTID 集。如果启用了 GTID,则 SET @@SESSION.sql_log_bin=0 将添加到输出中。如果在服务器上未启用 GTID,则不会将这些语句添加到输出中。

    OFF

    SET @@GLOBAL.gtid_purged 不会添加到输出中,并且 SET @@SESSION.sql_log_bin=0 也不会添加到输出中。对于 GTID 未使用的服务器,请使用此选项或 AUTO。仅当您确定目标服务器上已存在所需的 GTID 集,并且不应该更改,或者您计划手动识别并添加任何缺失的 GTID 时,才对使用 GTID 的服务器使用此选项。

    ON

    如果在您备份的服务器上启用了 GTID,则 SET @@GLOBAL.gtid_purged 将添加到输出中(除非 gtid_executed 为空),并且 SET @@SESSION.sql_log_bin=0 将添加到输出中。如果您设置了此选项,但服务器上未启用 GTID,则会发生错误。对于使用 GTID 的服务器,请使用此选项或 AUTO,除非您确定 gtid_executed 中的 GTID 在目标服务器上不需要。

    COMMENTED

    如果在您备份的服务器上启用了 GTID,则 SET @@GLOBAL.gtid_purged 将添加到输出中(除非 gtid_executed 为空),但它会被注释掉。这意味着 gtid_executed 的值在输出中可用,但当重载转储文件时不会自动执行任何操作。 SET @@SESSION.sql_log_bin=0 将添加到输出中,并且不会被注释掉。使用 COMMENTED,您可以手动或通过自动化来控制 gtid_executed 集的使用。例如,如果您将数据迁移到已拥有不同活动数据库的另一台服务器,您可能更喜欢这样做。

格式选项

以下选项指定如何表示整个转储文件或转储文件中某些类型的 data。它们还控制是否将某些可选信息写入转储文件。

  • --compact

    命令行格式 --compact

    生成更紧凑的输出。此选项启用 --skip-add-drop-table--skip-add-locks--skip-comments--skip-disable-keys--skip-set-charset 选项。

  • --compatible=name

    命令行格式 --compatible=name[,name,...]
    类型 字符串
    默认值 ''
    有效值

    ansi

    mysql323

    mysql40

    postgresql

    oracle

    mssql

    db2

    maxdb

    no_key_options

    no_table_options

    no_key_options

    生成与其他数据库系统或更旧的 MySQL 服务器更兼容的输出。此选项的唯一允许值是 ansi,它与设置服务器 SQL 模式时相应的选项具有相同的含义。请参阅 第 7.1.11 节,“服务器 SQL 模式”

  • --complete-insert, -c

    命令行格式 --complete-insert

    使用包含列名称的完整 INSERT 语句。

  • --create-options

    命令行格式 --create-options

    CREATE TABLE 语句中包含所有 MySQL 特定的表格选项。

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

    命令行格式 --fields-terminated-by=string
    类型 字符串
    命令行格式 --fields-enclosed-by=string
    类型 字符串
    命令行格式 --fields-optionally-enclosed-by=string
    类型 字符串
    命令行格式 --fields-escaped-by
    类型 字符串

    这些选项与 --tab 选项一起使用,它们与 LOAD DATA 的相应 FIELDS 子句具有相同的含义。请参阅 第 15.2.9 节,“LOAD DATA 语句”

  • --hex-blob

    命令行格式 --hex-blob

    使用十六进制表示法转储二进制列(例如,'abc' 变为 0x616263)。受影响的数据类型是 BINARYVARBINARYBLOB 类型、BIT、所有空间数据类型以及与 binary 字符集 一起使用时的其他非二进制数据类型。

    当使用 --tab 时,--hex-blob 选项将被忽略。

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

    命令行格式 --lines-terminated-by=string
    类型 字符串

    此选项与 --tab 选项一起使用,它与 LOAD DATA 的相应 LINES 子句具有相同的含义。请参阅 第 15.2.9 节,“LOAD DATA 语句”

  • --quote-names, -Q

    命令行格式 --quote-names
    skip-quote-names

    ` 字符中引用标识符(例如数据库、表格和列名称)。如果启用了 ANSI_QUOTES SQL 模式,则标识符在 " 字符中引用。此选项默认启用。它可以通过 --skip-quote-names 禁用,但此选项应该在任何选项(如 --compatible)之后给出,这些选项可能会启用 --quote-names

  • --result-file=file_name, -r file_name

    命令行格式 --result-file=file_name
    类型 文件名

    将输出直接定向到指定的 file。即使在生成转储时发生错误,也会创建结果 file,并覆盖其以前的内容。

    此选项应该在 Windows 上使用,以防止换行符 \n 字符转换为 \r\n 回车/换行序列。

  • --show-create-skip-secondary-engine=value

    命令行格式 --show-create-skip-secondary-engine

    CREATE TABLE 语句中排除 SECONDARY ENGINE 子句。它通过为转储操作的持续时间启用 show_create_table_skip_secondary_engine 系统变量来实现这一点。或者,您可以在使用 mysqldump 之前启用 show_create_table_skip_secondary_engine 系统变量。

  • --tab=dir_name, -T dir_name

    命令行格式 --tab=dir_name
    类型 目录名称

    生成制表符分隔的文本格式 data 文件。对于每个转储的表格,mysqldump 会创建一个 tbl_name.sql 文件,其中包含用于创建表格的 CREATE TABLE 语句,服务器会写入一个 tbl_name.txt 文件,其中包含其 data。选项值是要写入文件的目录。

    注意

    此选项仅应在 mysqldumpmysqld 服务器在同一台机器上运行时使用。由于服务器在您指定的目录中创建 *.txt 文件,因此该目录必须对服务器可写,并且您使用的 MySQL 帐户必须具有 FILE 权限。由于 mysqldump 在同一目录中创建 *.sql,因此它必须对您的系统登录帐户可写。

    默认情况下,.txt data 文件使用列值之间的制表符和每行末尾的换行符进行格式化。可以使用 --fields-xxx--lines-terminated-by 选项显式指定格式。

    列值将转换为由 --default-character-set 选项指定的字符集。

  • --tz-utc

    命令行格式 --tz-utc
    skip-tz-utc

    此选项允许在不同时区服务器之间转储和重新加载 TIMESTAMP 列。 mysqldump 将其连接时区设置为 UTC,并在转储文件中添加 SET TIME_ZONE='+00:00'。如果没有此选项,TIMESTAMP 列将在源服务器和目标服务器的本地时区中转储和重新加载,如果服务器位于不同的时区,这会导致值发生变化。 --tz-utc 还可防止由于夏令时而导致的变化。 --tz-utc 默认情况下启用。要禁用它,请使用 --skip-tz-utc

  • --xml, -X

    命令行格式 --xml

    将转储输出写入格式良好的 XML。

    NULL, 'NULL' 和空值: 对于名为 column_name 的列,NULL 值、空字符串和字符串值 'NULL' 在此选项生成的输出中区分如下。

    XML 表示
    NULL (未知值)

    <field name="column_name" xsi:nil="true" />

    '' (空字符串)

    <field name="column_name"></field>

    'NULL' (字符串值)

    <field name="column_name">NULL</field>

    使用 --xml 选项运行时,mysql 客户端的输出也遵循上述规则。(请参见 第 6.5.1.1 节,“mysql 客户端选项”。)

    来自 mysqldump 的 XML 输出包含 XML 命名空间,如下所示

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

过滤选项

以下选项控制哪些类型的模式对象被写入转储文件:按类别,例如触发器或事件;按名称,例如,选择要转储的数据库和表;甚至使用 WHERE 子句过滤表数据中的行。

  • --all-databases, -A

    命令行格式 --all-databases

    转储所有数据库中的所有表。这与使用 --databases 选项并在命令行上命名所有数据库相同。

    注意

    请参阅 --add-drop-database 说明,了解该选项与 --all-databases 的不兼容性。

    在 MySQL 8.4 之前,--routines--events 选项对于 mysqldump 不需要在使用 --all-databases 选项时包含存储例程和事件:转储包含 mysql 系统数据库,因此也包含包含存储例程和事件定义的 mysql.procmysql.event 表。从 MySQL 8.4 开始,不再使用 mysql.eventmysql.proc 表。对应对象的定义存储在数据字典表中,但这些表不会被转储。要将存储例程和事件包含在使用 --all-databases 创建的转储中,请显式使用 --routines--events 选项。

  • --databases, -B

    命令行格式 --databases

    转储多个数据库。通常,mysqldump 将命令行上的第一个名称参数视为数据库名称,将后续名称视为表名称。使用此选项,它将所有名称参数视为数据库名称。 CREATE DATABASEUSE 语句包含在每个新数据库之前的输出中。

    此选项可用于转储 performance_schema 数据库,该数据库通常不会被转储,即使使用 --all-databases 选项也是如此。(还要使用 --skip-lock-tables 选项。)

    注意

    请参阅 --add-drop-database 说明,了解该选项与 --databases 的不兼容性。

  • --events, -E

    命令行格式 --events

    将转储数据库的事件调度程序事件包含在输出中。此选项需要这些数据库的 EVENT 权限。

    使用 --events 生成的输出包含 CREATE EVENT 语句,用于创建事件。

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

    命令行格式 --ignore-error=error[,error]...
    类型 字符串

    忽略指定的错误。选项值是逗号分隔的错误号列表,指定在 mysqldump 执行期间要忽略的错误。如果还给出了 --force 选项以忽略所有错误,则 --force 优先。

  • --ignore-table=db_name.tbl_name

    命令行格式 --ignore-table=db_name.tbl_name
    类型 字符串

    不要转储给定的表,该表必须使用数据库和表名都指定。要忽略多个表,请多次使用此选项。此选项还可用于忽略视图。

  • --ignore-views=boolean

    命令行格式 --ignore-views
    类型 布尔值
    默认值 FALSE

    跳过转储文件中的表视图。

  • --init-command=str

    命令行格式 --init-command=str
    类型 字符串

    连接到 MySQL 服务器后要执行的单个 SQL 语句。该定义重置由它或 init-command-add 定义的现有语句。

  • --init-command-add=str

    命令行格式 --init-command-add=str
    类型 字符串

    添加要在连接或重新连接到 MySQL 服务器后执行的附加 SQL 语句。它可以在没有 --init-command 的情况下使用,但在其之前使用时没有效果,因为 init-command 会重置要调用的命令列表。

  • --no-data, -d

    命令行格式 --no-data

    不写入任何表行信息(即不转储表内容)。如果您只想转储表的 CREATE TABLE 语句(例如,要通过加载转储文件创建表的空副本),这将非常有用。

  • --routines, -R

    命令行格式 --routines

    将转储数据库的存储例程(过程和函数)包含在输出中。此选项需要全局 SELECT 权限。

    使用 --routines 生成的输出包含 CREATE PROCEDURECREATE FUNCTION 语句,用于创建例程。

  • --skip-generated-invisible-primary-key

    命令行格式 --skip-generated-invisible-primary-key
    类型 布尔值
    默认值 FALSE

    此选项会导致生成的不可见主键从输出中排除。有关更多信息,请参见 第 15.1.20.11 节,“生成的不可见主键”

  • --tables

    命令行格式 --tables

    覆盖 --databases-B 选项。 mysqldump 将选项后面的所有名称参数视为表名称。

  • --triggers

    命令行格式 --triggers
    skip-triggers

    将每个转储表的触发器包含在输出中。此选项默认情况下启用;使用 --skip-triggers 禁用它。

    要能够转储表的触发器,您必须对该表拥有 TRIGGER 权限。

    允许多个触发器。 mysqldump 按激活顺序转储触发器,以便在重新加载转储文件时,触发器以相同的激活顺序创建。但是,如果 mysqldump 转储文件包含对表的多个触发器,这些触发器具有相同的触发事件和操作时间,则尝试将转储文件加载到不支持多个触发器的旧服务器中时,会发生错误。(有关解决方法,请参见 降级说明;您可以将触发器转换为与旧服务器兼容。)

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

    命令行格式 --where='where_condition'

    仅转储由给定的 WHERE 条件选择的行。如果条件包含空格或命令解释器中的其他特殊字符,则条件周围的引号是强制性的。

    示例

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

性能选项

以下选项对于特别是恢复操作的性能最相关。对于大型数据集,恢复操作(处理转储文件中的 INSERT 语句)是最耗时的部分。当需要尽快恢复数据时,请提前规划并测试此阶段的性能。对于以小时为单位测量的恢复时间,您可能更倾向于使用其他备份和恢复解决方案,例如 MySQL Enterprise Backup 用于仅 InnoDB 和混合使用数据库。

性能还受到 事务选项 的影响,主要用于转储操作。

  • --column-statistics

    命令行格式 --column-statistics
    类型 布尔值
    默认值 OFF

    在重新加载转储文件时,将 ANALYZE TABLE 语句添加到输出中,以生成转储表的直方图统计信息。此选项默认情况下处于禁用状态,因为对大型表生成直方图可能需要很长时间。

  • --disable-keys, -K

    命令行格式 --disable-keys

    对于每个表,将 INSERT 语句用 /*!40000 ALTER TABLE tbl_name DISABLE KEYS */;/*!40000 ALTER TABLE tbl_name ENABLE KEYS */; 语句包围。这使得加载转储文件更快,因为索引是在插入所有行之后创建的。此选项仅对 MyISAM 表的非唯一索引有效。

  • --extended-insert, -e

    命令行格式 --extended-insert
    skip-extended-insert

    使用包含多个 VALUES 列表的多行语法编写 INSERT 语句。这会导致转储文件更小,并在重新加载文件时加快插入速度。

  • --insert-ignore

    命令行格式 --insert-ignore

    编写 INSERT IGNORE 语句,而不是 INSERT 语句。

  • --max-allowed-packet=value

    命令行格式 --max-allowed-packet=value
    类型 数字
    默认值 25165824

    客户端/服务器通信缓冲区的最大大小。默认值为 24MB,最大值为 1GB。

    注意

    此选项的值特定于 mysqldump,不应与 MySQL 服务器的 max_allowed_packet 系统变量混淆;无论 mysqldump 选项的任何设置如何,服务器的值都不能超过来自 mysqldump 的单个数据包,即使后者更大。

  • --mysqld-long-query-time=value

    命令行格式 --mysqld-long-query-time=value
    类型 数字
    默认值 服务器全局设置

    设置 long_query_time 系统变量的会话值。如果您希望在将来自 mysqldump 的查询记录到慢速查询日志文件之前,增加允许这些查询的时间,请使用此选项。 mysqldump 执行全表扫描,这意味着它的查询通常会超过对常规查询有用的全局 long_query_time 设置。默认全局设置为 10 秒。

    您可以使用 --mysqld-long-query-time 指定从 0(表示来自 mysqldump 的每个查询都记录到慢速查询日志中)到 31536000(以秒为单位的 365 天)的会话值。对于 mysqldump 的选项,您只能指定完整的秒。当您不指定此选项时,服务器的全局设置适用于 mysqldump 的查询。

  • --net-buffer-length=value

    命令行格式 --net-buffer-length=value
    类型 数字
    默认值 16384

    客户端/服务器通信缓冲区的初始大小。在创建多行 INSERT 语句(如使用 --extended-insert--opt 选项)时, mysqldump 创建最长为 --net-buffer-length 字节的行。如果您增加此变量,请确保 MySQL 服务器 net_buffer_length 系统变量的值至少与此值一样大。

  • --network-timeout, -M

    命令行格式 --network-timeout[={0|1}]
    类型 布尔值
    默认值 TRUE

    通过将 --max-allowed-packet 设置为其最大值,并将网络读取和写入超时设置为较大的值,来启用转储大型表。此选项默认情况下处于启用状态。要禁用它,请使用 --skip-network-timeout

  • --opt

    命令行格式 --opt
    skip-opt

    此选项默认情况下处于启用状态,是 --add-drop-table --add-locks --create-options --disable-keys --extended-insert --lock-tables --quick --set-charset 的组合的简写。它提供了快速转储操作,并生成可以快速重新加载到 MySQL 服务器中的转储文件。

    由于 --opt 选项默认情况下处于启用状态,因此您只需要指定其反面,即 --skip-opt 来关闭几个默认设置。有关选择性启用或禁用受 --opt 影响的选项子集的信息,请参阅 mysqldump 选项组 的讨论。

  • --quick, -q

    命令行格式 --quick
    skip-quick

    此选项对于转储大型表很有用。它迫使 mysqldump 一次从服务器检索表的行,而不是检索整个行集并将它缓冲在内存中,然后再将其写入。

  • --skip-opt

    命令行格式 --skip-opt

    请参阅 --opt 选项的说明。

事务选项

以下选项在转储操作的性能与导出数据的可靠性和一致性之间进行了权衡。

  • --add-locks

    命令行格式 --add-locks

    LOCK TABLESUNLOCK TABLES 语句包围每个表转储。这会导致在重新加载转储文件时更快地插入。请参阅 第 10.2.5.1 节,“优化 INSERT 语句”

  • --flush-logs, -F

    命令行格式 --flush-logs

    在开始转储之前刷新 MySQL 服务器日志文件。此选项需要 RELOAD 权限。如果您将此选项与 --all-databases 选项结合使用,则日志将 针对每个转储的数据库 刷新。例外情况是使用 --lock-all-tables--source-data--single-transaction。在这些情况下,日志仅刷新一次,对应于所有表被 FLUSH TABLES WITH READ LOCK 锁定的时刻。如果您希望您的转储和日志刷新在完全相同的时刻发生,则应将 --flush-logs--lock-all-tables--source-data--single-transaction 结合使用。

  • --flush-privileges

    命令行格式 --flush-privileges

    在转储 mysql 数据库后,将 FLUSH PRIVILEGES 语句添加到转储输出中。此选项应在转储包含 mysql 数据库以及任何其他依赖于 mysql 数据库中的数据的数据库以进行正确还原时使用。

    由于转储文件包含 FLUSH PRIVILEGES 语句,因此重新加载文件需要足以执行该语句的权限。

  • --lock-all-tables, -x

    命令行格式 --lock-all-tables

    锁定所有数据库中的所有表。这是通过在整个转储期间获取全局读取锁来实现的。此选项会自动关闭 --single-transaction--lock-tables

  • --lock-tables, -l

    命令行格式 --lock-tables

    对于每个转储的数据库,在转储它们之前锁定所有要转储的表。这些表被锁定为 READ LOCAL,以允许在 MyISAM 表的情况下并发插入。对于事务表(如 InnoDB),--single-transaction--lock-tables 好得多,因为它根本不需要锁定表。

    由于 --lock-tables 会分别锁定每个数据库的表,因此此选项不能保证转储文件中的表在数据库之间逻辑一致。不同数据库中的表可能在完全不同的状态下转储。

    某些选项(如 --opt)会自动启用 --lock-tables。如果您要覆盖此行为,请在选项列表的末尾使用 --skip-lock-tables

  • --no-autocommit

    命令行格式 --no-autocommit

    将每个转储表的 INSERT 语句包含在 SET autocommit = 0COMMIT 语句中。

  • --order-by-primary

    命令行格式 --order-by-primary

    将每个表的行按照主键排序,如果存在唯一索引,则按第一个唯一索引排序。当将 MyISAM 表转储到 InnoDB 表时,这很有用,但会使转储操作花费更长时间。

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

    命令行格式 --shared-memory-base-name=name
    平台特定 Windows

    在 Windows 上,用于使用共享内存连接到本地服务器的共享内存名称。默认值为 MYSQL。共享内存名称区分大小写。

    此选项仅在服务器使用 shared_memory 系统变量启用以支持共享内存连接时适用。

  • --single-transaction

    命令行格式 --single-transaction

    此选项将事务隔离级别设置为 REPEATABLE READ,并在转储数据之前向服务器发送 START TRANSACTION SQL 语句。它仅对事务性表(例如 InnoDB)有用,因为它会转储在发出 START TRANSACTION 时的数据库一致状态,而不会阻塞任何应用程序。

    如果 gtid_mode=ONgtid_purged=ON|AUTO,则 RELOADFLUSH_TABLES 权限需要与 --single-transaction 结合使用。

    使用此选项时,请注意,只有 InnoDB 表以一致状态转储。例如,使用此选项转储的任何 MyISAMMEMORY 表可能仍然会发生状态更改。

    --single-transaction 转储过程中,为了确保转储文件有效(正确的表内容和二进制日志坐标),任何其他连接都不应使用以下语句:ALTER TABLECREATE TABLEDROP TABLERENAME TABLETRUNCATE TABLE。一致性读取不会与这些语句隔离,因此在要转储的表上使用它们会导致 SELECT(由 mysqldump 执行以检索表内容)获取不正确的内容或失败。

    --single-transaction 选项和 --lock-tables 选项是互斥的,因为 LOCK TABLES 会导致任何挂起的事务隐式提交。

    要转储大型表,请将 --single-transaction 选项与 --quick 选项结合使用。

选项组

  • --opt 选项开启多个设置,这些设置协同工作以执行快速转储操作。所有这些设置默认情况下都处于开启状态,因为 --opt 默认情况下处于开启状态。因此,您很少(如果有的话)会指定 --opt。相反,您可以通过指定 --skip-opt 来关闭这些设置,然后选择性地通过在命令行中稍后指定关联的选项来重新启用某些设置。

  • --compact 选项关闭多个设置,这些设置控制输出中是否出现可选语句和注释。同样,您可以使用其他选项跟随此选项以重新启用某些设置,或者通过使用 --skip-compact 形式来开启所有设置。

当您选择性地启用或禁用组选项的效果时,顺序很重要,因为选项的处理顺序是从前到后。例如,--disable-keys --lock-tables --skip-opt 将不起作用;它与单独使用 --skip-opt 相同。

示例

备份整个数据库

mysqldump db_name > backup-file.sql

将转储文件重新加载到服务器

mysql db_name < backup-file.sql

另一种重新加载转储文件的方法

mysql -e "source /path-to-backup/backup-file.sql" db_name

mysqldump 对于通过从一个 MySQL 服务器复制数据到另一个 MySQL 服务器来填充数据库也非常有用

mysqldump --opt db_name | mysql --host=remote_host -C db_name

您可以使用一个命令转储多个数据库

mysqldump --databases db_name1 [db_name2 ...] > my_databases.sql

要转储所有数据库,请使用 --all-databases 选项

mysqldump --all-databases > all_databases.sql

对于 InnoDB 表,mysqldump 提供了一种进行在线备份的方法

mysqldump --all-databases --source-data --single-transaction > all_databases.sql

此备份在转储开始时获取所有表的全局读取锁(使用 FLUSH TABLES WITH READ LOCK)。一旦获取了此锁,就会读取二进制日志坐标并释放锁。如果在发出 FLUSH 语句时正在运行长时间更新语句,则 MySQL 服务器可能会停滞,直到这些语句完成。之后,转储将变为无锁状态,不会干扰表上的读写操作。如果 MySQL 服务器接收到的更新语句很短(就执行时间而言),则即使存在大量更新,初始锁定时间段也应该不会明显。

对于时间点恢复(也称为“向前滚动,” 当您需要还原旧备份并重放自该备份以来发生的更改时),旋转二进制日志(请参阅 第 7.4.4 节,“二进制日志”)或至少了解转储对应的二进制日志坐标通常很有用

mysqldump --all-databases --source-data=2 > all_databases.sql

或者

mysqldump --all-databases --flush-logs --source-data=2 > all_databases.sql

--source-data 选项可以与 --single-transaction 选项同时使用,这提供了一种方便的方法来进行适合在时间点恢复之前使用的在线备份,前提是表使用 InnoDB 存储引擎存储。

有关进行备份的更多信息,请参阅 第 9.2 节,“数据库备份方法”第 9.3 节,“示例备份和恢复策略”

限制

mysqldump 默认情况下不会转储 performance_schemasys 模式。要转储其中任何一个,请在命令行中明确命名它们。您也可以使用 --databases 选项来命名它们。对于 performance_schema,还要使用 --skip-lock-tables 选项。

mysqldump 不会转储 INFORMATION_SCHEMA 模式。

mysqldump 不会转储 InnoDB CREATE TABLESPACE 语句。

mysqldump 不会转储 NDB Cluster ndbinfo 信息数据库。

mysqldump 包含用于重新创建 mysql 数据库转储的 general_logslow_query_log 表的语句。日志表内容不会转储。

如果您在备份视图时遇到由于权限不足而导致的问题,请参阅 第 27.9 节,“视图限制” 以了解解决方法。