io.debezium.connector.oracle

Class OracleConnectorConfig

java.lang.Object

io.debezium.config.CommonConnectorConfig

io.debezium.relational.RelationalDatabaseConnectorConfig

io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

io.debezium.connector.oracle.OracleConnectorConfig

public class OracleConnectorConfig
extends io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

Connector configuration for Oracle.

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OracleConnectorConfig.ConnectorAdapter
static class	OracleConnectorConfig.LogMiningStrategy
static class	OracleConnectorConfig.SnapshotMode The set of predefined SnapshotMode options or aliases.
private static class	OracleConnectorConfig.SystemTablesPredicate A Tables.TableFilter that excludes all Oracle system tables.

Nested classes/interfaces inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

io.debezium.relational.RelationalDatabaseConnectorConfig.DecimalHandlingMode

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static io.debezium.config.Field.Set	ALL_FIELDS The set of Fields defined as part of this configuration.
private io.debezium.relational.Tables.ColumnNameFilter	columnFilter
static io.debezium.config.Field	CONNECTOR_ADAPTER
static io.debezium.config.Field	CONTINUOUS_MINE
static String	DATABASE_CONFIG_PREFIX
static io.debezium.config.Field	DATABASE_NAME
private String	databaseName
protected static int	DEFAULT_PORT
static io.debezium.config.Field	HOSTNAME
static io.debezium.config.Field	LOG_MINING_ARCHIVE_LOG_HOURS
static io.debezium.config.Field	LOG_MINING_HISTORY_RECORDER_CLASS
static io.debezium.config.Field	LOG_MINING_HISTORY_RETENTION
static io.debezium.config.Field	LOG_MINING_STRATEGY
private HistoryRecorder	logMiningHistoryRecorder
static io.debezium.config.Field	ORACLE_VERSION
private OracleVersion	oracleVersion
static io.debezium.config.Field	PASSWORD
static io.debezium.config.Field	PDB_NAME
private String	pdbName
static io.debezium.config.Field	PORT
static io.debezium.config.Field	RAC_NODES
static io.debezium.config.Field	RAC_SYSTEM
static io.debezium.config.Field	SCHEMA_NAME
private String	schemaName
static io.debezium.config.Field	SERVER_NAME
static io.debezium.config.Field	SNAPSHOT_ENHANCEMENT_TOKEN
static io.debezium.config.Field	SNAPSHOT_MODE
private OracleConnectorConfig.SnapshotMode	snapshotMode
static io.debezium.config.Field	TABLENAME_CASE_INSENSITIVE
private boolean	tablenameCaseInsensitive
static io.debezium.config.Field	URL
static io.debezium.config.Field	USER
private String	xoutServerName
static io.debezium.config.Field	XSTREAM_SERVER_NAME

Fields inherited from class io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

CONFIG_DEFINITION, DATABASE_HISTORY, DEFAULT_SNAPSHOT_FETCH_SIZE

Fields inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

COLUMN_BLACKLIST, COLUMN_EXCLUDE_LIST, COLUMN_INCLUDE_LIST, COLUMN_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG, COLUMN_WHITELIST, DECIMAL_HANDLING_MODE, DEFAULT_SNAPSHOT_LOCK_TIMEOUT_MILLIS, INCLUDE_SCHEMA_CHANGES, MASK_COLUMN, MASK_COLUMN_WITH_HASH, MSG_KEY_COLUMNS, PROPAGATE_COLUMN_SOURCE_TYPE, PROPAGATE_DATATYPE_SOURCE_TYPE, SCHEMA_BLACKLIST, SCHEMA_EXCLUDE_LIST, SCHEMA_EXCLUDE_LIST_NAME, SCHEMA_INCLUDE_LIST, SCHEMA_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG, SCHEMA_INCLUDE_LIST_NAME, SCHEMA_WHITELIST, SNAPSHOT_LOCK_TIMEOUT_MS, SNAPSHOT_SELECT_STATEMENT_OVERRIDES_BY_TABLE, TABLE_BLACKLIST, TABLE_BLACKLIST_NAME, TABLE_EXCLUDE_LIST, TABLE_EXCLUDE_LIST_NAME, TABLE_IGNORE_BUILTIN, TABLE_INCLUDE_LIST, TABLE_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG, TABLE_INCLUDE_LIST_NAME, TABLE_WHITELIST, TABLE_WHITELIST_NAME, TIME_PRECISION_MODE, TRUNCATE_COLUMN

