io.debezium.config

Class CommonConnectorConfig

java.lang.Object

io.debezium.config.CommonConnectorConfig

Direct Known Subclasses:

RelationalDatabaseConnectorConfig

public abstract class CommonConnectorConfig
extends Object

Configuration options common to all Debezium connectors.

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonConnectorConfig.BinaryHandlingMode The set of predefined BinaryHandlingMode options or aliases
static class	CommonConnectorConfig.EventProcessingFailureHandlingMode The set of predefined modes for dealing with failures during event processing.
static class	CommonConnectorConfig.Version The set of predefined versions e.g.

Field Summary

Fields

Modifier and Type	Field and Description
static Field	BINARY_HANDLING_MODE
private CommonConnectorConfig.BinaryHandlingMode	binaryHandlingMode
private Configuration	config
protected static ConfigDefinition	CONFIG_DEFINITION
private static String	CONVERTER_TYPE_SUFFIX
static Field	CUSTOM_CONVERTERS
private CustomConverterRegistry	customConverterRegistry
static String	DATABASE_CONFIG_PREFIX
static int	DEFAULT_MAX_BATCH_SIZE
static int	DEFAULT_MAX_QUEUE_SIZE
static long	DEFAULT_POLL_INTERVAL_MILLIS
private boolean	emitTombstoneOnDelete
static Field	EVENT_PROCESSING_FAILURE_HANDLING_MODE
private CommonConnectorConfig.EventProcessingFailureHandlingMode	eventProcessingFailureHandlingMode
private String	heartbeatTopicsPrefix
private String	logicalName
static Field	MAX_BATCH_SIZE
static Field	MAX_QUEUE_SIZE
private int	maxBatchSize
private int	maxQueueSize
static Field	POLL_INTERVAL_MS
private Duration	pollInterval
static Field	PROVIDE_TRANSACTION_METADATA
static Field	SANITIZE_FIELD_NAMES
private boolean	sanitizeFieldNames
private boolean	shouldProvideTransactionMetadata
static Field	SKIPPED_OPERATIONS
static Field	SNAPSHOT_DELAY_MS
static Field	SNAPSHOT_FETCH_SIZE
private Duration	snapshotDelayMs
private int	snapshotFetchSize
static Field	SOURCE_STRUCT_MAKER_VERSION
private SourceInfoStructMaker<? extends AbstractSourceInfo>	sourceInfoStructMaker
static Field	TOMBSTONES_ON_DELETE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommonConnectorConfig(Configuration config, String logicalName, int defaultSnapshotFetchSize)

Method Summary

