PHPackages krowinski/php-mysql-replication - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. krowinski/php-mysql-replication ActiveLibrary[Database & ORM](/categories/database) krowinski/php-mysql-replication =============================== Pure PHP Implementation of MySQL replication protocol. This allow you to receive event like insert, update, delete with their data and raw SQL queries. v9.0.0(10mo ago)343127.2k↓20.5%109[1 issues](https://github.com/krowinski/php-mysql-replication/issues)[1 PRs](https://github.com/krowinski/php-mysql-replication/pulls)10MITPHPPHP >=8.2CI passing Since Feb 18Pushed yesterday19 watchersCompare [ Source](https://github.com/krowinski/php-mysql-replication)[ Packagist](https://packagist.org/packages/krowinski/php-mysql-replication)[ RSS](/packages/krowinski-php-mysql-replication/feed)WikiDiscussions master Synced 3w ago READMEChangelog (10)Dependencies (10)Versions (50)Used By (10) [![php-mysql-replication logo](logo.png)](logo.png) php-mysql-replication ===================== [](#php-mysql-replication) Pure PHP implementation of the MySQL replication protocol β€” stream `insert`, `update` and `delete` events (with data and raw SQL) straight from the binlog. [![Latest Stable Version](https://camo.githubusercontent.com/f2f106d5679e8cfd14bb60558716eefffe70166ebb7fa1a91e35ddafca1396e0/68747470733a2f2f706f7365722e707567782e6f72672f6b726f77696e736b692f7068702d6d7973716c2d7265706c69636174696f6e2f762f737461626c65)](https://packagist.org/packages/krowinski/php-mysql-replication) [![Total Downloads](https://camo.githubusercontent.com/e56497cc1f9d0c4f8855f750a6f6f40ff67b3a71914d6aa53d91398397204696/68747470733a2f2f706f7365722e707567782e6f72672f6b726f77696e736b692f7068702d6d7973716c2d7265706c69636174696f6e2f646f776e6c6f616473)](https://packagist.org/packages/krowinski/php-mysql-replication) [![Latest Unstable Version](https://camo.githubusercontent.com/b52541213aff639e860e0aab5b633ac91a436f416d76c6d1362c0529025d5317/68747470733a2f2f706f7365722e707567782e6f72672f6b726f77696e736b692f7068702d6d7973716c2d7265706c69636174696f6e2f762f756e737461626c65)](https://packagist.org/packages/krowinski/php-mysql-replication) Based on the great work of and . --- πŸ“– Table of contents ------------------- [](#-table-of-contents) - [Installation](#-installation) - [Compatibility](#-compatibility-based-on-integration-tests) - [MySQL server settings](#-mysql-server-settings) - [Configuration](#-configuration) - [Examples](#-examples) - [Benchmarks](#-benchmarks) - [Similar projects](#-similar-projects) - [FAQ](#-faq) πŸš€ Installation -------------- [](#-installation) In your project: ``` composer require krowinski/php-mysql-replication ``` or standalone: ``` git clone https://github.com/krowinski/php-mysql-replication.git composer install -o ``` βœ… Compatibility (based on integration tests) -------------------------------------------- [](#-compatibility-based-on-integration-tests) **PHP** - php 8.2 - php 8.3 - php 8.4 - php 8.5 **MySQL** - mysql 5.5 - mysql 5.6 - mysql 5.7 - mysql 8.0 (`mysql_native_password` and `caching_sha2_password` supported) - mariadb 5.5 - mariadb 10.0 - mariadb 10.1 - probably percona versions as it's based on native mysql βš™οΈ MySQL server settings ------------------------ [](#️-mysql-server-settings) In your MySQL server configuration file you need to enable replication: ``` [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 replication events explained: MySQL user privileges: ``` GRANT REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'user'@'host'; GRANT SELECT ON `dbName`.* TO 'user'@'host'; ``` πŸ”§ Configuration --------------- [](#-configuration) Use `ConfigBuilder` or `ConfigFactory` to create configuration. OptionDescription`user`your mysql user (**mandatory**)`ip` / `host`your mysql host/ip (**mandatory**)`password`your mysql password (**mandatory**)`port`your mysql host port (default `3306`)`charset`db connection charset (default `utf8`)`gtid`GTID marker(s) to start from (format `9b1c8d18-2a76-11e5-a26b-000c2976f3f3:1-177592`)`mariaDbGtid`MariaDB GTID marker(s) to start from (format `1-1-3,0-1-88`)`slaveId`script slave id for identification (default `666`) (`SHOW SLAVE HOSTS`)`binLogFileName`bin log file name to start from`binLogPosition`bin log position to start from`eventsOnly`array to only listen on given events (full list in [ConstEventType.php](https://github.com/krowinski/php-mysql-replication/blob/master/src/MySQLReplication/Definitions/ConstEventType.php))`eventsIgnore`array of events to ignore (full list in [ConstEventType.php](https://github.com/krowinski/php-mysql-replication/blob/master/src/MySQLReplication/Definitions/ConstEventType.php))`tablesOnly`array to only listen on given tables (default all tables)`databasesOnly`array to only listen on given databases (default all databases)`tablesIgnore`array of tables to ignore (default none)`databasesIgnore`array of databases to ignore (default none)`tablesRegex`array of regex patterns to only listen on matching tables (default all tables)`databasesRegex`array of regex patterns to only listen on matching databases (default all databases)`tableCacheSize`some data is collected from the information schema; this data is cached`custom`if some params must be set in extended/implemented own classes`heartbeatPeriod`interval in seconds between replication heartbeats. Whenever the master's binary log is updated with an event, the waiting period for the next heartbeat is reset. Range `0`–`4294967` seconds with millisecond resolution (smallest nonzero value `0.001`). Heartbeats are sent by the master only if there are no unsent events in the binary log for longer than this interval`slaveUuid`sets slave uuid for identification (default `0015d2b6-8a06-4e5e-8c07-206ef3fbd274`)`gtidAutoPosition`enables GTID auto positioning, letting the master decide where to start streaming from based on the GTID set already processed (default `false`)`semiSync`opt in to semi-sync replication. If the master doesn't have `rpl_semi_sync_master_enabled`/`rpl_semi_sync_source_enabled` = `ON`, this is silently ignored and the connection falls back to async replication (default `false`)`useTableMapMetadata`read column names/unsigned flags/ENUM-SET literals/primary key from the `TABLE_MAP_EVENT`'s optional metadata (requires `binlog_row_metadata=FULL` on the server), avoiding an `information_schema` query per table. Falls back to `information_schema` when that metadata isn't present. Set to `false` to always use `information_schema`, e.g. if you need `COLLATION_NAME`/`CHARACTER_SET_NAME`/`COLUMN_COMMENT` (default `true`)πŸ’‘ Examples ---------- [](#-examples) All examples are available in the [examples directory](https://github.com/krowinski/php-mysql-replication/tree/master/example). This example will dump all replication events to the console. > Remember to change the config for your user, host and password. The user should have replication privileges \[`REPLICATION CLIENT`, `SELECT`\]. ``` php example/dump_events.php ``` Test SQL events: ``` 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; ``` Output (depends on configuration, e.g. GTID off/on) β€” click to expand``` === 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 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 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 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 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 ``` πŸ“Š Benchmarks ------------ [](#-benchmarks) Tested on VM: ``` 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) ``` 🌍 Similar projects ------------------ [](#-similar-projects) LanguageProjectRubyJavaGoPython.NET❓ FAQ ----- [](#-faq) **1. Why and when do I need php-mysql-replication?** MySQL doesn't give you async calls out of the box. You'd usually need to build this yourself (event dispatching, adding to a queue system), and if your DB has many points of entry β€” web, backend, other microservices β€” it's not always cheap to add processing to all of them. Using the MySQL replication protocol, you can listen on write events and process them asynchronously (the best combo is to push items into a queue system like RabbitMQ, Redis or Kafka). Also useful for cache invalidation, search engine replication, real-time analytics and audits. **2. It's awesome! But what's the catch?** A lot of events may come through β€” e.g. if you update 1,000,000 records in table "bar" and need the one insert from table "foo", everything must be processed by the script first, and you'll need to wait for your data. This is normal and how it works. You can speed things up using [config options](#-configuration). Also, if the script crashes, you need to periodically save the binlog position (or GTID) so you can resume from it and avoid duplicates. **3. I need to process 1,000,000 records and it's taking forever!** As mentioned in point 1, use a queue system like RabbitMQ, Redis or Kafka β€” they let you process data across multiple scripts. **4. I have a problem / your script is missing something / I found a bug!** Create an [issue](https://github.com/krowinski/php-mysql-replication/issues) and I'll try to work on it in my free time :) **5. How much overhead does this give the MySQL server?** It works like any other MySQL slave and gives the same overhead. **6. Socket timeouts error** Best fix is to increase the DB configuration `net_read_timeout` and `net_write_timeout` to `3600`. (tx Bijimon) **7. Partial updates fix** Set `binlog_row_image=full` in `my.cnf` to fix receiving only partial updates. **8. No replication events when connected to a replica server** Set `log_slave_updates=on` in `my.cnf` to fix this (#71)(#66). **9. "Big" updates / inserts** The default MySQL setting generates one big blob stream, which requires more RAM/CPU. You can change this to a smaller stream using the [`binlog_row_event_max_size`](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_event_max_size) variable to split into smaller chunks. ### Health Score 69 β€” FairBetter than 100% of packages Maintenance80 Actively maintained with recent releases Popularity54 Moderate usage in the ecosystem Community40 Growing community involvement Maturity89 Battle-tested with a long release history Bus Factor1 Top contributor holds 76.6% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~77 days Recently: every ~413 days Total 46 Last Release 310d ago Major Versions v4.0.0 β†’ v5.0.02018-04-27 v5.0.6 β†’ v6.0.02019-07-08 v6.2.4 β†’ v7.0.02021-01-25 v7.0.1 β†’ v8.0.02024-01-30 v8.1.0 β†’ v9.0.02025-09-17 PHP version history (6 changes)0.1PHP >=5.4 v2.0.0PHP >=5.5.9 v4.0.0PHP >=5.6 v6.0.0PHP >=7.1 v7.0.0PHP >=7.3 v8.0.0PHP >=8.2 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1478555?v=4)[Kacper RowiΕ„ski](/maintainers/krowinski)[@krowinski](https://github.com/krowinski) --- Top Contributors [![krowinski](https://avatars.githubusercontent.com/u/1478555?v=4)](https://github.com/krowinski "krowinski (259 commits)")[![fengxiangyun](https://avatars.githubusercontent.com/u/5093864?v=4)](https://github.com/fengxiangyun "fengxiangyun (35 commits)")[![kobi97](https://avatars.githubusercontent.com/u/3581089?v=4)](https://github.com/kobi97 "kobi97 (8 commits)")[![DZunke](https://avatars.githubusercontent.com/u/1244235?v=4)](https://github.com/DZunke "DZunke (5 commits)")[![DZunke-Quentic](https://avatars.githubusercontent.com/u/261378322?v=4)](https://github.com/DZunke-Quentic "DZunke-Quentic (5 commits)")[![misaert](https://avatars.githubusercontent.com/u/12974251?v=4)](https://github.com/misaert "misaert (3 commits)")[![wolaiye1010](https://avatars.githubusercontent.com/u/15831945?v=4)](https://github.com/wolaiye1010 "wolaiye1010 (2 commits)")[![cyppe](https://avatars.githubusercontent.com/u/591720?v=4)](https://github.com/cyppe "cyppe (2 commits)")[![hufman](https://avatars.githubusercontent.com/u/1592375?v=4)](https://github.com/hufman "hufman (2 commits)")[![janpalacky](https://avatars.githubusercontent.com/u/7532973?v=4)](https://github.com/janpalacky "janpalacky (2 commits)")[![limingxinleo](https://avatars.githubusercontent.com/u/16648551?v=4)](https://github.com/limingxinleo "limingxinleo (2 commits)")[![Stern87](https://avatars.githubusercontent.com/u/13180074?v=4)](https://github.com/Stern87 "Stern87 (1 commits)")[![esler](https://avatars.githubusercontent.com/u/2031969?v=4)](https://github.com/esler "esler (1 commits)")[![dominiquegerber](https://avatars.githubusercontent.com/u/18481454?v=4)](https://github.com/dominiquegerber "dominiquegerber (1 commits)")[![ale-blanco](https://avatars.githubusercontent.com/u/8843463?v=4)](https://github.com/ale-blanco "ale-blanco (1 commits)")[![matyx](https://avatars.githubusercontent.com/u/7956225?v=4)](https://github.com/matyx "matyx (1 commits)")[![maxxer](https://avatars.githubusercontent.com/u/240201?v=4)](https://github.com/maxxer "maxxer (1 commits)")[![m-h-1](https://avatars.githubusercontent.com/u/60962650?v=4)](https://github.com/m-h-1 "m-h-1 (1 commits)")[![cgrabenstein](https://avatars.githubusercontent.com/u/6358948?v=4)](https://github.com/cgrabenstein "cgrabenstein (1 commits)")[![mklepaczewski](https://avatars.githubusercontent.com/u/1395675?v=4)](https://github.com/mklepaczewski "mklepaczewski (1 commits)") --- Tags binlogcomposer-packageseventsgtidmysqlmysql-binlogmysql-replicationmysql-replication-protocolphpphp-libraryphp-mysql-replicationreplicationreplication-eventsmysqlPHP Libraryreplicationbinlogmysql-replicationmysql-binlogmysql-replication-protocol ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StyleECS Type Coverage Yes ### Embed Badge ![Health badge](/badges/krowinski-php-mysql-replication/health.svg) ``` [![Health](https://phpackages.com/badges/krowinski-php-mysql-replication/health.svg)](https://phpackages.com/packages/krowinski-php-mysql-replication) ``` ### Alternatives [flow-php/flow PHP ETL - Extract Transform Load - Data processing framework 85036.3k](/packages/flow-php-flow)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k5.9M754](/packages/sylius-sylius)[oro/platform Business Application Platform (BAP) 645143.5k116](/packages/oro-platform)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M600](/packages/shopware-core)[matomo/matomo Matomo is the leading Free/Libre open analytics platform 21.7k38.9k](/packages/matomo-matomo)[shopware/platform The Shopware e-commerce core 3.4k1.5M3](/packages/shopware-platform) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)