README

需求 | 安装 | 入门 | API | 设置 | PDO 设置 | 待办事项 | 许可 | 致谢

这是 MySQL 自带 mysqldump 命令行的 PHP 版本，无依赖，输出压缩和合理的默认设置。

默认情况下，MySQLDump-PHP 支持备份表结构、数据本身、视图、触发器和事件。

MySQLDump-PHP 是唯一支持以下功能的库：

• 以十六进制形式输出二进制大对象。
• 解析视图依赖关系（使用替代表）。
• 与原始 mysqldump 输出进行对比。链接到 travis-ci 测试系统（从 php 5.3 测试到 7.3 及 hhvm）
• 转储存储过程（函数和过程）。
• 转储事件。
• 执行扩展插入和/或完整插入。
• 支持 MySQL 5.7 的虚拟列。
• 执行插入忽略，类似于 REPLACE，但忽略重复键存在时的错误。
• 在转储过程中使用钩子动态修改数据库中的数据。
• 可以直接通过压缩流包装器（GZIPSTREAM）将数据保存到 Google Cloud Storage。

重要

从版本 2.0 开始，数据库连接使用标准的 DSN 进行，详见 PDO 连接字符串。

需求

• PHP 5.3.0 或更高版本
• MySQL 4.1.0 或更高版本
• PDO

安装

使用 Composer

$ composer require ifsnop/mysqldump-php

使用 Curl 始终下载并解压缩最新版本

$ curl --silent --location https://api.github.com/repos/ifsnop/mysqldump-php/releases | grep -i tarball_url | head -n 1 | cut -d '"' -f 4 | xargs curl --location --silent | tar xvz

入门

使用 Autoloader/Composer

<?php

use Ifsnop\Mysqldump as IMysqldump;

try {
    $dump = new IMysqldump\Mysqldump('mysql:host=localhost;dbname=testdb', 'username', 'password');
    $dump->start('storage/work/dump.sql');
} catch (\Exception $e) {
    echo 'mysqldump-php error: ' . $e->getMessage();
}

普通 PHP

<?php

    include_once(dirname(__FILE__) . '/mysqldump-php-2.0.0/src/Ifsnop/Mysqldump/Mysqldump.php');
    $dump = new Ifsnop\Mysqldump\Mysqldump('mysql:host=localhost;dbname=testdb', 'username', 'password');
    $dump->start('storage/work/dump.sql');

有关一些示例和 mysqldump 与 mysqldump-php 转储之间的比较，请参阅 wiki。

导出时更改值

您可以将一个可调用的函数注册为在导出过程中用于转换值。此示例用例是从数据库转储中删除敏感数据。

$dumper = new IMysqldump\Mysqldump('mysql:host=localhost;dbname=testdb', 'username', 'password');

$dumper->setTransformTableRowHook(function ($tableName, array $row) {
    if ($tableName === 'customers') {
        $row['social_security_number'] = (string) rand(1000000, 9999999);
    }

    return $row;
});

$dumper->start('storage/work/dump.sql');

获取转储信息

您可以将一个可调用的函数注册为在转储过程中用于报告进度。

