Skip to content

Commit bf11be2

Browse files
committed
Document the limitations around MySQL snapshot schema changes
1 parent 9db3c8d commit bf11be2

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

docs/integrations/data-ingestion/clickpipes/mysql/schema-changes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ ClickPipes for MySQL can detect schema changes in the source tables and, in some
1919
| Adding a new column with a default value (`ALTER TABLE ADD COLUMN ... DEFAULT ...`) | Propagated automatically. The new columns will be populated for all rows replicated after the schema change, but existing rows won't show the default value without a full table refresh |
2020
| Dropping an existing column (`ALTER TABLE DROP COLUMN ...`) | Detected, but **not** propagated. The dropped columns will be populated with `NULL` for all rows replicated after the schema change |
2121

22+
:::note
23+
Column additions during snapshot are currently not supported. The suggested workaround is to perform snapshots before or after planned schema changes, or, if the ClickPipe is already failing, to manually add a column of the appropriate type to the destination table.
24+
:::
25+
2226
### MySQL 5.x limitations {#mysql-5-limitations}
2327

2428
MySQL versions older than [8.0.1](https://dev.mysql.com/blog-archive/more-metadata-is-written-into-binary-log/) do not include full column metadata in the binlog (`binlog_row_metadata=FULL`), so ClickPipes tracks columns by ordinal position. This means:

0 commit comments

Comments
 (0)