Skip to content

Commit ed7987a

Browse files
authored
Update README.md
Added warning about some migrations unhandled
1 parent ee7c5fa commit ed7987a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ With a focus on high performance, it utilizes batching heavily and uses C++ exte
4040

4141
- **Real-Time Replication**: Keeps your ClickHouse database in sync with MySQL in real-time.
4242
- **High Performance**: Utilizes batching and ports slow parts to C++ (e.g., MySQL internal JSON parsing) for optimal performance (±20K events / second on a single core).
43-
- **Supports Migrations/Schema Changes**: Handles adding, altering, and removing tables without breaking the replication process.
43+
- **Supports Migrations/Schema Changes**: Handles adding, altering, and removing tables without breaking the replication process (*for most cases, [details here](https://github.com/bakwc/mysql_ch_replicator#migrations--schema-changes)).
4444
- **Recovery without Downtime**: Allows for preserving old data while performing initial replication, ensuring continuous operation.
4545
- **Correct Data Removal**: Unlike MaterializedMySQL, `mysql_ch_replicator` ensures physical removal of data.
4646
- **Comprehensive Data Type Support**: Accurately replicates most data types, including JSON, booleans, and more. Easily extensible for additional data types.
@@ -266,6 +266,11 @@ tables: ['table_1', 'table_2*']
266266
- **Altering Tables**: Adjusts replication strategy based on schema changes.
267267
- **Removing Tables**: Handles removal of tables without disrupting the replication process.
268268

269+
**WARNING**. While 95% of operations supported, there could be still some unhandled operations. We try to support all of them, but for your safety, please write the CI/CD test that will check your migrations. Test should work a following way:
270+
- Aplly all your mysql migrations
271+
- Try to insert some record into mysql (to any table)
272+
- Check that this record appears in ClickHouse
273+
269274
#### Recovery Without Downtime
270275

271276
In case of a failure or during the initial replication, `mysql_ch_replicator` will preserve old data and continue syncing new data seamlessly. You could remove the state and restart replication from scratch.

0 commit comments

Comments
 (0)