Fields inherited from class io.debezium.config.CommonConnectorConfig

BINARY_HANDLING_MODE, CUSTOM_CONVERTERS, DEFAULT_MAX_BATCH_SIZE, DEFAULT_MAX_QUEUE_SIZE, DEFAULT_MAX_QUEUE_SIZE_IN_BYTES, DEFAULT_POLL_INTERVAL_MILLIS, DEFAULT_QUERY_FETCH_SIZE, DEFAULT_RETRIABLE_RESTART_WAIT, EVENT_PROCESSING_FAILURE_HANDLING_MODE, MAX_BATCH_SIZE, MAX_QUEUE_SIZE, MAX_QUEUE_SIZE_IN_BYTES, POLL_INTERVAL_MS, PROVIDE_TRANSACTION_METADATA, QUERY_FETCH_SIZE, RETRIABLE_RESTART_WAIT, SANITIZE_FIELD_NAMES, SKIPPED_OPERATIONS, SNAPSHOT_DELAY_MS, SNAPSHOT_FETCH_SIZE, SNAPSHOT_MAX_THREADS, SNAPSHOT_MODE_TABLES, SOURCE_STRUCT_MAKER_VERSION, TOMBSTONES_ON_DELETE

Constructor Summary

Constructors

Constructor and Description
OracleConnectorConfig(io.debezium.config.Configuration config)

Method Summary

Modifier and Type	Method and Description
static org.apache.kafka.common.config.ConfigDef	configDef()
OracleConnectorConfig.ConnectorAdapter	getAdapter()
io.debezium.relational.Tables.ColumnNameFilter	getColumnFilter()
protected io.debezium.relational.Tables.ColumnNameFilter	getColumnNameFilter(String excludedColumnPatterns)
String	getConnectorName()
String	getContextName()
String	getDatabaseName()
protected io.debezium.relational.history.HistoryRecordComparator	getHistoryRecordComparator()
long	getLogMinerHistoryRetentionHours()
Duration	getLogMiningArchiveLogRetention()
HistoryRecorder	getLogMiningHistoryRecorder()
OracleConnectorConfig.LogMiningStrategy	getLogMiningStrategy()
OracleVersion	getOracleVersion()
String	getPdbName()
Set<String>	getRacNodes()
String	getSchemaName()
OracleConnectorConfig.SnapshotMode	getSnapshotMode()
protected io.debezium.connector.SourceInfoStructMaker<? extends io.debezium.connector.AbstractSourceInfo>	getSourceInfoStructMaker(io.debezium.config.CommonConnectorConfig.Version version)
boolean	getTablenameCaseInsensitive()
String	getTokenToReplaceInSnapshotPredicate()
String	getXoutServerName()
boolean	isContinuousMining()
Boolean	isLogMiningHistoryRecorded()
Boolean	isRacSystem()
static int	requiredWhenNoHostname(io.debezium.config.Configuration config, io.debezium.config.Field field, io.debezium.config.Field.ValidationOutput problems)
static int	requiredWhenNoUrl(io.debezium.config.Configuration config, io.debezium.config.Field field, io.debezium.config.Field.ValidationOutput problems)
private static HistoryRecorder	resolveLogMiningHistoryRecorder(io.debezium.config.Configuration config)
private static String	toUpperCase(String property)
static int	validateDatabaseSchema(io.debezium.config.Configuration config, io.debezium.config.Field field, io.debezium.config.Field.ValidationOutput problems)
static int	validateOutServerName(io.debezium.config.Configuration config, io.debezium.config.Field field, io.debezium.config.Field.ValidationOutput problems)
private static int	validateSnapshotMode(io.debezium.config.Configuration config, io.debezium.config.Field field, io.debezium.config.Field.ValidationOutput problems) Validate the time.precision.mode configuration.

Methods inherited from class io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

getDatabaseHistory

Methods inherited from class io.debezium.relational.RelationalDatabaseConnectorConfig

