moln/php-mysql-replication

MySQL复制协议的纯PHP实现。这允许您接收像插入、更新、删除这样的事件及其数据和原始SQL查询。

1.3.0 2024-01-19 05:07 UTC

This package is auto-updated.

Last update: 2024-09-19 07:01:08 UTC


README

PHP Tests Latest Stable Version Total Downloads License Scrutinizer Code Quality Coverage Status

MySQL复制协议的纯PHP实现。这允许您接收像插入、更新、删除这样的事件及其数据和原始SQL查询。

基于以下创作者的杰出作品:https://github.com/noplay/python-mysql-replicationhttps://github.com/fengxiangyun/mysql-replication

注意:解决这些问题

  • DatabasesOnlyTablesOnlyConfig 添加正则表达式匹配支持。
    (new ConfigBuilder())->withTablesOnly(['log_\d+'])->build(); // Table `log_20240101`
  • 解决 krowinski/php-mysql-replication#94,将静态配置属性更改为非静态。
  • 添加重试功能。
    (new ConfigBuilder())
      ->withRetry(-1) // Retry always.
      ->withRetry(0)  // Disable retry feature. (Default)
      ->withRetry(2)  // Retry twice.
  • 支持PHP 8.1,8.2。

安装

在您的项目中

composer require moln/php-mysql-replication

或独立

git clone https://github.com/moln/php-mysql-replication.git

composer install -o

兼容性(基于集成测试)

  • mysql 5.5
  • mysql 5.6
  • mysql 5.7
  • mysql 8.0(仅限mysql_native_password)
  • mariadb 5.5
  • mariadb 10.0
  • mariadb 10.1
  • 可能基于原生mysql的percona版本

MySQL服务器设置

在您的MySQL服务器配置文件中,您需要启用复制

[mysqld]
server-id        = 1
log_bin          = /var/log/mysql/mysql-bin.log
expire_logs_days = 10
max_binlog_size  = 100M
binlog-format    = row #Very important if you want to receive write, update and delete row events

MySQL复制事件解释 https://dev.mysqlserver.cn/doc/internals/en/event-meanings.html

MySQL用户权限

GRANT REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'user'@'host';

GRANT SELECT ON `dbName`.* TO 'user'@'host';

配置

使用 ConfigBuilder 或 ConfigFactory 创建配置。可用的选项

'user' -您的MySQL用户(必需)

'ip' 或 'host' -您的MySQL主机/ip(必需)

'password' -您的MySQL密码(必需)

'port' -您的MySQL主机端口(默认 3306)

'charset' -数据库连接字符集(默认 utf8)

'gtid' -从哪个GTID标记开始(格式 9b1c8d18-2a76-11e5-a26b-000c2976f3f3:1-177592)

'mariaDbGtid' -从哪个MariaDB GTID标记开始(格式 1-1-3,0-1-88)

'slaveId' -脚本的从属ID用于识别(SHOW SLAVE HOSTS)

'binLogFileName' -从哪个bin日志文件开始

'binLogPosition' -从哪个bin日志位置开始

'eventsOnly' -要监听的事件数组(完整列表在 ConstEventType.php 文件中)

'eventsIgnore' -要忽略的事件数组(完整列表在 ConstEventType.php 文件中)

'tablesOnly' -仅监听给定表的数组(默认所有表)

'databasesOnly' -仅监听给定数据库的数组(默认所有数据库)

'tableCacheSize' -一些数据从信息模式中收集,这些数据被缓存。

'custom' -如果必须在扩展/实现的自己的类中设置一些参数

'heartbeatPeriod' -设置复制心跳之间的秒间隔。每当主服务器的二进制日志通过事件更新时,下一个心跳的等待期都会重置。间隔是一个范围在0到4294967秒之间的十进制值,分辨率为毫秒;最小非零值是0.001。只有在二进制日志文件中超过间隔的时间没有未发送的事件时,主服务器才会发送心跳。

类似项目

Ruby: https://github.com/y310/kodama

Java: https://github.com/shyiko/mysql-binlog-connector-java

GO: https://github.com/siddontang/go-mysql

Python: https://github.com/noplay/python-mysql-replication

.NET: https://github.com/rusuly/MySqlCdc

示例

所有示例都可在示例目录中找到

此示例将所有复制事件输出到控制台

请记得更改配置以适应您的用户、主机和密码。

用户应具有复制权限 [ REPLICATION CLIENT, SELECT]

php example/dump_events.php

用于测试SQL事件

CREATE DATABASE php_mysql_replication;
use php_mysql_replication;
CREATE TABLE test4 (id int NOT NULL AUTO_INCREMENT, data VARCHAR(255), data2 VARCHAR(255), PRIMARY KEY(id));
INSERT INTO test4 (data,data2) VALUES ("Hello", "World");
UPDATE test4 SET data = "World", data2="Hello" WHERE id = 1;
DELETE FROM test4 WHERE id = 1;

输出将类似于以下内容(取决于示例的配置,例如GTID开/关)

=== Event format description ===
Date: 2017-07-06T13:31:11+00:00
Log position: 0
Event size: 116
Memory usage 2.4 MB

=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803092
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13675
Memory usage 2.42 MB

=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803237
Event size: 145
Database: php_mysql_replication
Execution time: 0
Query: CREATE DATABASE php_mysql_replication
Memory usage 2.45 MB

=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803285
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13676
Memory usage 2.45 MB

