ifsnop/mysqldump-php

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

维护者

详细信息

github.com/ifsnop/mysqldump-php

主页

源代码

问题

安装次数: 3,524,363

依赖项: 76

建议者: 0

安全性: 0

星星: 1,234

关注者: 54

分支: 300

开放问题: 28

v2.12 2023-04-12 07:43 UTC

Requires

  • php: >=5.3.0

Requires (Dev)

GPL-3.0-or-later 2d3a43fc0c49f23bf7dee392b0dd1f8c799f89d3

databasephpsqlmysqlpdophp5mariadbmysqldumphhvmPHP7mysql-backup

This package is auto-updated.

Last update: 2024-09-20 02:03:34 UTC

README

需求 | 安装 | 入门 | API | 设置 | PDO设置 | 待办事项 | 许可 | 贡献者

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

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

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

MySQLDump-PHP是唯一一个支持

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

入门

使用 自动加载器/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);

转储设置

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

PDO 设置

错误

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

  • SELECT
    • 用于转储表结构和数据。
  • SHOW VIEW
    • 如果任何数据库有视图，否则你会得到一个错误。
  • TRIGGER
    • 如果任何表有一个或多个触发器。
  • 锁定表
    • 如果启用了“锁定表”选项。

使用 SHOW GRANTS FOR user@host; 命令来了解用户拥有的权限。更多信息请见以下链接

要备份MySQL数据库架构，需要哪些最低权限？

测试

当前测试代码是一个丑陋的解决方案。可能使用PHPUnit有更好的实现方法，所以欢迎提交Pull Request。测试脚本会创建并填充一个数据库，使用所有可能的数据类型。然后使用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