DBZ-4727 Document pause and resume incremental snapshot
This commit is contained in:
parent
2c505c08f5
commit
d39e98fc9f
@ -155,6 +155,8 @@ You can use signaling to initiate the following actions:
|
|||||||
* xref:debezium-signaling-logging[Add messages to the log].
|
* xref:debezium-signaling-logging[Add messages to the log].
|
||||||
* xref:debezium-signaling-ad-hoc-snapshots[Trigger ad hoc snapshots].
|
* xref:debezium-signaling-ad-hoc-snapshots[Trigger ad hoc snapshots].
|
||||||
* xref:debezium-signaling-stop-ad-hoc-snapshots[Stop execution of an ad hoc snapshot].
|
* xref:debezium-signaling-stop-ad-hoc-snapshots[Stop execution of an ad hoc snapshot].
|
||||||
|
* xref:debezium-signaling-pause-incremental-snapshots[Pause incremental snapshots].
|
||||||
|
* xref:debezium-signaling-resume-incremental-snapshots[Resume incremenal snapshots].
|
||||||
|
|
||||||
Some signals are not compatible with all connectors.
|
Some signals are not compatible with all connectors.
|
||||||
|
|
||||||
@ -295,6 +297,75 @@ By capturing the initial state of the specified tables in chunks rather than in
|
|||||||
* If the incremental snapshot process is interrupted, it can be resumed from the point at which it stopped.
|
* If the incremental snapshot process is interrupted, it can be resumed from the point at which it stopped.
|
||||||
* You can initiate an incremental snapshot at any time.
|
* You can initiate an incremental snapshot at any time.
|
||||||
|
|
||||||
|
[id="debezium-signaling-pause-incremental-snapshots"]
|
||||||
|
==== Incremental snapshot pause signals
|
||||||
|
|
||||||
|
You can request a connector to pause an in-progress incremental snapshot by creating a signal table entry with the `pause-snapshot` signal type.
|
||||||
|
After processing the signal, the connector will stop pause current in-progress snapshot operation.
|
||||||
|
Therefor it's not possible to specify the data collection as the snapshot processing will be paused in position where it is in time of processing of the signal.
|
||||||
|
|
||||||
|
You can pause incremental snapshots for the following {prodname} connectors:
|
||||||
|
|
||||||
|
* Db2
|
||||||
|
ifdef::community[]
|
||||||
|
* MongoDB
|
||||||
|
endif::community[]
|
||||||
|
* MySQL
|
||||||
|
* Oracle
|
||||||
|
* PostgreSQL
|
||||||
|
* SQL Server
|
||||||
|
|
||||||
|
[id="debezium-signaling-example-of-a-pause-incremental-signal-record"]
|
||||||
|
.Example of a pause incremental snapshot signal record
|
||||||
|
[cols="1,9",options="header"]
|
||||||
|
|===
|
||||||
|
|Column | Value
|
||||||
|
|
||||||
|
|id
|
||||||
|
|`d139b9b7-7777-4547-917d-e1775ea61d41`
|
||||||
|
|
||||||
|
|type
|
||||||
|
|`pause-snapshot`
|
||||||
|
|
||||||
|
|===
|
||||||
|
|
||||||
|
You must specify the `type` of the signal.
|
||||||
|
The `data` field is ignored.
|
||||||
|
|
||||||
|
[id="debezium-signaling-resume-incremental-snapshots"]
|
||||||
|
==== Incremental snapshot resume signals
|
||||||
|
|
||||||
|
You can request a connector to resume a paused incremental snapshot by creating a signal table entry with the `resume-snapshot` signal type.
|
||||||
|
After processing the signal, the connector will resume previously paused snapshot operation.
|
||||||
|
|
||||||
|
You can resume incremental snapshots for the following {prodname} connectors:
|
||||||
|
|
||||||
|
* Db2
|
||||||
|
ifdef::community[]
|
||||||
|
* MongoDB
|
||||||
|
endif::community[]
|
||||||
|
* MySQL
|
||||||
|
* Oracle
|
||||||
|
* PostgreSQL
|
||||||
|
* SQL Server
|
||||||
|
|
||||||
|
[id="debezium-signaling-example-of-a-resume-incremental-signal-record"]
|
||||||
|
.Example of a resume incremental snapshot signal record
|
||||||
|
[cols="1,9",options="header"]
|
||||||
|
|===
|
||||||
|
|Column | Value
|
||||||
|
|
||||||
|
|id
|
||||||
|
|`d139b9b7-7777-4547-917d-e1775ea61d41`
|
||||||
|
|
||||||
|
|type
|
||||||
|
|`resume-snapshot`
|
||||||
|
|
||||||
|
|===
|
||||||
|
|
||||||
|
You must specify the `type` of the signal.
|
||||||
|
The `data` field is ignored.
|
||||||
|
|
||||||
For more information about incremental snapshots, see the _Snapshots_ topic in the documentation for your connector.
|
For more information about incremental snapshots, see the _Snapshots_ topic in the documentation for your connector.
|
||||||
|
|
||||||
.Additional resources
|
.Additional resources
|
||||||
|
@ -46,6 +46,10 @@ The following table lists the shapshot metrics that are available.
|
|||||||
|`boolean`
|
|`boolean`
|
||||||
|Whether the snapshot was started.
|
|Whether the snapshot was started.
|
||||||
|
|
||||||
|
|[[connectors-snaps-metric-snapshotpaused_{context}]]<<connectors-snaps-metric-snapshotpaused_{context}, `SnapshotPaused`>>
|
||||||
|
|`boolean`
|
||||||
|
|Whether the snapshot was paused.
|
||||||
|
|
||||||
|[[connectors-snaps-metric-snapshotaborted_{context}]]<<connectors-snaps-metric-snapshotaborted_{context}, `SnapshotAborted`>>
|
|[[connectors-snaps-metric-snapshotaborted_{context}]]<<connectors-snaps-metric-snapshotaborted_{context}, `SnapshotAborted`>>
|
||||||
|`boolean`
|
|`boolean`
|
||||||
|Whether the snapshot was aborted.
|
|Whether the snapshot was aborted.
|
||||||
@ -56,7 +60,11 @@ The following table lists the shapshot metrics that are available.
|
|||||||
|
|
||||||
|[[connectors-snaps-metric-snapshotdurationinseconds_{context}]]<<connectors-snaps-metric-snapshotdurationinseconds_{context}, `SnapshotDurationInSeconds`>>
|
|[[connectors-snaps-metric-snapshotdurationinseconds_{context}]]<<connectors-snaps-metric-snapshotdurationinseconds_{context}, `SnapshotDurationInSeconds`>>
|
||||||
|`long`
|
|`long`
|
||||||
|The total number of seconds that the snapshot has taken so far, even if not complete.
|
|The total number of seconds that the snapshot has taken so far, even if not complete. Includes also time when snapshot was paused.
|
||||||
|
|
||||||
|
|[[connectors-snaps-metric-snapshotpauseddurationinseconds_{context}]]<<connectors-snaps-metric-snapshotpauseddurationinseconds_{context}, `SnapshotPausedDurationInSeconds`>>
|
||||||
|
|`long`
|
||||||
|
|The total number of seconds that the snapshot was paused. If the snapshot was paused several times, the paused time adds up.
|
||||||
|
|
||||||
|[[connectors-snaps-metric-rowsscanned_{context}]]<<connectors-snaps-metric-rowsscanned_{context}, `RowsScanned`>>
|
|[[connectors-snaps-metric-rowsscanned_{context}]]<<connectors-snaps-metric-rowsscanned_{context}, `RowsScanned`>>
|
||||||
|`Map<String, Long>`
|
|`Map<String, Long>`
|
||||||
|
Loading…
Reference in New Issue
Block a user