eaudeweb/mysqldump-php

MySQL自带的mysqldump cli的PHP版本

维护者

详细信息

github.com/eaudeweb/mysqldump-php

主页

源代码

安装: 205

依赖者: 1

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 300

v2.8 2019-06-19 09:52 UTC

Requires

  • php: >=5.3.0

Requires (Dev)

GPL-3.0-or-later c255861566aba7ba006aa59bd4b6eb21503a6b48

databasephpsqlmysqlpdophp5mariadbmysqldumphhvmPHP7mysql-backup

This package is auto-updated.

Last update: 2024-09-19 21:54:44 UTC

README

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

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

这是一个不带依赖项、输出压缩和合理默认设置的MySQL自带的mysqldump cli的PHP版本。

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

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

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

重要

从版本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->setTransformColumnValueHook(function ($tableName, $colName, $colValue) {
    if ($colName === 'social_security_number') {
        return (string) rand(1000000, 9999999);
    }

    return $colValue;
});

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

特定于表的导出条件

您可以注册特定于表的'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);

导出设置

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

PDO设置

错误

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

  • 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