DB Pipes: Docs on sync control, resync, initial load and more #4037
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
heavycrystal
reviewed
Jul 8, 2025
| ### Pull batch size {#pull-batch-size} | ||
| The pull batch size is the number of records that the ClickPipe will pull from the source database in one batch. Records mean inserts, updates and deletes done on the tables that are part of the pipe. | ||
|
|
||
| The default is **100,000** records. |
There was a problem hiding this comment.
Call out a safe maximum, ~10 million for now
| The MySQL ClickPipe uses a column on your source table to logically partition the source tables. This column is called the **partition key column**. It is used to divide the source table into partitions, which can then be processed in parallel by the ClickPipe. | ||
|
|
||
| :::warning | ||
| The partition key column must be indexed in the source table to see a good performance boost. |
There was a problem hiding this comment.
Is it possible to validate for an index on the partition column?
| <img src={snapshot_params} alt="Snapshot parameters" /> | ||
|
|
||
| #### Snapshot number of rows per partition {#snapshot-number-of-rows-per-partition} | ||
| This setting controls how many rows constitute a partition. The ClickPipe will read the source table in chunks of this size, and each chunk will be processed in parallel. The default value is 100,000 rows per partition. |
There was a problem hiding this comment.
nit: remove "each" as it can give the impression of all chunks processing at once
"chunks will be processed in parallel"
| ### Monitoring parallel snapshot in Postgres {#monitoring-parallel-snapshot-in-postgres} | ||
| You can analyze **pg_stat_activity** to see the parallel snapshot in action. The ClickPipe will create multiple connections to the source database, each reading a different partition of the source table. If you see **FETCH** queries with different CTID ranges, it means that the ClickPipe is reading the source tables. You can also see the COUNT(*) and the partitioning query in here. | ||
|
|
||
| ### Limitations {#limitations} |
There was a problem hiding this comment.
Call out compressed hypertables here mayhaps?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds more documentation around DB pipes
Checklist