io.debezium.jdbc

Interface JdbcConfiguration

All Superinterfaces:

Configuration

@Immutable
public interface JdbcConfiguration
extends Configuration

A specialized configuration for the Debezium driver. This defines several known fields that are common to all JDBC configurations.

Author:

Randall Hauch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JdbcConfiguration.Builder The JDBC-specific builder used to construct and/or alter JDBC configuration instances.

Nested classes/interfaces inherited from interface io.debezium.config.Configuration

Configuration.ConfigBuilder<C extends Configuration,B extends Configuration.ConfigBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	ALL_KNOWN_FIELDS The set of names of the pre-defined JDBC configuration fields, including DATABASE, USER, PASSWORD, HOSTNAME, and PORT.
static Field	DATABASE A field for the name of the database.
static Field	HOSTNAME A field for the hostname of the database server.
static Field	ON_CONNECT_STATEMENTS A semicolon separated list of SQL statements to be executed when the connection to database is established.
static Field	PASSWORD A field for the password of the database.
static Field	PORT A field for the port of the database server.
static Field	USER A field for the user of the database.

Fields inherited from interface io.debezium.config.Configuration

PASSWORD_PATTERN

Method Summary

Modifier and Type	Method and Description
static JdbcConfiguration	adapt(Configuration config) Obtain a JdbcConfiguration adapter for the given Configuration.
static JdbcConfiguration.Builder	copy(Configuration config) Create a new configuration builder that starts with a copy of the supplied configuration.
static JdbcConfiguration.Builder	create() Create a new configuration builder that starts with an empty configuration.
default String	getDatabase() Get the database name property from the configuration.
default String	getHostname() Get the hostname property from the configuration.
default String	getPassword() Get the password property from the configuration.
default int	getPort() Get the port property from the configuration.
default String	getPortAsString() Get the port property from the configuration.
default String	getUser() Get the user property from the configuration.
default Predicate<String>	knownFieldNames() Get a predicate that determines if supplied keys are pre-defined field names.
default Configuration	withoutKnownFields() Get a view of this configuration that does not contain the known fields.

Methods inherited from interface io.debezium.config.Configuration

asMap, asMap, asProperties, asProperties, edit, empty, filter, forEach, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithString, forEachMatchingFieldNameWithString, forEachMatchingFieldNameWithString, from, from, from, fromSystemProperties, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getDuration, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInteger, getInteger, getInteger, getInteger, getInteger, getInteger, getLong, getLong, getLong, getLong, getLong, getLong, getNumber, getNumber, getString, getString, getString, getString, getString, getString, getStrings, getStrings, hasKey, isEmpty, keys, load, load, load, load, load, load, load, map, mapped, subset, validate, validate, validateAndRecord, withMasked, withMasked, withMaskedPasswords, withReplacedVariables, withSystemProperties, withSystemProperties

Field Detail

DATABASE

static final Field DATABASE

A field for the name of the database. This field has no default value.

USER

static final Field USER

A field for the user of the database. This field has no default value.

PASSWORD

static final Field PASSWORD

A field for the password of the database. This field has no default value.

HOSTNAME

static final Field HOSTNAME

A field for the hostname of the database server. This field has no default value.

PORT

static final Field PORT

A field for the port of the database server. There is no default value.

ON_CONNECT_STATEMENTS

static final Field ON_CONNECT_STATEMENTS

A semicolon separated list of SQL statements to be executed when the connection to database is established. Typical use-case is setting of session parameters. There is no default value.

ALL_KNOWN_FIELDS

static final Set<String> ALL_KNOWN_FIELDS

The set of names of the pre-defined JDBC configuration fields, including DATABASE, USER, PASSWORD, HOSTNAME, and PORT.

Method Detail

adapt

static JdbcConfiguration adapt(Configuration config)

Obtain a JdbcConfiguration adapter for the given Configuration.

Parameters:

config - the configuration; may not be null

Returns:

the ClientConfiguration; never null

copy

static JdbcConfiguration.Builder copy(Configuration config)

Create a new configuration builder that starts with a copy of the supplied configuration.

Specified by:

copy in interface Configuration

Parameters:

config - the configuration to copy

Returns:

the configuration builder

create

static JdbcConfiguration.Builder create()

Create a new configuration builder that starts with an empty configuration.

Specified by:

create in interface Configuration

Returns:

the configuration builder

knownFieldNames

default Predicate<String> knownFieldNames()

Get a predicate that determines if supplied keys are pre-defined field names.

Returns:

the predicate; never null

withoutKnownFields

default Configuration withoutKnownFields()

Get a view of this configuration that does not contain the known fields.

Returns:

the filtered view of this configuration; never null

getHostname

default String getHostname()

Get the hostname property from the configuration.

Returns:

the specified or default host name, or null if there is none.

getPortAsString

default String getPortAsString()

Get the port property from the configuration.

Returns:

the specified or default port number, or null if there is none.

getPort

default int getPort()

Get the port property from the configuration.

Returns:

the specified or default port number, or null if there is none.

getDatabase

default String getDatabase()

Get the database name property from the configuration.

Returns:

the specified or default database name, or null if there is none.

getUser

default String getUser()

Get the user property from the configuration.

Returns:

the specified or default username, or null if there is none.

getPassword

default String getPassword()

Get the password property from the configuration.

Returns:

the specified or default password value, or null if there is none.