Package io.debezium.connector.spanner

Class SpannerConnectorConfig

java.lang.Object

io.debezium.config.CommonConnectorConfig

io.debezium.connector.spanner.config.BaseSpannerConnectorConfig

io.debezium.connector.spanner.SpannerConnectorConfig

public class SpannerConnectorConfig
extends BaseSpannerConnectorConfig

Configuration API for the Spanner connector

Nested Class Summary

Nested classes/interfaces inherited from class io.debezium.config.CommonConnectorConfig

io.debezium.config.CommonConnectorConfig.BinaryHandlingMode, io.debezium.config.CommonConnectorConfig.EventProcessingFailureHandlingMode, io.debezium.config.CommonConnectorConfig.FieldNameAdjustmentMode, io.debezium.config.CommonConnectorConfig.SchemaNameAdjustmentMode, io.debezium.config.CommonConnectorConfig.Version

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOGGER

Fields inherited from class io.debezium.connector.spanner.config.BaseSpannerConnectorConfig

ALL_FIELDS, CHANGE_STREAM_NAME, CONFIG_DEFINITION, CONNECTOR_NAME_PROPERTY_NAME, CONNECTOR_SPANNER_FINISHED_PARTITION_DELETION_DELAY_FIELD, CONNECTOR_SPANNER_PARTITION_FINISHING_AFTER_COMMIT_FIELD, CONNECTOR_SPANNER_REBALANCING_TOPIC_CONFIG_PREFIX, CONNECTOR_SPANNER_SYNC_TOPIC_CONFIG_PREFIX, DATABASE_ID, DATABASE_ROLE, DESIRED_PARTITIONS_TASKS, END_TIME, END_TIME_PROPERTY_NAME, GCP_SPANNER_CHANGE_STREAM_PROPERTY_NAME, GCP_SPANNER_CREDENTIALS_JSON_PROPERTY_NAME, GCP_SPANNER_CREDENTIALS_PATH_PROPERTY_NAME, GCP_SPANNER_DATABASE_ID_PROPERTY_NAME, GCP_SPANNER_DATABASE_ROLE_PROPERTY_NAME, GCP_SPANNER_HOST_PROPERTY_NAME, GCP_SPANNER_INSTANCE_ID_PROPERTY_NAME, GCP_SPANNER_PROJECT_ID_PROPERTY_NAME, INSTANCE_ID, KAFKA_INTERNAL_CLIENT_CONFIG_PREFIX, LOGGING_JSON_ENABLED, LOW_WATERMARK_ENABLED_FIELD, LOW_WATERMARK_STAMP_INTERVAL, LOW_WATERMARK_UPDATE_PERIOD_MS_FIELD, MAX_MISSED_HEARTBEATS, MAX_TASKS, MIN_TASKS, PERCENTAGE_METRICS_CLEAR_INTERVAL, PROJECT_ID, REBALANCING_COMMIT_OFFSETS_INTERVAL_MS, REBALANCING_COMMIT_OFFSETS_TIMEOUT, REBALANCING_POLL_DURATION, REBALANCING_TASK_WAITING_TIMEOUT, REBALANCING_TOPIC, SCALER_MONITOR_ENABLED, SOURCE_INFO_STRUCT_MAKER, SPANNER_CREDENTIALS_JSON, SPANNER_CREDENTIALS_PATH, SPANNER_HEART_BEAT_INTERVAL, SPANNER_HOST, START_TIME, START_TIME_PROPERTY_NAME, startTime, STREAM_EVENT_QUEUE_CAPACITY, SYNC_CLEANUP_POLICY, SYNC_COMMIT_OFFSETS_INTERVAL_MS, SYNC_COMMIT_OFFSETS_TIMEOUT, SYNC_DELIVERY_TIMEOUT, SYNC_EVENT_PUBLISH_WAITING_TIMEOUT, SYNC_KAFKA_BOOTSTRAP_SERVERS, SYNC_MIN_CLEANABLE_DIRTY_RATIO, SYNC_POLL_DURATION, SYNC_REQUEST_TIMEOUT, SYNC_RETENTION_MS, SYNC_SEGMENT_MS, SYNC_TOPIC, SYNC_TOPIC_MAX_MESSAGE_BYTES, TABLE_EXCLUDE_LIST, TABLE_INCLUDE_LIST, TASK_AWAIT_ANSWER_TIMEOUT, TASK_AWAIT_INITIALIZATION_TMEOUT, TASK_STATE_CHANGE_EVENT_QUEUE_CAPACITY, TASKS_FAIL_OVERLOADED, TASKS_FAIL_OVERLOADED_CHECK_INTERVAL, TOPIC_DEFAULT_AUTO_CREATION_PARTITIONS_FIELD

