DBZ-6259 Add missing description of various snapshot modes in the connector field definitions
This commit is contained in:
ani-sha
Chris Cranford
parent
1e10253c5e
commit
a453c3ca19
@ -510,9 +510,9 @@ public static ConnectionMode parse(String value, String defaultValue) {
|
||||
.withWidth(Width.SHORT)
|
||||
.withImportance(Importance.LOW)
|
||||
.withDescription("The criteria for running a snapshot upon startup of the connector. "
|
||||
+ "Options include: "
|
||||
+ "'initial' (the default) to specify the connector should always perform an initial sync when required; "
|
||||
+ "'never' to specify the connector should never perform an initial sync ");
|
||||
+ "Select one of the following snapshot options: "
|
||||
+ "'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the oplog. "
|
||||
+ "'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the oplog.");
|
||||
|
||||
public static final Field SNAPSHOT_FILTER_QUERY_BY_COLLECTION = Field.create("snapshot.collection.filter.overrides")
|
||||
.withDisplayName("Snapshot mode")
|
||||
|
||||
@ -757,12 +757,13 @@ public static SecureConnectionMode parse(String value, String defaultValue) {
|
||||
.withWidth(Width.SHORT)
|
||||
.withImportance(Importance.LOW)
|
||||
.withDescription("The criteria for running a snapshot upon startup of the connector. "
|
||||
+ "Options include: "
|
||||
+ "'when_needed' to specify that the connector run a snapshot upon startup whenever it deems it necessary; "
|
||||
+ "'schema_only' to only take a snapshot of the schema (table structures) but no actual data; "
|
||||
+ "'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; "
|
||||
+ "'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally read the binlog; and"
|
||||
+ "'never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the beginning of the binlog. "
|
||||
+ "Select one of the following snapshot options: "
|
||||
+ "'when_needed': On startup, the connector runs a snapshot if one is needed.; "
|
||||
+ "'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the binlog.; "
|
||||
+ "'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions back to streaming. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped.; "
|
||||
+ "'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the binlog.; "
|
||||
+ "'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the binlog.; "
|
||||
+ "'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the binlog. "
|
||||
+ "The 'never' mode should be used with care, and only when the binlog is known to contain all history.");
|
||||
|
||||
public static final Field SNAPSHOT_LOCKING_MODE = Field.create("snapshot.locking.mode")
|
||||
|
||||
@ -119,9 +119,12 @@ public class OracleConnectorConfig extends HistorizedRelationalDatabaseConnector
|
||||
.withImportance(Importance.LOW)
|
||||
.withGroup(Field.createGroupEntry(Field.Group.CONNECTOR_SNAPSHOT, 0))
|
||||
.withDescription("The criteria for running a snapshot upon startup of the connector. "
|
||||
+ "Options include: "
|
||||
+ "'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; "
|
||||
+ "'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. ");
|
||||
+ "Select one of the following snapshot options: "
|
||||
+ "'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the redo logs.; "
|
||||
+ "'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the redo logs. "
|
||||
+ "'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the redo logs.; "
|
||||
+ "'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the redo logs.; "
|
||||
+ "'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions to streaming from the redo logs. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped.");
|
||||
|
||||
public static final Field SNAPSHOT_LOCKING_MODE = Field.create("snapshot.locking.mode")
|
||||
.withDisplayName("Snapshot locking mode")
|
||||
|
||||
@ -714,13 +714,13 @@ public static AutoCreateMode parse(String value, String defaultValue) {
|
||||
.withWidth(Width.SHORT)
|
||||
.withImportance(Importance.MEDIUM)
|
||||
.withDescription("The criteria for running a snapshot upon startup of the connector. "
|
||||
+ "Options include: "
|
||||
+ "'always' to specify that the connector run a snapshot each time it starts up; "
|
||||
+ "'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; "
|
||||
+ "'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally start emitting changes;"
|
||||
+ "'never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the last position (LSN) recorded by the server; and"
|
||||
+ "'exported' deprecated, use 'initial' instead; "
|
||||
+ "'custom' to specify a custom class with 'snapshot.custom_class' which will be loaded and used to determine the snapshot, see docs for more details.");
|
||||
+ "Select one of the following snapshot options: "
|
||||
+ "'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the transaction log.; "
|
||||
+ "'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the transaction log. "
|
||||
+ "'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the transaction log.; "
|
||||
+ "'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the transaction log. "
|
||||
+ "'exported': This option is deprecated; use 'initial' instead.; "
|
||||
+ "'custom': The connector loads a custom class to specify how the connector performs snapshots. For more information, see Custom snapshotter SPI in the PostgreSQL connector documentation.");
|
||||
|
||||
public static final Field SNAPSHOT_MODE_CLASS = Field.create("snapshot.custom.class")
|
||||
.withDisplayName("Snapshot Mode Custom Class")
|
||||
|
||||
@ -276,10 +276,10 @@ public static SnapshotIsolationMode parse(String value, String defaultValue) {
|
||||
.withWidth(Width.SHORT)
|
||||
.withImportance(Importance.LOW)
|
||||
.withDescription("The criteria for running a snapshot upon startup of the connector. "
|
||||
+ "Options include: "
|
||||
+ "'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; "
|
||||
+ "'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. ");
|
||||
|
||||
+ "Select one of the following snapshot options: "
|
||||
+ "'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the transaction log.; "
|
||||
+ "'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the transaction log.; "
|
||||
+ "'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the transaction log.");
|
||||
public static final Field SNAPSHOT_ISOLATION_MODE = Field.create("snapshot.isolation.mode")
|
||||
.withDisplayName("Snapshot isolation mode")
|
||||
.withEnum(SnapshotIsolationMode.class, SnapshotIsolationMode.REPEATABLE_READ)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user