Package io.debezium.connector.jdbc

Class JdbcSinkConnectorConfig

java.lang.Object

io.debezium.connector.jdbc.JdbcSinkConnectorConfig

public class JdbcSinkConnectorConfig
extends Object

Connector configuration for the JDBC sink.

Author:

Hossein Torabi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JdbcSinkConnectorConfig.InsertMode	Defines the various different insertion modes supported.
static enum	JdbcSinkConnectorConfig.PrimaryKeyMode	Different modes that which primary keys are handled.
static enum	JdbcSinkConnectorConfig.SchemaEvolutionMode	Different modes that the destination table's schema can be evolved.

Field Summary

Fields

Modifier and Type	Field	Description
static Field.Set	ALL_FIELDS	The set of Fields defined as part of this configuration.
static final String	BATCH_SIZE
static final Field	BATCH_SIZE_FIELD
private final long	batchSize
static final String	COLUMN_NAMING_STRATEGY
static final Field	COLUMN_NAMING_STRATEGY_FIELD
private final ColumnNamingStrategy	columnNamingStrategy
private final Configuration	config
protected static final ConfigDefinition	CONFIG_DEFINITION
static final String	CONNECTION_PASSWORD
static final Field	CONNECTION_PASSWORD_FIELD
static final String	CONNECTION_POOL_ACQUIRE_INCREMENT
static final Field	CONNECTION_POOL_ACQUIRE_INCREMENT_FIELD
static final String	CONNECTION_POOL_MAX_SIZE
static final Field	CONNECTION_POOL_MAX_SIZE_FIELD
static final String	CONNECTION_POOL_MIN_SIZE
static final Field	CONNECTION_POOL_MIN_SIZE_FIELD
static final String	CONNECTION_POOL_TIMEOUT
static final Field	CONNECTION_POOL_TIMEOUT_FIELD
static final String	CONNECTION_PROVIDER
static final Field	CONNECTION_PROVIDER_FIELD
static final String	CONNECTION_URL
static final Field	CONNECTION_URL_FIELD
static final String	CONNECTION_USER
static final Field	CONNECTION_USER_FIELD
static final String	DATA_TYPE_MAPPING
static final String	DATABASE_TIME_ZONE
static final Field	DATABASE_TIME_ZONE_FIELD
private final String	databaseTimezone
private static final String	DEFAULT_DATABASE_TIME_ZONE
static final String	DELETE_ENABLED
static final Field	DELETE_ENABLED_FIELD
private final boolean	deleteEnabled
static final String	FIELD_EXCLUDE_LIST
static final Field	FIELD_EXCLUDE_LIST_FIELD
static final String	FIELD_INCLUDE_LIST
static final Field	FIELD_INCLUDE_LIST_FIELD
private FieldFilterFactory.FieldNameFilter	fieldsFilter
static final String	FLUSH_MAX_RETRIES
static final Field	FLUSH_MAX_RETRIES_FIELD
static final String	FLUSH_RETRY_DELAY_MS
static final Field	FLUSH_RETRY_DELAY_MS_FIELD
private final int	flushMaxRetries
private final long	flushRetryDelayMs
private static final String	HIBERNATE_PREFIX
static final String	INSERT_MODE
static final Field	INSERT_MODE_FIELD
private final JdbcSinkConnectorConfig.InsertMode	insertMode
private static final org.slf4j.Logger	LOGGER
static final String	POSTGRES_POSTGIS_SCHEMA
static final Field	POSTGRES_POSTGIS_SCHEMA_FIELD
private final String	postgresPostgisSchema
static final String	PRIMARY_KEY_FIELDS
static final Field	PRIMARY_KEY_FIELDS_FIELD
static final String	PRIMARY_KEY_MODE
static final Field	PRIMARY_KEY_MODE_FIELD
private final Set<String>	primaryKeyFields
private final JdbcSinkConnectorConfig.PrimaryKeyMode	primaryKeyMode
static final String	QUOTE_IDENTIFIERS
static final Field	QUOTE_IDENTIFIERS_FIELD
private final boolean	quoteIdentifiers
static final String	SCHEMA_EVOLUTION
static final Field	SCHEMA_EVOLUTION_FIELD
private final JdbcSinkConnectorConfig.SchemaEvolutionMode	schemaEvolutionMode
static final String	SQLSERVER_IDENTITY_INSERT
static final Field	SQLSERVER_IDENTITY_INSERT_FIELD
private final boolean	sqlServerIdentityInsert
static final String	TABLE_NAME_FORMAT
static final Field	TABLE_NAME_FORMAT_FIELD
static final String	TABLE_NAMING_STRATEGY
static final Field	TABLE_NAMING_STRATEGY_FIELD
private final String	tableNameFormat
private final TableNamingStrategy	tableNamingStrategy
static final String	TRUNCATE_ENABLED
static final Field	TRUNCATE_ENABLED_FIELD
private final boolean	truncateEnabled
static final String	USE_REDUCTION_BUFFER
static final Field	USE_REDUCTION_BUFFER_FIELD
private final boolean	useReductionBuffer