Fields inherited from class io.debezium.config.CommonConnectorConfig

BINARY_HANDLING_MODE, CUSTOM_CONVERTERS, CUSTOM_METRIC_TAGS, CUSTOM_RETRIABLE_EXCEPTION, DATABASE_CONFIG_PREFIX, DEFAULT_MAX_BATCH_SIZE, DEFAULT_MAX_QUEUE_SIZE, DEFAULT_MAX_QUEUE_SIZE_IN_BYTES, DEFAULT_MAX_RETRIES, DEFAULT_POLL_INTERVAL_MILLIS, DEFAULT_QUERY_FETCH_SIZE, DEFAULT_RETRIABLE_RESTART_WAIT, DRIVER_CONFIG_PREFIX, ERRORS_MAX_RETRIES, EVENT_PROCESSING_FAILURE_HANDLING_MODE, FIELD_NAME_ADJUSTMENT_MODE, INCREMENTAL_SNAPSHOT_ALLOW_SCHEMA_CHANGES, INCREMENTAL_SNAPSHOT_CHUNK_SIZE, logicalName, MAX_BATCH_SIZE, MAX_QUEUE_SIZE, MAX_QUEUE_SIZE_IN_BYTES, MAX_RETRIES_ON_ERROR, MULTI_PARTITION_MODE, NOTIFICATION_CONFIGURATION_FIELD_PREFIX_STRING, NOTIFICATION_ENABLED_CHANNELS, POLL_INTERVAL_MS, PROVIDE_TRANSACTION_METADATA, QUERY_FETCH_SIZE, RETRIABLE_RESTART_WAIT, SCHEMA_NAME_ADJUSTMENT_MODE, SIGNAL_DATA_COLLECTION, SIGNAL_ENABLED_CHANNELS, SIGNAL_POLL_INTERVAL_MS, SKIP_MESSAGES_WITHOUT_CHANGE, SKIPPED_OPERATIONS, SNAPSHOT_DELAY_MS, SNAPSHOT_FETCH_SIZE, SNAPSHOT_MAX_THREADS, SNAPSHOT_MODE_TABLES, TASK_ID, TOMBSTONES_ON_DELETE, TOPIC_NAME_PATTERN, TOPIC_NAMING_STRATEGY, TOPIC_PREFIX

Constructor Summary

Constructors

Constructor	Description
SpannerConnectorConfig(io.debezium.config.Configuration config)

Method Summary