=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803500
Event size: 215
Database: php_mysql_replication
Execution time: 0
Query: CREATE TABLE test4 (id int NOT NULL AUTO_INCREMENT, data VARCHAR(255), data2 VARCHAR(255), PRIMARY KEY(id))
Memory usage 2.45 MB

=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803548
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13677
Memory usage 2.45 MB

=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803637
Event size: 89
Database: php_mysql_replication
Execution time: 0
Query: BEGIN
Memory usage 2.45 MB

=== Event tableMap ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803708
Event size: 71
Table: test4
Database: php_mysql_replication
Table Id: 866
Columns amount: 3
Memory usage 2.71 MB

=== Event write ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803762
Event size: 54
Table: test4
Affected columns: 3
Changed rows: 1
Values: Array
(
    [0] => Array
        (
            [id] => 1
            [data] => Hello
            [data2] => World
        )

)

Memory usage 2.74 MB

=== Event xid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803793
Event size: 31
Transaction ID: 662802
Memory usage 2.75 MB

=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803841
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13678
Memory usage 2.75 MB

=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803930
Event size: 89
Database: php_mysql_replication
Execution time: 0
Query: BEGIN
Memory usage 2.76 MB

=== Event tableMap ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804001
Event size: 71
Table: test4
Database: php_mysql_replication
Table Id: 866
Columns amount: 3
Memory usage 2.75 MB

=== Event update ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804075
Event size: 74
Table: test4
Affected columns: 3
Changed rows: 1
Values: Array
(
    [0] => Array
        (
            [before] => Array
                (
                    [id] => 1
                    [data] => Hello
                    [data2] => World
                )

            [after] => Array
                (
                    [id] => 1
                    [data] => World
                    [data2] => Hello
                )

        )

)

Memory usage 2.76 MB

=== Event xid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804106
Event size: 31
Transaction ID: 662803
Memory usage 2.76 MB

=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804154
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13679
Memory usage 2.76 MB

=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804243
Event size: 89
Database: php_mysql_replication
Execution time: 0
Query: BEGIN
Memory usage 2.76 MB

=== Event tableMap ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804314
Event size: 71
Table: test4
Database: php_mysql_replication
Table Id: 866
Columns amount: 3
Memory usage 2.76 MB

=== Event delete ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804368
Event size: 54
Table: test4
Affected columns: 3
Changed rows: 1
Values: Array
(
    [0] => Array
        (
            [id] => 1
            [data] => World
            [data2] => Hello
        )

)

Memory usage 2.77 MB

=== Event xid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804399
Event size: 31
Transaction ID: 662804
Memory usage 2.77 MB

基准测试

在虚拟机上进行测试

Debian 8.7
PHP 5.6.30
Percona 5.6.35
inxi
CPU(s)~4 Single core Intel Core i5-2500Ks (-SMP-) clocked at 5901 Mhz Kernel~3.16.0-4-amd64 x86_64 Up~1 day Mem~1340.3/1996.9MB HDD~41.9GB(27.7% used) Procs~122 Client~Shell inxi~2.1.28
php example/benchmark.php
Start insert data
7442 event by seconds (1000 total)
7679 event by seconds (2000 total)
7914 event by seconds (3000 total)
7904 event by seconds (4000 total)
7965 event by seconds (5000 total)
8006 event by seconds (6000 total)
8048 event by seconds (7000 total)
8038 event by seconds (8000 total)
8040 event by seconds (9000 total)
8055 event by seconds (10000 total)
8058 event by seconds (11000 total)
8071 event by seconds (12000 total)

常见问题解答

  1. 何时以及为什么需要php-mysql-replication?

首先,MySQL不提供异步调用。您通常需要在应用程序中编程此功能(通过事件调度并将它们添加到某些队列系统中,如果您的数据库有多个入口点,如Web、后端或其他微服务,则将处理添加到所有这些可能并不便宜。但使用MySQL复制协议,您可以监听写事件并异步处理它们(最佳组合是将项目添加到某些队列系统,如RabbitMQ、Redis或Kafka)。此外,在无效缓存、搜索引擎复制、实时分析和审计中。

  1. 它很棒!但有什么问题吗?

首先,您需要了解可能会通过大量事件,例如,如果您在“bar”表中更新了1,000,000条记录,并且您需要从“foo”表中的这一条插入,则所有这些都必须通过脚本处理,并且您需要等待数据。这是正常的,这就是它的工作方式。您可以通过配置选项来加快速度。此外,如果脚本崩溃,您需要定期保存binlog(或gtid)的位置,以便在再次运行此脚本时从这个位置开始,以避免重复。

  1. 我需要处理1,000,000条记录,这需要很长时间!!

正如我在第1点中提到的,使用队列系统如RabbitMQ、Redis或Kafka,它们将使您能够使用多个脚本处理数据。

  1. 我遇到问题了吗?您的脚本缺少某些内容!我发现了一个错误!

创建一个问题,我会在空闲时间尝试解决这个问题:)

  1. 它对MySQL服务器造成多少开销?

它像其他任何MySQL从机模式一样工作,并产生相同的开销。

  1. 套接字超时错误

为了解决这个问题,最好是增加数据库配置"net_read_timeout"和"net_write_timeout"到3600。(感谢Bijimon)

  1. 部分更新修复

在my.conf中设置binlog_row_image=full以修复只接收部分更新的问题。

  1. 连接到副本服务器时没有复制事件

在my.conf中设置log_slave_updates=on以修复此问题(#71)(#66)