Package io.debezium.connector.sqlserver

Enum Class SqlServerConnectorConfig.SnapshotMode

java.lang.Object
java.lang.Enum<SqlServerConnectorConfig.SnapshotMode>
io.debezium.connector.sqlserver.SqlServerConnectorConfig.SnapshotMode
All Implemented Interfaces:
EnumeratedValue, Serializable, Comparable<SqlServerConnectorConfig.SnapshotMode>, Constable
Enclosing class:
SqlServerConnectorConfig
public static enum SqlServerConnectorConfig.SnapshotMode extends Enum<SqlServerConnectorConfig.SnapshotMode> implements EnumeratedValue
The set of predefined SnapshotMode options or aliases.

  • Enum Constant Details

    • ALWAYS

      public static final SqlServerConnectorConfig.SnapshotMode ALWAYS
      Performs a snapshot of data and schema upon each connector start.

    • INITIAL

      public static final SqlServerConnectorConfig.SnapshotMode INITIAL
      Perform a snapshot of data and schema upon initial startup of a connector.

    • INITIAL_ONLY

      public static final SqlServerConnectorConfig.SnapshotMode INITIAL_ONLY
      Perform a snapshot of data and schema upon initial startup of a connector but does not transition to streaming.

    • SCHEMA_ONLY

      public static final SqlServerConnectorConfig.SnapshotMode SCHEMA_ONLY
      Deprecated.
      to be removed in Debezium 3.0, replaced by {NO_DATA}
      Perform a snapshot of the schema but no data upon initial startup of a connector.

    • NO_DATA

      public static final SqlServerConnectorConfig.SnapshotMode NO_DATA
      Perform a snapshot of the schema but no data upon initial startup of a connector.

    • RECOVERY

      public static final SqlServerConnectorConfig.SnapshotMode RECOVERY
      Perform a snapshot of only the database schemas (without data) and then begin reading the redo log at the current redo log position. This can be used for recovery only if the connector has existing offsets and the schema.history.internal.kafka.topic does not exist (deleted). This recovery option should be used with care as it assumes there have been no schema changes since the connector last stopped, otherwise some events during the gap may be processed with an incorrect schema and corrupted.

    • WHEN_NEEDED

      public static final SqlServerConnectorConfig.SnapshotMode WHEN_NEEDED
      Perform a snapshot when it is needed.

    • CONFIGURATION_BASED

      public static final SqlServerConnectorConfig.SnapshotMode CONFIGURATION_BASED
      Allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'.

    • CUSTOM

      public static final SqlServerConnectorConfig.SnapshotMode CUSTOM
      Inject a custom snapshotter, which allows for more control over snapshots.

  • Field Details

    • value

      private final String value

  • Constructor Details

    • SnapshotMode

      private SnapshotMode(String value)

  • Method Details

    • values

      public static SqlServerConnectorConfig.SnapshotMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SqlServerConnectorConfig.SnapshotMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()
      Specified by:
      getValue in interface EnumeratedValue

    • parse

      public static SqlServerConnectorConfig.SnapshotMode parse(String value)
      Determine if the supplied value is one of the predefined options.
      Parameters:
      value - the configuration property value; may not be null
      Returns:
      the matching option, or null if no match is found

    • parse

      public static SqlServerConnectorConfig.SnapshotMode parse(String value, String defaultValue)
      Determine if the supplied value is one of the predefined options.
      Parameters:
      value - the configuration property value; may not be null
      defaultValue - the default value; may be null
      Returns:
      the matching option, or null if no match is found and the non-null default is invalid