Modifier and Type	Method	Description
Duration	awaitInitializationTimeout()
String	bootStrapServer()
String	changeStreamName()
String	databaseId()
String	databaseRole()
com.google.cloud.Timestamp	endTime()
boolean	failOverloadedTask()
long	failOverloadedTaskInterval()
String	gcpSpannerCredentialsJson()
String	gcpSpannerCredentialsPath()
Duration	getAwaitTaskAnswerTimeout()
String	getConnectorName()
String	getContextName()
int	getDesiredPartitionsTasks()
io.debezium.config.CommonConnectorConfig.EventProcessingFailureHandlingMode	getEventProcessingFailureHandlingMode()
Duration	getFinishedPartitionDeletionDelay()
Duration	getHeartbeatInterval()
Duration	getLowWatermarkStampInterval()
long	getLowWatermarkUpdatePeriodMs()
int	getMaxMissedHeartbeats()
int	getMaxTasks()
int	getMinTasks()
protected io.debezium.connector.SourceInfoStructMaker<SourceInfo>	getSourceInfoStructMaker(io.debezium.config.CommonConnectorConfig.Version version)
int	getTopicNumPartitions()
String	instanceId()
boolean	isFinishingPartitionAfterCommit()
boolean	isLoggingJsonEnabled()
boolean	isLowWatermarkEnabled()
boolean	isScalerMonitorEnabled()
boolean	isSchemaChangesHistoryEnabled()
boolean	isSchemaCommentsHistoryEnabled()
Properties	kafkaProps(Map<?,?> props)
Duration	percentageMetricsClearInterval()
String	projectId()
int	queueCapacity()
int	rebalancingCommitOffsetsInterval()
int	rebalancingCommitOffsetsTimeout()
int	rebalancingPollDuration()
Duration	rebalancingTaskWaitingTimeout()
String	rebalancingTopic()
boolean	shouldProvideTransactionMetadata()
String	spannerHost()
com.google.cloud.Timestamp	startTime()
String	syncCleanupPolicy()
int	syncCommitOffsetsInterval()
int	syncCommitOffsetsTimeout()
int	syncDeliveryTimeout()
int	syncEventPublisherWaitingTimeout()
String	syncMinCleanableDirtyRatio()
int	syncPollDuration()
int	syncRequestTimeout()
int	syncRetentionMs()
int	syncSegmentMs()
String	syncTopicMaxMessageSize()
String	tableExcludeList()
String	tableIncludeList()
int	taskStateChangeEventQueueCapacity()
String	taskSyncTopic()

Methods inherited from class io.debezium.connector.spanner.config.BaseSpannerConnectorConfig

configDef

Methods inherited from class io.debezium.config.CommonConnectorConfig

binaryHandlingMode, createCustomMetricTags, createHeartbeat, customConverterRegistry, customRetriableException, fieldNameAdjuster, getConfig, getCustomMetricTags, getDataCollectionsToBeSnapshotted, getEnabledChannels, getEnabledNotificationChannels, getHeartbeatTopicsPrefix, getIncrementalSnapshotChunkSize, getLogicalName, getMaxBatchSize, getMaxQueueSize, getMaxQueueSizeInBytes, getMaxRetriesOnError, getNotificationTopic, getPollInterval, getQueryFetchSize, getRetriableRestartWait, getSignalingDataCollectionId, getSignalPollInterval, getSkippedOperations, getSnapshotDelay, getSnapshotFetchSize, getSnapshotMaxThreads, getSourceInfoStructMaker, getSourceInfoStructMaker, getTaskId, getTopicNamingStrategy, getTopicNamingStrategy, isEmitTombstoneOnDelete, isIncrementalSnapshotSchemaChangesEnabled, isSignalDataCollection, parseSignallingMessage, schemaNameAdjuster, skipMessagesWithoutChange, supportsOperationFiltering, supportsSchemaChangesDuringIncrementalSnapshot, validate, validateAndRecord, validateSkippedOperation, validateTopicName

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

Constructor Details

SpannerConnectorConfig

public SpannerConnectorConfig(io.debezium.config.Configuration config)

Method Details

getContextName

public String getContextName()

Specified by:

getContextName in class io.debezium.config.CommonConnectorConfig

getConnectorName

public String getConnectorName()

Specified by:

getConnectorName in class io.debezium.config.CommonConnectorConfig

getSourceInfoStructMaker

protected io.debezium.connector.SourceInfoStructMaker<SourceInfo> getSourceInfoStructMaker(io.debezium.config.CommonConnectorConfig.Version version)

Specified by:

getSourceInfoStructMaker in class io.debezium.config.CommonConnectorConfig

isSchemaChangesHistoryEnabled

public boolean isSchemaChangesHistoryEnabled()

Overrides:

isSchemaChangesHistoryEnabled in class io.debezium.config.CommonConnectorConfig

isSchemaCommentsHistoryEnabled

public boolean isSchemaCommentsHistoryEnabled()

Overrides:

