README

DBDiff 是一个自动化的数据库模式和数据差异工具。它比较两个数据库（本地或远程），并自动生成差异迁移文件。

当与兼容的数据库迁移工具一起使用时，它可以帮助团队或企业内实现数据库版本控制。

支持 DBDiff

DBDiff 是一个 MIT 许可的开源项目，其持续开发完全由赞助者的支持得以实现。为了获得回报，请考虑以下选项：

• 在 Patreon 上成为赞助者或支持者.
• 通过 PayPal 一次性捐赠
• 如果您是个人、公司或组织，对 DBDiff 的商业支持包感兴趣，请 联系我们

功能

• 由于是用 PHP 开发的，所以可以在 Windows、Linux & Mac 命令行/Terminal 上运行
• 连接到源数据库和目标数据库进行比较差异，本地和远程均可
• 差异可以包括模式和数据（有效 SQL）的变化，以将目标数据库更新为与源数据库一致
• 可以通过配置文件中的 YAML 集合忽略某些表和/或字段进行比较（请参阅文件示例）
• 差异非常快，此工具已测试过具有数百万行表的数据库
• 由于此差异工具用于迁移，它提供同一文件中的向上和向下 SQL
• 可以通过指定输出模板文件/格式与现有的迁移工具（如 Flyway 和 Simple DB Migrate）一起使用，例如，Simple DB Migrate 可能与 simple-db-migrate.tmpl 一起使用，该模板包括：SQL_UP = u""" {{ $up }} """ SQL_DOWN = u""" {{ $down }} """
• 支持 Unicode，可以处理 UTF8 数据，包括外文字符/符号
• 目前仅支持 MySQL，但我们将根据请求扩展到其他数据库（请创建问题并投票！）

先决条件

1. 您需要访问命令行，对于 Linux/Mac，是一个终端；对于 Windows，是命令提示符（cmd）
2. 您需要安装 git： https://git-scm.cn/downloads
3. 您需要安装 PHP（版本 5.4.x）： https://php.ac.cn/manual/en/install.php
4. 您需要安装 Composer，它是 PHP 的依赖管理器： https://getcomposer.org

注意：请记住 composer.phar 的安装位置，因为我们将在设置过程中使用它

安装

在命令行中，使用 git 克隆 ssh 版本

git clone git@github.com:DBDiff/DBDiff.git

或者 使用 git 克隆 https 版本

git clone https://github.com/DBDiff/DBDiff.git

或者 下载 .zip 存档并将其解压到您选择的文件夹中，例如 dbdiff

https://github.com/DBDiff/DBDiff/archive/master.zip

或者 使用 composer 将 DBDiff 包含为项目依赖项

php composer.phar require "dbdiff/dbdiff:@dev"

或者 使用 composer 全局安装 DBDiff

composer global require "dbdiff/dbdiff:@dev"

创建 PHAR 构建

请首先确保在您的 php.ini 文件中，phar.readonly 设置被设置为 false，例如：

[Phar]
; https://php.ac.cn/phar.readonly
phar.readonly = false

然后在 dbdiff 仓库的根目录下生成 Phar 构建版本，只需运行：

$ ./build

应创建一个包含以下文件的 dist 文件夹：

• dbdiff.phar
• dbdiff.phar.gz

您可以将 dbdiff.phar 重命名为 dbdiff 并将其移动到 /usr/local/bin 或您选择的另一个目录。

如果您希望将其作为系统上的工具使它全局可用，也可以将其添加到系统路径中。

设置

确保您在以下所有步骤中都在您的应用程序的根目录，使用 'cd' 命令在命令行中导航到您放置 "dbdiff" 文件夹的位置

我们假设 composer.phar 已安装在你的 "dbdiff" 文件夹中。如果它在其他地方安装，你需要使用它的确切路径

1. 如果您没有使用 composer 安装 DBDiff，请使用以下命令安装项目的依赖项：php composer.phar install
2. 按照 文件示例 创建一个 .dbdiff 文件，并将其放置在 "dbdiff" 目录的根目录下
3. 输入 ./dbdiff {dbdiff 命令，例如 server1.db1:server1.db2} 来启动应用程序！有关可以运行的命令的详细信息，请参阅 命令行 API。

您应该会看到类似...

ℹ Now calculating schema diff for table `foo`
ℹ Now calculating data diff for table `foo`
ℹ Now generating UP migration
ℹ Now generating DOWN migration
ℹ Writing migration file to /path/to/dbdiff/migration.sql
✔ Completed

恭喜您已安装并运行 DBDiff！

命令行 API

注意：命令行参数将始终覆盖 .dbdiff 配置文件中的设置

