2.27. Actions with Snapshot
Use cases:
| Action | Description |
|---|---|
| Execute | Start the snapshot process. This process does not block the table being snapshotted, and the streaming flow keeps running. Effects: - Snapshot status changes to In-progress - The Kafka topic starts receiving data from the snapshot - The connector and tasks keep operating normally When to use: - When you want to snapshot all of the database's current data into a Kafka topic - When you need to load the initial data for the system - When you want to re-run the snapshot after it has Completed or Failed |
| Pause | Pause the incremental snapshot. Once this signal is received, the connector will pause the snapshot operation currently in progress. All data collection will stop at the moment the pause signal is received. Effects: - Snapshot status changes to Paused - The Kafka topic stops receiving data from the snapshot - The snapshot progress is saved and can be Resumed to continue - The connector and tasks keep operating normally When to use: - When you need to pause the snapshot during peak hours to avoid impacting performance - When system maintenance or temporary troubleshooting is needed |
| Resume | Continue a previously paused incremental snapshot. Once this signal is received, the connector will resume the snapshot operation that was paused earlier. Effects: - Snapshot status changes to In-progress - The Kafka topic resumes receiving data from where it was paused - The snapshot keeps running until it is complete When to use: - After pausing, when you want to continue the snapshot - When the system has stabilized and the snapshot processing can continue |
| Stop | Stop and cancel the currently running ad hoc snapshot. The entire current snapshot process will be cancelled. Effects: - Snapshot status changes to Completed - The Kafka topic immediately stops receiving data from the snapshot - The snapshot process is cancelled; you need to Execute again from the start if you want to run the snapshot When to use: - When the snapshot is no longer needed - When an error is detected during the snapshot and you want to stop it immediately - When you need to free up system resources |