columnExcludeList, columnIncludeList, getDecimalMode, getKeyMapper, getSnapshotSelectOverridesByTable, getTableFilters, getTableIdMapper, getTemporalPrecisionMode, isSchemaChangesHistoryEnabled, schemaExcludeList, schemaIncludeList, snapshotLockTimeout, tableExcludeList, tableIncludeList

Methods inherited from class io.debezium.config.CommonConnectorConfig

binaryHandlingMode, customConverterRegistry, getConfig, getDataCollectionsToBeSnapshotted, getEventProcessingFailureHandlingMode, getHeartbeatTopicsPrefix, getLogicalName, getMaxBatchSize, getMaxQueueSize, getMaxQueueSizeInBytes, getPollInterval, getQueryFetchSize, getRetriableRestartWait, getSanitizeFieldNames, getSkippedOps, getSnapshotDelay, getSnapshotFetchSize, getSnapshotMaxThreads, getSourceInfoStructMaker, isEmitTombstoneOnDelete, shouldProvideTransactionMetadata, validateServerNameIsDifferentFromHistoryTopicName

Methods inherited from class java.lang.Object

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

Field Detail

DATABASE_CONFIG_PREFIX

public static final String DATABASE_CONFIG_PREFIX

See Also:

Constant Field Values

DEFAULT_PORT

protected static final int DEFAULT_PORT

See Also:

Constant Field Values

HOSTNAME

public static final io.debezium.config.Field HOSTNAME

PORT

public static final io.debezium.config.Field PORT

USER

public static final io.debezium.config.Field USER

PASSWORD

public static final io.debezium.config.Field PASSWORD

DATABASE_NAME

public static final io.debezium.config.Field DATABASE_NAME

PDB_NAME

public static final io.debezium.config.Field PDB_NAME

SCHEMA_NAME

public static final io.debezium.config.Field SCHEMA_NAME

XSTREAM_SERVER_NAME

public static final io.debezium.config.Field XSTREAM_SERVER_NAME

SNAPSHOT_MODE

public static final io.debezium.config.Field SNAPSHOT_MODE

TABLENAME_CASE_INSENSITIVE

public static final io.debezium.config.Field TABLENAME_CASE_INSENSITIVE

ORACLE_VERSION

public static final io.debezium.config.Field ORACLE_VERSION

SERVER_NAME

public static final io.debezium.config.Field SERVER_NAME

CONNECTOR_ADAPTER

public static final io.debezium.config.Field CONNECTOR_ADAPTER

LOG_MINING_STRATEGY

public static final io.debezium.config.Field LOG_MINING_STRATEGY

CONTINUOUS_MINE

public static final io.debezium.config.Field CONTINUOUS_MINE

SNAPSHOT_ENHANCEMENT_TOKEN

public static final io.debezium.config.Field SNAPSHOT_ENHANCEMENT_TOKEN

LOG_MINING_HISTORY_RECORDER_CLASS

public static final io.debezium.config.Field LOG_MINING_HISTORY_RECORDER_CLASS

LOG_MINING_HISTORY_RETENTION

public static final io.debezium.config.Field LOG_MINING_HISTORY_RETENTION

RAC_SYSTEM

public static final io.debezium.config.Field RAC_SYSTEM

RAC_NODES

public static final io.debezium.config.Field RAC_NODES

URL

public static final io.debezium.config.Field URL

LOG_MINING_ARCHIVE_LOG_HOURS

public static final io.debezium.config.Field LOG_MINING_ARCHIVE_LOG_HOURS

ALL_FIELDS

public static io.debezium.config.Field.Set ALL_FIELDS

The set of Fields defined as part of this configuration.

databaseName

private final String databaseName

pdbName

private final String pdbName

xoutServerName

private final String xoutServerName

snapshotMode

private final OracleConnectorConfig.SnapshotMode snapshotMode

tablenameCaseInsensitive

private final boolean tablenameCaseInsensitive

oracleVersion

private final OracleVersion oracleVersion

schemaName

private final String schemaName

columnFilter

private final io.debezium.relational.Tables.ColumnNameFilter columnFilter

logMiningHistoryRecorder

private final HistoryRecorder logMiningHistoryRecorder

Constructor Detail