• --server1=user:password@host1:port - 指定源数据库连接详细信息。如果只有一个服务器，可以省略 --server1 标志
• --server2=user:password@host2:port - 指定目标数据库连接详细信息（如果它与 server1 不同）
• --template=templates/simple-db-migrate.tmpl - 指定输出模板（如果有）。默认为纯 SQL
• --type=schema 或 data 或 all - 指定要执行的差异类型，是模式、数据或两者。schema 是默认值
• --include=up 或 down 或 all - 指定是否包含输出中的 up、down 或两者数据。up 是默认值
• --nocomments=true - 默认情况下，带井号（#）字符的自动注释将包含在输出文件中，可以使用此参数删除
• --config=config.yaml - 默认情况下，DBDiff 会查找当前目录中的 .dbdiff 文件，它是有效的 YAML 格式，也可以使用 YAML 格式的配置文件（而不是使用命令行）覆盖，列出源和目标数据库的主机、用户、端口和密码，或其他设置，例如格式、模板、类型、包含、nocomments。请注意：命令行参数将始终覆盖任何配置文件。
• server1.db1.table1:server2.db2.table3 或 server1.db1:server2.db2 - 最后一个参数是要比较的内容。此工具可以比较数据库中的一个表或所有表（整个数据库）
• --output=./output-dir/today-up-schema.sql - 最后一个参数是输出文件和/或目录，用于输出差异，默认情况下将输出到运行命令的同一目录，如果未指定目录。如果指定了目录，则它应该存在，否则将引发错误。如果没有指定此路径，则默认文件名变为当前目录中的 migration.sql

使用示例

示例 1

$ ./dbdiff server1.db1:server2.db2

默认情况下，该工具会查找.dbdiff配置文件以获取数据库连接细节，如果不存在，则工具会返回错误。如果存在，将使用这些连接细节来比较仅包含架构的SQL，并在当前目录内输出一个带注释的migration.sql文件，默认情况下只包含up SQL。

示例2

$ ./dbdiff server1.development.table1:server2.production.table1 --nocomments=true --type=data

默认情况下，该工具会查找.dbdiff配置文件以获取数据库连接细节，如果不存在，则工具会返回错误。如果存在，将使用这些连接细节来比较指定表（table1）在各个数据库中的数据SQL，并在当前目录内输出一个无注释的.sql文件，默认情况下只包含up SQL。

示例3

$ ./dbdiff --config=config.conf --template=templates/simple-db-migrate.tmpl --include=all server1.db1:server2.db2 --output=./sql/simple-schema.sql

而不是查找.dbdiff，它会查找config.conf（应为有效的YAML）以获取设置，并覆盖命令行参数中提供的--template和--include参数的任何设置，从而比较源数据库与目标数据库，并将名为simple-schema.sql的SQL文件输出到./sql目录中（应已存在，否则程序会抛出错误），该文件包含仅作为up和down SQL diff的架构（如模板指定）。此示例可以与simple-db-migrate工具完美协同工作。

文件示例

.dbdiff

server1:
	user: user
	password: password
	port: port # for MySQL this is 3306
	host: host1 # usually localhost or 127.0.0.1
server2:
	user: user
	password: password
	port: port # for MySQL this is 3306
	host: host1 # usually localhost or 127.0.0.1
template: templates/simple-db-migrate.tmpl
type: all
include: all
nocomments: true
tablesToIgnore:
- table1
- table2
- table3
fieldsToIgnore:
	table1:
		- field1
		- field2
		- field3
	table4:
		- field1
		- field4

simple-db-migrate.tmpl

SQL_UP = u"""
{{ $up }}
"""
SQL_DOWN = u"""
{{ $down }}
"""

差异是如何实际工作的？

以下比较按照以下顺序运行

• 当比较多个表时：应运行所有比较
• 当仅比较一个表与另一个表时：仅运行架构和数据比较

总体比较

• 检查两个数据库是否存在且可访问，如果不存在，则抛出错误
• 然后比较源和目标数据库之间的数据库校对，并将任何差异记录下来以供输出

架构比较

• 检查列数、名称、类型、校对或属性之间是否有任何差异
• 在源中存在但在目标中找不到的新列将被添加

数据比较

• 然后对每个表，按顺序比较表存储类型（例如MyISAM、CSV）、校对（例如utf8_general_ci）和行数。如果存在任何差异，则记录下来再进行下一个测试
• 接下来，记录每个表中的更改行以及缺失的行

兼容迁移工具

如果您使用的是除以下列出的以外的其他迁移工具与DBDiff一起使用，请告诉我们，这样我们就可以添加它。

问题 & 支持 💭

• 如果您找不到自己的问题被解决，请创建一个新问题
• 请关注这个空间，因为我们正在为DBDiff社区创建一个论坛

• 到目前为止的文档就是您在这个页面上看到的，但这个文档会逐渐扩展到它自己的网站

• 如果您是公司或组织，对DBDiff感兴趣的商业支持包，请联系我们

支持者 💕

Sean McNamara

在Patreon上支持DBDiff并在这里显著展示您的名字或标志！

贡献 💞

在发起拉取请求之前，请务必阅读贡献指南。

感谢所有为DBDiff做出贡献的人！

反馈 💬

如果你看到了这里，你可能是个粉丝 😉

请您抽出2分钟时间，对我们关于DBDiff的反馈给予支持。

https://forms.gle/gjdJxZxdVsz7BRxg7

我们阅读每一份通过的建议。

许可证

MIT

由：heart: