Package io.debezium.connector.binlog

Enum BinlogConnectorConfig.SnapshotMode

java.lang.Object
java.lang.Enum<BinlogConnectorConfig.SnapshotMode>
io.debezium.connector.binlog.BinlogConnectorConfig.SnapshotMode
All Implemented Interfaces:
EnumeratedValue, Serializable, Comparable<BinlogConnectorConfig.SnapshotMode>
Enclosing class:
BinlogConnectorConfig
public static enum BinlogConnectorConfig.SnapshotMode extends Enum<BinlogConnectorConfig.SnapshotMode> implements EnumeratedValue
Set of predefined SnapshotMode options or aliases.

  • Enum Constant Details

    • ALWAYS

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

    • WHEN_NEEDED

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

    • INITIAL

      public static final BinlogConnectorConfig.SnapshotMode INITIAL
      Perform a snapshot only upon initial startup of a connector.

    • SCHEMA_ONLY

      public static final BinlogConnectorConfig.SnapshotMode SCHEMA_ONLY
      Deprecated.
      to be removed in Debezium 3.0, replaced by {NO_DATA}
      Perform a snapshot of only the database schemas (without data) and then begin reading the binlog. This should be used with care, but it is very useful when the change event consumers need only the changes from the point in time the snapshot is made (and doesn't care about any state or changes prior to this point).

    • NO_DATA

      public static final BinlogConnectorConfig.SnapshotMode NO_DATA
      Perform a snapshot of only the database schemas (without data) and then begin reading the binlog. This should be used with care, but it is very useful when the change event consumers need only the changes from the point in time the snapshot is made (and doesn't care about any state or changes prior to this point).

    • SCHEMA_ONLY_RECOVERY

      public static final BinlogConnectorConfig.SnapshotMode SCHEMA_ONLY_RECOVERY
      Deprecated.
      to be removed in Debezium 3.0, replaced by {RECOVERY}
      Perform a snapshot of only the database schemas (without data) and then begin reading the binlog at the current binlog 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.

    • RECOVERY

      public static final BinlogConnectorConfig.SnapshotMode RECOVERY
      Perform a snapshot of only the database schemas (without data) and then begin reading the binlog at the current binlog 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.

    • NEVER

      public static final BinlogConnectorConfig.SnapshotMode NEVER
      Never perform a snapshot and only read the binlog. This assumes the binlog contains all the history of those databases and tables that will be captured.

    • INITIAL_ONLY

      public static final BinlogConnectorConfig.SnapshotMode INITIAL_ONLY
      Perform a snapshot and then stop before attempting to read the binlog.

    • CONFIGURATION_BASED

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

    • CUSTOM

      public static final BinlogConnectorConfig.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 BinlogConnectorConfig.SnapshotMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static BinlogConnectorConfig.SnapshotMode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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 BinlogConnectorConfig.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 BinlogConnectorConfig.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