Modifier and Type	Method and Description
CommonConnectorConfig.BinaryHandlingMode	binaryHandlingMode()
CustomConverterRegistry	customConverterRegistry()
Configuration	getConfig() Provides access to the "raw" config instance.
abstract String	getConnectorName()
abstract String	getContextName()
private List<CustomConverter<org.apache.kafka.connect.data.SchemaBuilder,ConvertedField>>	getCustomConverters()
CommonConnectorConfig.EventProcessingFailureHandlingMode	getEventProcessingFailureHandlingMode()
String	getHeartbeatTopicsPrefix()
String	getLogicalName()
int	getMaxBatchSize()
int	getMaxQueueSize()
Duration	getPollInterval()
boolean	getSanitizeFieldNames()
Set<Envelope.Operation>	getSkippedOps()
Duration	getSnapshotDelay()
int	getSnapshotFetchSize()
<T extends AbstractSourceInfo> SourceInfoStructMaker<T>	getSourceInfoStructMaker()
protected abstract SourceInfoStructMaker<?>	getSourceInfoStructMaker(CommonConnectorConfig.Version version) Returns the connector-specific SourceInfoStructMaker based on the given configuration.
boolean	isEmitTombstoneOnDelete()
boolean	isSchemaChangesHistoryEnabled()
private static boolean	isUsingAvroConverter(Configuration config)
boolean	shouldProvideTransactionMetadata()
private static int	validateMaxQueueSize(Configuration config, Field field, Field.ValidationOutput problems)
protected static int	validateServerNameIsDifferentFromHistoryTopicName(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateSkippedOperation(Configuration config, Field field, Field.ValidationOutput problems)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MAX_QUEUE_SIZE

public static final int DEFAULT_MAX_QUEUE_SIZE

See Also:

Constant Field Values

DEFAULT_MAX_BATCH_SIZE

public static final int DEFAULT_MAX_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_POLL_INTERVAL_MILLIS

public static final long DEFAULT_POLL_INTERVAL_MILLIS

See Also:

Constant Field Values

DATABASE_CONFIG_PREFIX

public static final String DATABASE_CONFIG_PREFIX

See Also:

Constant Field Values

CONVERTER_TYPE_SUFFIX

private static final String CONVERTER_TYPE_SUFFIX

See Also:

Constant Field Values

TOMBSTONES_ON_DELETE

public static final Field TOMBSTONES_ON_DELETE

MAX_QUEUE_SIZE

public static final Field MAX_QUEUE_SIZE

MAX_BATCH_SIZE

public static final Field MAX_BATCH_SIZE

POLL_INTERVAL_MS

public static final Field POLL_INTERVAL_MS

SNAPSHOT_DELAY_MS

public static final Field SNAPSHOT_DELAY_MS

SNAPSHOT_FETCH_SIZE

public static final Field SNAPSHOT_FETCH_SIZE

SOURCE_STRUCT_MAKER_VERSION

public static final Field SOURCE_STRUCT_MAKER_VERSION

SANITIZE_FIELD_NAMES

public static final Field SANITIZE_FIELD_NAMES

PROVIDE_TRANSACTION_METADATA

public static final Field PROVIDE_TRANSACTION_METADATA

EVENT_PROCESSING_FAILURE_HANDLING_MODE

public static final Field EVENT_PROCESSING_FAILURE_HANDLING_MODE

CUSTOM_CONVERTERS

public static final Field CUSTOM_CONVERTERS

SKIPPED_OPERATIONS

public static final Field SKIPPED_OPERATIONS

BINARY_HANDLING_MODE

public static final Field BINARY_HANDLING_MODE

CONFIG_DEFINITION

protected static final ConfigDefinition CONFIG_DEFINITION

config

private final Configuration config

emitTombstoneOnDelete

private final boolean emitTombstoneOnDelete

maxQueueSize

private final int maxQueueSize

maxBatchSize

private final int maxBatchSize

pollInterval

private final Duration pollInterval

logicalName

private final String logicalName

heartbeatTopicsPrefix

private final String heartbeatTopicsPrefix

snapshotDelayMs

private final Duration snapshotDelayMs

snapshotFetchSize

private final int snapshotFetchSize

sourceInfoStructMaker

private final SourceInfoStructMaker<? extends AbstractSourceInfo> sourceInfoStructMaker

sanitizeFieldNames

private final boolean sanitizeFieldNames

shouldProvideTransactionMetadata

private final boolean shouldProvideTransactionMetadata

eventProcessingFailureHandlingMode

private final CommonConnectorConfig.EventProcessingFailureHandlingMode eventProcessingFailureHandlingMode

customConverterRegistry

private final CustomConverterRegistry customConverterRegistry

binaryHandlingMode

private final CommonConnectorConfig.BinaryHandlingMode binaryHandlingMode

Constructor Detail

CommonConnectorConfig

protected CommonConnectorConfig(Configuration config,
                                String logicalName,
                                int defaultSnapshotFetchSize)

Method Detail

getConfig

public Configuration getConfig()

Provides access to the "raw" config instance. In most cases, access via typed getters for individual properties on the connector config class should be preferred.

isEmitTombstoneOnDelete

public boolean isEmitTombstoneOnDelete()

getMaxQueueSize

public int getMaxQueueSize()

getMaxBatchSize

public int getMaxBatchSize()

getPollInterval

public Duration getPollInterval()

getLogicalName

public String getLogicalName()

getContextName

public abstract String getContextName()

getConnectorName

public abstract String getConnectorName()

getHeartbeatTopicsPrefix

public String getHeartbeatTopicsPrefix()

getSnapshotDelay

public Duration getSnapshotDelay()

getSnapshotFetchSize

public int getSnapshotFetchSize()

shouldProvideTransactionMetadata

public boolean shouldProvideTransactionMetadata()

getEventProcessingFailureHandlingMode

public CommonConnectorConfig.EventProcessingFailureHandlingMode getEventProcessingFailureHandlingMode()

customConverterRegistry

public CustomConverterRegistry customConverterRegistry()

getCustomConverters

private List<CustomConverter<org.apache.kafka.connect.data.SchemaBuilder,ConvertedField>> getCustomConverters()

getSourceInfoStructMaker

public <T extends AbstractSourceInfo> SourceInfoStructMaker<T> getSourceInfoStructMaker()

getSanitizeFieldNames

public boolean getSanitizeFieldNames()

getSkippedOps

public Set<Envelope.Operation> getSkippedOps()

isSchemaChangesHistoryEnabled

public boolean isSchemaChangesHistoryEnabled()

Returns:

true if the connector should emit messages about schema changes into a public facing topic.

validateMaxQueueSize

private static int validateMaxQueueSize(Configuration config,
                                        Field field,
                                        Field.ValidationOutput problems)

validateSkippedOperation

private static int validateSkippedOperation(Configuration config,
                                            Field field,
                                            Field.ValidationOutput problems)

isUsingAvroConverter

private static boolean isUsingAvroConverter(Configuration config)

validateServerNameIsDifferentFromHistoryTopicName

protected static int validateServerNameIsDifferentFromHistoryTopicName(Configuration config,
                                                                       Field field,
                                                                       Field.ValidationOutput problems)

getSourceInfoStructMaker

protected abstract SourceInfoStructMaker<?> getSourceInfoStructMaker(CommonConnectorConfig.Version version)

Returns the connector-specific SourceInfoStructMaker based on the given configuration.

binaryHandlingMode

public CommonConnectorConfig.BinaryHandlingMode binaryHandlingMode()