Skip to content

Commit 4938d6c

Browse files
committed
Updated README, added requirements and http endpoint
1 parent ab4cfcd commit 4938d6c

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ With a focus on high performance, it utilizes batching heavily and uses C++ exte
2626
- **Multi-Database Handling**: Replicates the binary log once for all databases, optimizing the process compared to `MaterializedMySQL`, which replicates the log separately for each database.
2727

2828
## Installation
29+
### Requirements
30+
- Linux / MacOS
31+
- python3.9 or higher
32+
33+
### Installation
2934

3035
To install `mysql_ch_replicator`, use the following command:
3136

@@ -162,6 +167,9 @@ indexes: # optional
162167
tables: ['test_table']
163168
index: 'INDEX name_idx name TYPE ngrambf_v1(5, 65536, 4, 0) GRANULARITY 1'
164169

170+
http_host: '0.0.0.0' # optional
171+
http_port: 9128 # optional
172+
165173
```
166174
167175
#### Required settings
@@ -179,6 +187,7 @@ indexes: # optional
179187
- `optimize_interval` - interval (seconds) between automatic `OPTIMIZE table FINAL` calls. Default 86400 (1 day). This is required to perform all merges guaranteed and avoid increasing of used storage and decreasing performance.
180188
- `auto_restart_interval` - interval (seconds) between automatic db_replicator restart. Default 3600 (1 hour). This is done to reduce memory usage.
181189
- `indexes` - you may want to add some indexes to accelerate performance, eg. ngram index for full-test search, etc. To apply indexes you need to start replication from scratch.
190+
- `http_host`, `http_port` - http endpoint to control replication, use `/docs` for abailable commands
182191

183192
Few more tables / dbs examples:
184193

0 commit comments

Comments
 (0)