Package io.debezium.sink

Enum Class SinkConnectorConfig.PrimaryKeyMode

java.lang.Object

java.lang.Enum<SinkConnectorConfig.PrimaryKeyMode>

io.debezium.sink.SinkConnectorConfig.PrimaryKeyMode

All Implemented Interfaces:

EnumeratedValue, Serializable, Comparable<SinkConnectorConfig.PrimaryKeyMode>, Constable

Enclosing interface:

SinkConnectorConfig

public static enum SinkConnectorConfig.PrimaryKeyMode
extends Enum<SinkConnectorConfig.PrimaryKeyMode>
implements EnumeratedValue

Different modes that which primary keys are handled.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
KAFKA	The Kafka event coordinates are used as the primary key, which include the topic name, the partition, and the offset associated with the event.
NONE	No keys are utilized, meaning tables will be created or managed without any primary keys.
RECORD_HEADER	Fields from the event's record header are used.
RECORD_KEY	Fields from the record key are to be used, which can include struct-based keys or primitives.
RECORD_VALUE	Fields from the event's record value are used.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	mode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PrimaryKeyMode(String mode)

Method Summary

Modifier and Type	Method	Description
String	getValue()
static SinkConnectorConfig.PrimaryKeyMode	parse(String value)
static SinkConnectorConfig.PrimaryKeyMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SinkConnectorConfig.PrimaryKeyMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final SinkConnectorConfig.PrimaryKeyMode NONE

No keys are utilized, meaning tables will be created or managed without any primary keys.

KAFKA

public static final SinkConnectorConfig.PrimaryKeyMode KAFKA

The Kafka event coordinates are used as the primary key, which include the topic name, the partition, and the offset associated with the event.

RECORD_KEY

public static final SinkConnectorConfig.PrimaryKeyMode RECORD_KEY

Fields from the record key are to be used, which can include struct-based keys or primitives. In the case of primitives, the primary.key.fields property must be supplied with a single value, which controls what the primary key column name will be in the destination table. In the case of a struct, the primary.key.fields property is optional and if specified can specify a subset of the record's key fields to for the destination table's primary key.

RECORD_VALUE

public static final SinkConnectorConfig.PrimaryKeyMode RECORD_VALUE

Fields from the event's record value are used. The primary.key.fields property should be specified to identify the fields that will be the basis for the destination table's primary key.

RECORD_HEADER

public static final SinkConnectorConfig.PrimaryKeyMode RECORD_HEADER

Fields from the event's record header are used. The primary.key.fields property should be specified to identify the fields that will be the basis for the destination table's primary key.

Field Details

mode

private final String mode

Constructor Details

PrimaryKeyMode

private PrimaryKeyMode(String mode)

Method Details

values

public static SinkConnectorConfig.PrimaryKeyMode[] 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 SinkConnectorConfig.PrimaryKeyMode 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

parse

public static SinkConnectorConfig.PrimaryKeyMode parse(String value)

getValue

public String getValue()

Specified by:

getValue in interface EnumeratedValue