README

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

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

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

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

• 将输出二进制blob转换为十六进制。
• 解决视图依赖（使用占位符表）。
• 与原始mysqldump输出对比。链接到travis-ci测试系统（从php 5.3到7.3 & hhvm测试）
• 导出存储过程（函数和过程）。
• 导出事件。
• 执行扩展插入和/或完整插入。
• 支持MySQL 5.7的虚拟列。
• 执行插入忽略，类似于REPLACE，但在存在重复键时忽略错误。
• 在导出时动态修改数据库中的数据，使用钩子。
• 可以直接通过压缩流包装器（GZIPSTREAM）将数据保存到Google云端存储。
• 在没有mysql可执行文件的情况下，可以从文件恢复备份。

重要

从版本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(),
    'if-not-exists' => false,
    '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-db' => false,
    '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数组中的视图都被包含。
• if-not-exists
  • 仅当不存在同名表时才创建新表。如果表已存在，则不抛出错误消息。
• compress
  • Gzip，Bzip2，无。
  • 可以使用声明的常量指定：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-db
  • 禁用创建数据库语句的转储选项。
  • https://dev.mysqlserver.cn/doc/refman/5.1/en/mysqldump.html#option_mysqldump_no-create-db
• 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
  • 如果启用了“锁定表”选项。

使用 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