Skip to content

Commit 7e4904f

Browse files
committed
config explained
1 parent c3f783d commit 7e4904f

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ composer require php-mysql-replication
1515
```
1616

1717
MySQL server settings
18-
=========================
18+
=========
1919

2020
In your MySQL server configuration file you need to enable replication:
2121

@@ -26,6 +26,40 @@ In your MySQL server configuration file you need to enable replication:
2626
max_binlog_size = 100M
2727
binlog-format = row #Very important if you want to receive write, update and delete row events
2828

29+
Configuration
30+
=========
31+
32+
You can pass this params to ConfigService->makeConfigFromArray([])
33+
34+
'user' - your mysql user (mandatory)
35+
36+
'ip' - your mysql host ip (mandatory)
37+
38+
'password' - your mysql password (mandatory)
39+
40+
'port' - your mysql host port
41+
42+
'dbName' - db name you want to listen
43+
44+
'charset' - db connection charset
45+
46+
'gtid' - GTID marker(s) to start from (format 9b1c8d18-2a76-11e5-a26b-000c2976f3f3:1-177592)
47+
48+
'slaveId' - script slave id for identification
49+
50+
'binLogFileName' - bin log file name to start from
51+
52+
'binLogPosition' - bin log position to start from
53+
54+
'eventsOnly' - array to listen on events (full list in [ConstEventType.php](https://github.com/krowinski/php-mysql-replication/blob/master/src/MySQLReplication/Definitions/ConstEventType.php) file)
55+
56+
'eventsIgnore' - array yo ignore events (full list in [ConstEventType.php](https://github.com/krowinski/php-mysql-replication/blob/master/src/MySQLReplication/Definitions/ConstEventType.php) file)
57+
58+
'tablesOnly' - array to only listen on given tables
59+
60+
'databasesOnly' - array to only listen on given databases
61+
62+
2963
Examples
3064
=========
3165

0 commit comments

Comments
 (0)