$dumper->setInfoHook(function($object, $info) {
    if ($object === 'table') {
        echo $info['name'], $info['rowCount'];
    });

表特定导出条件

您可以将特定的 'where' 子句注册为表特定，以限制每张表上的数据。这些会覆盖默认的 where 导出设置

$dumper = new IMysqldump\Mysqldump('mysql:host=localhost;dbname=testdb', 'username', 'password');

$dumper->setTableWheres(array(
    'users' => 'date_registered > NOW() - INTERVAL 3 MONTH AND deleted=0',
    'logs' => 'date_logged > NOW() - INTERVAL 1 DAY',
    'posts' => 'isLive=1'
));

表特定导出限制

您可以将特定的 'limits' 注册为表特定，以限制每张表上返回的行数

$dumper = new IMysqldump\Mysqldump('mysql:host=localhost;dbname=testdb', 'username', 'password');

$dumper->setTableLimits(array(
    'users' => 300,
    'logs' => 50,
    'posts' => 10
));

构造函数和默认参数

/**
 * Constructor of Mysqldump. Note that in the case of an SQLite database
 * connection, the filename must be in the $db parameter.
 *
 * @param string $dsn        PDO DSN connection string
 * @param string $user       SQL account username
 * @param string $pass       SQL account password
 * @param array  $dumpSettings SQL database settings
 * @param array  $pdoSettings  PDO configured attributes
 */
public function __construct(
    $dsn = '',
    $user = '',
    $pass = '',
    $dumpSettings = array(),
    $pdoSettings = array()
)

$dumpSettingsDefault = array(
    'include-tables' => array(),
    'exclude-tables' => array(),
    'compress' => Mysqldump::NONE,
    'init_commands' => array(),
    'no-data' => array(),
    'reset-auto-increment' => false,
    'add-drop-database' => false,
    'add-drop-table' => false,
    'add-drop-trigger' => true,
    'add-locks' => true,
    'complete-insert' => false,
    'databases' => false,
    'default-character-set' => Mysqldump::UTF8,
    'disable-keys' => true,
    'extended-insert' => true,
    'events' => false,
    'hex-blob' => true, /* faster than escaped content */
    'insert-ignore' => false,
    'net_buffer_length' => self::MAXLINESIZE,
    'no-autocommit' => true,
    'no-create-info' => false,
    'lock-tables' => true,
    'routines' => false,
    'single-transaction' => true,
    'skip-triggers' => false,
    'skip-tz-utc' => false,
    'skip-comments' => false,
    'skip-dump-date' => false,
    'skip-definer' => false,
    'where' => '',
    /* deprecated */
    'disable-foreign-keys-check' => true
);

$pdoSettingsDefaults = array(
    PDO::ATTR_PERSISTENT => true,
    PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => false
);

// missing settings in constructor will be replaced by default options
$this->_pdoSettings = self::array_replace_recursive($pdoSettingsDefault, $pdoSettings);
$this->_dumpSettings = self::array_replace_recursive($dumpSettingsDefault, $dumpSettings);

导出设置

• include-tables
  • 仅包括这些表（表名数组），如果为空则包括所有表。
• exclude-tables
  • 排除这些表（表名数组），如果为空则包括所有表，支持正则表达式。
• include-views
  • 仅包括这些视图（视图名数组），如果为空则包括所有视图。默认情况下，所有与include-tables数组中命名的视图都包括在内。
• compress
  • Gzip, Bzip2, None。
  • 可以使用声明的常量指定：IMysqldump\Mysqldump::GZIP, IMysqldump\Mysqldump::BZIP2或IMysqldump\Mysqldump::NONE
• reset-auto-increment
  • 从数据库定义中删除AUTO_INCREMENT选项。
  • 当与no-data一起使用时很有用，因此当数据库重新创建时，它将从1开始而不是使用旧值。
• add-drop-database
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_add-drop-database
• add-drop-table
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_add-drop-table
• add-drop-triggers
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_add-drop-trigger
• add-locks
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_add-locks
• complete-insert
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_complete-insert
• databases
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_databases
• default-character-set
  • utf8（默认，兼容选项），utf8mb4（适用于完全utf8兼容）
  • 可以使用声明的常量指定：IMysqldump\Mysqldump::UTF8或IMysqldump\Mysqldump::UTF8MB4BZIP2
  • https://dev.mysqlserver.cn/doc/refman/5.5/en/charset-unicode-utf8mb4.html
  • https://mathiasbynens.be/notes/mysql-utf8mb4
• disable-keys
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_disable-keys
• events
  • https://dev.mysqlserver.cn/doc/refman/5.7/en/mysqldump.html#option_mysqldump_events
• extended-insert
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_extended-insert
• hex-blob
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_hex-blob
• insert-ignore
  • https://dev.mysqlserver.cn/doc/refman/5.7/en/mysqldump.html#option_mysqldump_insert-ignore
• lock-tables
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_lock-tables
• net_buffer_length
  • https://dev.mysqlserver.cn/doc/refman/5.7/en/mysqldump.html#option_mysqldump_net_buffer_length
• no-autocommit
  • 禁用autocommit的选项（更快地插入，没有索引键的问题）
  • https://dev.mysqlserver.cn/doc/refman/4.1/en/commit.html
• no-create-info
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_no-create-info
• no-data
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_no-data
  • 不导出这些表（表名数组）的数据，支持正则表达式，true表示忽略所有表
• routines
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_routines
• single-transaction
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_single-transaction
• skip-comments
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_comments
• skip-dump-date
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_dump-date
• skip-triggers
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_triggers
• skip-tz-utc
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_tz-utc
• skip-definer
  • https://dev.mysqlserver.cn/doc/refman/5.7/en/mysqlpump.html#option_mysqlpump_skip-definer
• where
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_where

以下选项现在是默认启用的，无法禁用，因为它们应该始终使用。

• disable-foreign-keys-check
  • https://dev.mysqlserver.cn/doc/refman/5.5/en/optimizing-innodb-bulk-data-loading.html

PDO 设置

• PDO::ATTR_PERSISTENT
• PDO::ATTR_ERRMODE
• PDO::MYSQL_ATTR_INIT_COMMAND
• PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
  • https://secure.php.net/manual/en/ref.pdo-mysql.php
  • https://stackoverflow.com/questions/13728106/unexpectedly-hitting-php-memory-limit-with-a-single-pdo-query/13729745#13729745
  • https://secure.php.net/manual/en/mysqlinfo.concepts.buffering.php

错误

导出数据库需要以下权限

• SELECT
  • 用于导出表结构和数据。
• SHOW VIEW
  • 如果任何数据库有视图，否则会出错。
• TRIGGER
  • 如果任何表有一个或多个触发器。
• LOCK TABLES
  • 如果启用了“lock tables”选项。

使用 SHOW GRANTS FOR user@host; 来了解用户有哪些权限。有关更多信息，请参阅以下链接

要获取MySQL数据库模式的备份，需要最低哪些权限？

测试

当前用于测试的代码是一个糟糕的解决方案。可能使用PHPUnit有更好的实现方式，因此欢迎提交PR。测试脚本使用所有可能的数据类型创建并填充数据库，然后使用mysqldump-php和mysqldump进行导出，并比较输出。只有当输出完全一致时，测试才通过。在这次提交之后，一些测试开始使用phpunit执行。

如果MySQL服务器不支持某些测试，则会跳过一些测试。

有几项测试仅比较原始SQL代码和mysqldump-php生成的SQL，因为mysqldump中不提供某些选项。

错误（来自mysqldump，而非mysqldump-php）

在这个错误报告之后，引入了一个新的错误。当使用hex-blob选项时，如果值为空，也会附加_binary。

回滚

mysqldump-php不与php 5.2向后兼容，因为我们使用了命名空间。然而，如果需要，可以轻易修复。

待办事项

编写更多测试，同时测试mariadb。

贡献

将所有代码格式化为PHP-FIG标准。https://www.php-fig.org/

许可证

本项目是开源软件，许可协议为GPL许可

致谢

经过8年多，原始源代码几乎所剩无几，但

最初基于2009年James Elliott的脚本。https://code.google.com/archive/p/db-mysqldump/

由Michael J. Calkins修改和扩展。https://github.com/clouddueling

目前由Diego Torres维护、开发和改进。https://github.com/ifsnop