OracleConnectorConfig

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

Method Detail

toUpperCase

private static String toUpperCase(String property)

resolveLogMiningHistoryRecorder

private static HistoryRecorder resolveLogMiningHistoryRecorder(io.debezium.config.Configuration config)

getColumnNameFilter

protected io.debezium.relational.Tables.ColumnNameFilter getColumnNameFilter(String excludedColumnPatterns)

configDef

public static org.apache.kafka.common.config.ConfigDef configDef()

getDatabaseName

public String getDatabaseName()

getPdbName

public String getPdbName()

getXoutServerName

public String getXoutServerName()

getSnapshotMode

public OracleConnectorConfig.SnapshotMode getSnapshotMode()

getTablenameCaseInsensitive

public boolean getTablenameCaseInsensitive()

getOracleVersion

public OracleVersion getOracleVersion()

getSchemaName

public String getSchemaName()

getColumnFilter

public io.debezium.relational.Tables.ColumnNameFilter getColumnFilter()

getHistoryRecordComparator

protected io.debezium.relational.history.HistoryRecordComparator getHistoryRecordComparator()

Specified by:

getHistoryRecordComparator in class io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig

getSourceInfoStructMaker

protected io.debezium.connector.SourceInfoStructMaker<? extends io.debezium.connector.AbstractSourceInfo> getSourceInfoStructMaker(io.debezium.config.CommonConnectorConfig.Version version)

Specified by:

getSourceInfoStructMaker in class io.debezium.config.CommonConnectorConfig

getContextName

public String getContextName()

Specified by:

getContextName in class io.debezium.config.CommonConnectorConfig

getAdapter

public OracleConnectorConfig.ConnectorAdapter getAdapter()

Returns:

connection adapter

getLogMiningStrategy

public OracleConnectorConfig.LogMiningStrategy getLogMiningStrategy()

Returns:

Log Mining strategy

isLogMiningHistoryRecorded

public Boolean isLogMiningHistoryRecorded()

Returns:

whether log mining history is recorded

getLogMiningHistoryRecorder

public HistoryRecorder getLogMiningHistoryRecorder()

Returns:

the log mining history recorder implementation, may be null

getLogMinerHistoryRetentionHours

public long getLogMinerHistoryRetentionHours()

Returns:

the number of hours log mining history is retained if history is recorded

isRacSystem

public Boolean isRacSystem()

Returns:

whether Oracle is using RAC

getRacNodes

public Set<String> getRacNodes()

Returns:

set of node hosts or ip addresses used in Oracle RAC

getTokenToReplaceInSnapshotPredicate

public String getTokenToReplaceInSnapshotPredicate()

Returns:

String token to replace

isContinuousMining

public boolean isContinuousMining()

Returns:

whether continuous log mining is enabled

getLogMiningArchiveLogRetention

public Duration getLogMiningArchiveLogRetention()

Returns:

the duration that archive logs are scanned for log mining

validateSnapshotMode

private static int validateSnapshotMode(io.debezium.config.Configuration config,
                                        io.debezium.config.Field field,
                                        io.debezium.config.Field.ValidationOutput problems)

Validate the time.precision.mode configuration. If adaptive is specified, this option has the potential to cause overflow which is why the option was deprecated and no longer supported for this connector.

getConnectorName

public String getConnectorName()

Specified by:

getConnectorName in class io.debezium.config.CommonConnectorConfig

validateDatabaseSchema

public static int validateDatabaseSchema(io.debezium.config.Configuration config,
                                         io.debezium.config.Field field,
                                         io.debezium.config.Field.ValidationOutput problems)

validateOutServerName

public static int validateOutServerName(io.debezium.config.Configuration config,
                                        io.debezium.config.Field field,
                                        io.debezium.config.Field.ValidationOutput problems)

requiredWhenNoUrl

public static int requiredWhenNoUrl(io.debezium.config.Configuration config,
                                    io.debezium.config.Field field,
                                    io.debezium.config.Field.ValidationOutput problems)

requiredWhenNoHostname

public static int requiredWhenNoHostname(io.debezium.config.Configuration config,
                                         io.debezium.config.Field field,
                                         io.debezium.config.Field.ValidationOutput problems)