io.debezium.connector.sqlserver

Enum SqlServerConnectorConfig.SnapshotLockingMode

java.lang.Object

java.lang.Enum<SqlServerConnectorConfig.SnapshotLockingMode>

io.debezium.connector.sqlserver.SqlServerConnectorConfig.SnapshotLockingMode

All Implemented Interfaces:

io.debezium.config.EnumeratedValue, Serializable, Comparable<SqlServerConnectorConfig.SnapshotLockingMode>

Enclosing class:

SqlServerConnectorConfig

public static enum SqlServerConnectorConfig.SnapshotLockingMode
extends Enum<SqlServerConnectorConfig.SnapshotLockingMode>
implements io.debezium.config.EnumeratedValue

The set of predefined Snapshot Locking Mode options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUSIVE This mode will block all reads and writes for the entire duration of the snapshot.
NONE This mode will avoid using ANY table locks during the snapshot process.
SNAPSHOT This mode uses SNAPSHOT isolation level.

Field Summary

Fields

Modifier and Type	Field and Description
private String	value

Method Summary

Modifier and Type	Method and Description
String	getValue()
static SqlServerConnectorConfig.SnapshotLockingMode	parse(String value) Determine if the supplied value is one of the predefined options.
static SqlServerConnectorConfig.SnapshotLockingMode	parse(String value, String defaultValue) Determine if the supplied value is one of the predefined options.
static SqlServerConnectorConfig.SnapshotLockingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SqlServerConnectorConfig.SnapshotLockingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXCLUSIVE

public static final SqlServerConnectorConfig.SnapshotLockingMode EXCLUSIVE

This mode will block all reads and writes for the entire duration of the snapshot. The connector will execute SELECT * FROM .. WITH (TABLOCKX)

SNAPSHOT

public static final SqlServerConnectorConfig.SnapshotLockingMode SNAPSHOT

This mode uses SNAPSHOT isolation level. This way reads and writes are not blocked for the entire duration of the snapshot. Snapshot consistency is guaranteed as long as DDL statements are not executed at the time.

NONE

public static final SqlServerConnectorConfig.SnapshotLockingMode NONE

This mode will avoid using ANY table locks during the snapshot process. This mode can only be used with SnapShotMode set to schema_only or schema_only_recovery.

Field Detail

value

private final String value

Method Detail

values

public static SqlServerConnectorConfig.SnapshotLockingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SqlServerConnectorConfig.SnapshotLockingMode c : SqlServerConnectorConfig.SnapshotLockingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SqlServerConnectorConfig.SnapshotLockingMode 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 io.debezium.config.EnumeratedValue

parse

public static SqlServerConnectorConfig.SnapshotLockingMode 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.SnapshotLockingMode 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