Package io.debezium.connector.oracle

Enum OracleConnectorConfig.SnapshotMode

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

  • Enum Constant Details

    • ALWAYS

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

    • INITIAL

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

    • INITIAL_ONLY

      public static final OracleConnectorConfig.SnapshotMode INITIAL_ONLY
      Perform a snapshot of data and schema upon initial startup of a connector and stop after initial consistent snapshot.

    • SCHEMA_ONLY

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

    • SCHEMA_ONLY_RECOVERY

      public static final OracleConnectorConfig.SnapshotMode SCHEMA_ONLY_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.

  • Field Details

    • value

      private final String value

    • includeData

      private final boolean includeData

    • shouldStream

      private final boolean shouldStream

    • shouldSnapshotOnSchemaError

      private final boolean shouldSnapshotOnSchemaError

  • Constructor Details

    • SnapshotMode

      private SnapshotMode(String value, boolean includeData, boolean shouldStream, boolean shouldSnapshotOnSchemaError)

  • Method Details

    • values

      public static OracleConnectorConfig.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 OracleConnectorConfig.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

    • includeData

      public boolean includeData()
      Whether this snapshotting mode should include the actual data or just the schema of captured tables.

    • shouldStream

      public boolean shouldStream()
      Whether the snapshot mode is followed by streaming.

    • shouldSnapshotOnSchemaError

      public boolean shouldSnapshotOnSchemaError()
      Whether the schema can be recovered if database schema history is corrupted.

    • parse

      public static OracleConnectorConfig.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 OracleConnectorConfig.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