isSchemaCommentsHistoryEnabled in class io.debezium.config.CommonConnectorConfig

getHeartbeatInterval

public Duration getHeartbeatInterval()

Overrides:

getHeartbeatInterval in class io.debezium.config.CommonConnectorConfig

shouldProvideTransactionMetadata

public boolean shouldProvideTransactionMetadata()

Overrides:

shouldProvideTransactionMetadata in class io.debezium.config.CommonConnectorConfig

getEventProcessingFailureHandlingMode

public io.debezium.config.CommonConnectorConfig.EventProcessingFailureHandlingMode getEventProcessingFailureHandlingMode()

Overrides:

getEventProcessingFailureHandlingMode in class io.debezium.config.CommonConnectorConfig

kafkaProps

public Properties kafkaProps(Map<?,?> props)

getMaxMissedHeartbeats

public int getMaxMissedHeartbeats()

getLowWatermarkStampInterval

public Duration getLowWatermarkStampInterval()

getFinishedPartitionDeletionDelay

public Duration getFinishedPartitionDeletionDelay()

projectId

public String projectId()

instanceId

public String instanceId()

databaseId

public String databaseId()

databaseRole

public String databaseRole()

spannerHost

public String spannerHost()

changeStreamName

public String changeStreamName()

startTime

public com.google.cloud.Timestamp startTime()

endTime

public com.google.cloud.Timestamp endTime()

queueCapacity

public int queueCapacity()

gcpSpannerCredentialsJson

public String gcpSpannerCredentialsJson()

gcpSpannerCredentialsPath

public String gcpSpannerCredentialsPath()

tableExcludeList

public String tableExcludeList()

tableIncludeList

public String tableIncludeList()

bootStrapServer

public String bootStrapServer()

rebalancingTopic

public String rebalancingTopic()

rebalancingPollDuration

public int rebalancingPollDuration()

rebalancingCommitOffsetsTimeout

public int rebalancingCommitOffsetsTimeout()

rebalancingCommitOffsetsInterval

public int rebalancingCommitOffsetsInterval()

rebalancingTaskWaitingTimeout

public Duration rebalancingTaskWaitingTimeout()

syncEventPublisherWaitingTimeout

public int syncEventPublisherWaitingTimeout()

awaitInitializationTimeout

public Duration awaitInitializationTimeout()

syncPollDuration

public int syncPollDuration()

syncCommitOffsetsTimeout

public int syncCommitOffsetsTimeout()

syncCommitOffsetsInterval

public int syncCommitOffsetsInterval()

syncRequestTimeout

public int syncRequestTimeout()

syncDeliveryTimeout

public int syncDeliveryTimeout()

taskSyncTopic

public String taskSyncTopic()

syncCleanupPolicy

public String syncCleanupPolicy()

syncRetentionMs

public int syncRetentionMs()

syncSegmentMs

public int syncSegmentMs()

syncMinCleanableDirtyRatio

public String syncMinCleanableDirtyRatio()

getMaxTasks

public int getMaxTasks()

getMinTasks

public int getMinTasks()

getDesiredPartitionsTasks

public int getDesiredPartitionsTasks()

isLowWatermarkEnabled

public boolean isLowWatermarkEnabled()

getLowWatermarkUpdatePeriodMs

public long getLowWatermarkUpdatePeriodMs()

isScalerMonitorEnabled

public boolean isScalerMonitorEnabled()

isLoggingJsonEnabled

public boolean isLoggingJsonEnabled()

isFinishingPartitionAfterCommit

public boolean isFinishingPartitionAfterCommit()

taskStateChangeEventQueueCapacity

public int taskStateChangeEventQueueCapacity()

percentageMetricsClearInterval

public Duration percentageMetricsClearInterval()

failOverloadedTask

public boolean failOverloadedTask()

failOverloadedTaskInterval

public long failOverloadedTaskInterval()

getTopicNumPartitions

public int getTopicNumPartitions()

syncTopicMaxMessageSize

public String syncTopicMaxMessageSize()

getAwaitTaskAnswerTimeout

public Duration getAwaitTaskAnswerTimeout()