Constructor Summary

Constructors

Constructor	Description
JdbcSinkConnectorConfig(Map<String,String> props)

Method Summary

Modifier and Type	Method	Description
protected static org.apache.kafka.common.config.ConfigDef	configDef()
long	getBatchSize()
ColumnNamingStrategy	getColumnNamingStrategy()
String	getConnectorName()
String	getContextName()
String	getDatabaseTimeZone()
FieldFilterFactory.FieldNameFilter	getFieldsFilter()
int	getFlushMaxRetries()
long	getFlushRetryDelayMs()
org.hibernate.cfg.Configuration	getHibernateConfiguration()	makes Configuration from connector config
JdbcSinkConnectorConfig.InsertMode	getInsertMode()
String	getPostgresPostgisSchema()
Set<String>	getPrimaryKeyFields()
JdbcSinkConnectorConfig.PrimaryKeyMode	getPrimaryKeyMode()
JdbcSinkConnectorConfig.SchemaEvolutionMode	getSchemaEvolutionMode()
String	getTableNameFormat()
TableNamingStrategy	getTableNamingStrategy()
boolean	isDeleteEnabled()
boolean	isQuoteIdentifiers()
boolean	isSqlServerIdentityInsert()
boolean	isTruncateEnabled()
boolean	isUseReductionBuffer()
void	validate()
boolean	validateAndRecord(Iterable<Field> fields, Consumer<String> problems)
private static int	validateDeleteEnabled(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateInsertMode(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 Details

LOGGER

private static final org.slf4j.Logger LOGGER

HIBERNATE_PREFIX

private static final String HIBERNATE_PREFIX

See Also:

• Constant Field Values

DEFAULT_DATABASE_TIME_ZONE

private static final String DEFAULT_DATABASE_TIME_ZONE

See Also:

• Constant Field Values

CONNECTION_PROVIDER

public static final String CONNECTION_PROVIDER

See Also:

• Constant Field Values

CONNECTION_URL

public static final String CONNECTION_URL

See Also:

• Constant Field Values

CONNECTION_USER

public static final String CONNECTION_USER

See Also:

• Constant Field Values

CONNECTION_PASSWORD

public static final String CONNECTION_PASSWORD

See Also:

• Constant Field Values

CONNECTION_POOL_MIN_SIZE

public static final String CONNECTION_POOL_MIN_SIZE

See Also:

• Constant Field Values

CONNECTION_POOL_MAX_SIZE

public static final String CONNECTION_POOL_MAX_SIZE

See Also:

• Constant Field Values

CONNECTION_POOL_ACQUIRE_INCREMENT

public static final String CONNECTION_POOL_ACQUIRE_INCREMENT

See Also:

• Constant Field Values

CONNECTION_POOL_TIMEOUT

public static final String CONNECTION_POOL_TIMEOUT

See Also:

• Constant Field Values

INSERT_MODE

public static final String INSERT_MODE

See Also:

• Constant Field Values

DELETE_ENABLED

public static final String DELETE_ENABLED

See Also:

• Constant Field Values

TRUNCATE_ENABLED

public static final String TRUNCATE_ENABLED

See Also:

• Constant Field Values

TABLE_NAME_FORMAT

public static final String TABLE_NAME_FORMAT

See Also:

• Constant Field Values

PRIMARY_KEY_MODE

public static final String PRIMARY_KEY_MODE

See Also:

• Constant Field Values

PRIMARY_KEY_FIELDS

public static final String PRIMARY_KEY_FIELDS

See Also:

• Constant Field Values

SCHEMA_EVOLUTION

public static final String SCHEMA_EVOLUTION

See Also:

• Constant Field Values

QUOTE_IDENTIFIERS

public static final String QUOTE_IDENTIFIERS

See Also:

• Constant Field Values

DATA_TYPE_MAPPING

public static final String DATA_TYPE_MAPPING

See Also:

• Constant Field Values

TABLE_NAMING_STRATEGY

public static final String TABLE_NAMING_STRATEGY

See Also:

• Constant Field Values

COLUMN_NAMING_STRATEGY

public static final String COLUMN_NAMING_STRATEGY

See Also:

• Constant Field Values

DATABASE_TIME_ZONE

public static final String DATABASE_TIME_ZONE

See Also:

• Constant Field Values

POSTGRES_POSTGIS_SCHEMA

public static final String POSTGRES_POSTGIS_SCHEMA

See Also:

• Constant Field Values

SQLSERVER_IDENTITY_INSERT

public static final String SQLSERVER_IDENTITY_INSERT

See Also:

• Constant Field Values

BATCH_SIZE

public static final String BATCH_SIZE

See Also:

• Constant Field Values

FIELD_INCLUDE_LIST

public static final String FIELD_INCLUDE_LIST

See Also:

• Constant Field Values

FIELD_EXCLUDE_LIST

public static final String FIELD_EXCLUDE_LIST

See Also:

• Constant Field Values

USE_REDUCTION_BUFFER

public static final String USE_REDUCTION_BUFFER

See Also:

• Constant Field Values

FLUSH_MAX_RETRIES

public static final String FLUSH_MAX_RETRIES

See Also:

• Constant Field Values

FLUSH_RETRY_DELAY_MS

public static final String FLUSH_RETRY_DELAY_MS

See Also:

• Constant Field Values

CONNECTION_PROVIDER_FIELD

public static final Field CONNECTION_PROVIDER_FIELD

CONNECTION_URL_FIELD

public static final Field CONNECTION_URL_FIELD

CONNECTION_USER_FIELD

public static final Field CONNECTION_USER_FIELD

CONNECTION_PASSWORD_FIELD

public static final Field CONNECTION_PASSWORD_FIELD

CONNECTION_POOL_MIN_SIZE_FIELD

public static final Field CONNECTION_POOL_MIN_SIZE_FIELD

CONNECTION_POOL_MAX_SIZE_FIELD

public static final Field CONNECTION_POOL_MAX_SIZE_FIELD

CONNECTION_POOL_ACQUIRE_INCREMENT_FIELD

public static final Field CONNECTION_POOL_ACQUIRE_INCREMENT_FIELD

CONNECTION_POOL_TIMEOUT_FIELD

public static final Field CONNECTION_POOL_TIMEOUT_FIELD

INSERT_MODE_FIELD

public static final Field INSERT_MODE_FIELD

DELETE_ENABLED_FIELD

public static final Field DELETE_ENABLED_FIELD

TRUNCATE_ENABLED_FIELD

public static final Field TRUNCATE_ENABLED_FIELD

TABLE_NAME_FORMAT_FIELD

public static final Field TABLE_NAME_FORMAT_FIELD

PRIMARY_KEY_MODE_FIELD

public static final Field PRIMARY_KEY_MODE_FIELD

PRIMARY_KEY_FIELDS_FIELD

public static final Field PRIMARY_KEY_FIELDS_FIELD

DATABASE_TIME_ZONE_FIELD

public static final Field DATABASE_TIME_ZONE_FIELD

SCHEMA_EVOLUTION_FIELD

public static final Field SCHEMA_EVOLUTION_FIELD

QUOTE_IDENTIFIERS_FIELD

public static final Field QUOTE_IDENTIFIERS_FIELD

TABLE_NAMING_STRATEGY_FIELD

public static final Field TABLE_NAMING_STRATEGY_FIELD

COLUMN_NAMING_STRATEGY_FIELD

public static final Field COLUMN_NAMING_STRATEGY_FIELD

POSTGRES_POSTGIS_SCHEMA_FIELD

public static final Field POSTGRES_POSTGIS_SCHEMA_FIELD

SQLSERVER_IDENTITY_INSERT_FIELD

public static final Field SQLSERVER_IDENTITY_INSERT_FIELD

BATCH_SIZE_FIELD

public static final Field BATCH_SIZE_FIELD

FLUSH_MAX_RETRIES_FIELD

public static final Field FLUSH_MAX_RETRIES_FIELD

FLUSH_RETRY_DELAY_MS_FIELD

public static final Field FLUSH_RETRY_DELAY_MS_FIELD

FIELD_INCLUDE_LIST_FIELD

public static final Field FIELD_INCLUDE_LIST_FIELD

FIELD_EXCLUDE_LIST_FIELD

public static final Field FIELD_EXCLUDE_LIST_FIELD

USE_REDUCTION_BUFFER_FIELD

public static final Field USE_REDUCTION_BUFFER_FIELD

CONFIG_DEFINITION

protected static final ConfigDefinition CONFIG_DEFINITION

ALL_FIELDS

public static Field.Set ALL_FIELDS

The set of Fields defined as part of this configuration.

config

private final Configuration config

insertMode

private final JdbcSinkConnectorConfig.InsertMode insertMode

deleteEnabled

private final boolean deleteEnabled

truncateEnabled

private final boolean truncateEnabled

tableNameFormat

private final String tableNameFormat

primaryKeyMode

private final JdbcSinkConnectorConfig.PrimaryKeyMode primaryKeyMode

primaryKeyFields

private final Set<String> primaryKeyFields

schemaEvolutionMode

private final JdbcSinkConnectorConfig.SchemaEvolutionMode schemaEvolutionMode

quoteIdentifiers

private final boolean quoteIdentifiers

tableNamingStrategy

private final TableNamingStrategy tableNamingStrategy

columnNamingStrategy

private final ColumnNamingStrategy columnNamingStrategy

databaseTimezone

private final String databaseTimezone

postgresPostgisSchema

private final String postgresPostgisSchema

sqlServerIdentityInsert

private final boolean sqlServerIdentityInsert

flushMaxRetries

private final int flushMaxRetries

flushRetryDelayMs

private final long flushRetryDelayMs

fieldsFilter

private FieldFilterFactory.FieldNameFilter fieldsFilter

batchSize

private final long batchSize

useReductionBuffer

private final boolean useReductionBuffer

Constructor Details

JdbcSinkConnectorConfig

public JdbcSinkConnectorConfig(Map<String,String> props)

Method Details

validate

public void validate()

validateAndRecord

public boolean validateAndRecord(Iterable<Field> fields,
 Consumer<String> problems)

configDef

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

getInsertMode

public JdbcSinkConnectorConfig.InsertMode getInsertMode()

isDeleteEnabled

public boolean isDeleteEnabled()

isTruncateEnabled

public boolean isTruncateEnabled()

getTableNameFormat

public String getTableNameFormat()

getPrimaryKeyMode

public JdbcSinkConnectorConfig.PrimaryKeyMode getPrimaryKeyMode()

getPrimaryKeyFields

public Set<String> getPrimaryKeyFields()

getSchemaEvolutionMode

public JdbcSinkConnectorConfig.SchemaEvolutionMode getSchemaEvolutionMode()

isQuoteIdentifiers

public boolean isQuoteIdentifiers()

isSqlServerIdentityInsert

public boolean isSqlServerIdentityInsert()

getBatchSize

public long getBatchSize()

isUseReductionBuffer

public boolean isUseReductionBuffer()

getTableNamingStrategy

public TableNamingStrategy getTableNamingStrategy()

getColumnNamingStrategy

public ColumnNamingStrategy getColumnNamingStrategy()

getFieldsFilter

public FieldFilterFactory.FieldNameFilter getFieldsFilter()

getDatabaseTimeZone

public String getDatabaseTimeZone()

getPostgresPostgisSchema

public String getPostgresPostgisSchema()

getFlushMaxRetries

public int getFlushMaxRetries()

getFlushRetryDelayMs

public long getFlushRetryDelayMs()

getHibernateConfiguration

public org.hibernate.cfg.Configuration getHibernateConfiguration()

makes Configuration from connector config

Returns:

Configuration

getContextName

public String getContextName()

getConnectorName

public String getConnectorName()

validateInsertMode

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

validateDeleteEnabled

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