Skip to content

Commit 4b0cf84

Browse files
authored
Update README.md
1 parent 0e73925 commit 4b0cf84

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ With a focus on high performance, it utilizes batching heavily and uses C++ exte
3030
- [Advanced Features](#advanced-features)
3131
- [Migrations & Schema Changes](#migrations--schema-changes)
3232
- [Recovery Without Downtime](#recovery-without-downtime)
33+
- [Known Limitations](#known-limitations)
3334
- [Production usage](#production-usage)
3435
- [Development](#development)
3536
- [Running Tests](#running-tests)
@@ -296,7 +297,7 @@ tables: ['table_1', 'table_2*']
296297
- Try to insert some record into mysql (to any table)
297298
- Check that this record appears in ClickHouse
298299

299-
**Known Limitations**
300+
#### Known Limitations
300301
1. Migrations not supported during initial replication. You should either wait for initial replication finish and then apply migrations, or restart initial replication from scratch (by removing state file).
301302
2. Primary key changes not supported. This is a ClickHouse level limitation, it does not allow to make any changes realted to primary key.
302303
3. Tables without a primary key are not supported.
@@ -313,6 +314,7 @@ Here is the checklist for production. Please read it carefully and confirm every
313314

314315
- [ ] No manual changes are made directly to ClickHouse databases or tables. All modifications (indexes, table settings, etc.) must be applied as overrides in the `mysql_ch_replicator` `config.yaml`.
315316
- [ ] All MySQL migrations undergo either CI/CD or manual testing before deployment. No migration is applied to production without being tested. The tests verify that replication continues to work correctly and that new records are successfully replicated from MySQL to ClickHouse after the migration.
317+
- [ ] Read and acknowledged [known limitations](#known-limitations).
316318

317319
## Development
318320

0 commit comments

Comments
 (0)