acromedia/mysqldump-php

MySQL自带的mysqldump命令行的PHP版本

v2.5 2018-06-30 19:40 UTC

This package is not auto-updated.

Last update: 2024-09-15 15:38:17 UTC


README

需求 | 安装 | 入门 | 构造函数和默认参数 | 导出设置 | PDO设置 | 待办事项 | 许可 | 致谢

Build Status Total Downloads Monthly Downloads Daily Downloads Scrutinizer Quality Score Latest Stable Version

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

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

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

  • 以十六进制形式输出二进制大对象。
  • 解析视图依赖关系(使用替代表)。
  • 与原始mysqldump进行比较输出。链接到travis-ci测试系统(从php 5.3到7.1 & hhvm进行测试)
  • 导出存储过程。
  • 导出事件。
  • 支持扩展插入和/或完整插入。
  • 支持MySQL 5.7的虚拟列。
  • 在插入时忽略错误,类似于REPLACE,但忽略存在重复键的错误。
  • 在导出时使用钩子动态修改数据库中的数据。

重要

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

需求

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

安装

使用 Composer

$ composer require ifsnop/mysqldump-php:2.*

或通过json文件

"require": {
        "ifsnop/mysqldump-php":"2.*"
}

使用 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');

请参考 wiki 了解一些示例以及mysqldump和mysqldump-php导出的比较。

导出时更改值

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

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

$dumper->setTransformColumnValueHook(function ($tableName, $colName, $colValue) {
    if ($colName === 'social_security_number') {
        return (string) rand(1000000, 9999999);
    }

    return $colValue;
});

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

构造函数和默认参数

/**
 * 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);

导出设置

以下选项现在默认启用,由于它们应该始终使用,因此无法禁用。

PDO 设置

错误

要转储数据库,您需要以下权限

  • SELECT
    • 为了转储表结构和数据。
  • SHOW VIEW
    • 如果任何数据库有视图,否则您将收到错误。
  • TRIGGER
    • 如果任何表有一个或多个触发器。
  • LOCK TABLES
    • 如果启用了“lock tables”选项。

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

要获取MySQL数据库模式备份,所需的最低权限是什么?

测试

当前测试代码是一个丑陋的修改。可能还有许多更好的方法使用PHPUnit来完成这些任务,因此欢迎提交PR。测试脚本创建并填充数据库,使用所有可能的数据类型。然后使用mysqldump-php和mysqldump导出它,并比较输出。只有当它们相同,测试才通过。

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

只有几个测试是在原始 SQL 代码和 mysqldump-php 之间进行比较的,因为 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