Package io.debezium.jdbc
Interface JdbcConfiguration
- All Superinterfaces:
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
Modifier and TypeInterfaceDescriptionstatic interface
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
Modifier and TypeFieldDescriptionstatic final Field
An optional field for datasource factory class that will be used to build the datasource connection pool.static final Field
static final Field
A field for the name of the database.static final Field
A field for the hostname of the database server.static final Field
A semicolon separated list of SQL statements to be executed when the connection to database is established.static final Field
A field for the password of the database.static final Field
A field for the port of the database server.static final Field
A field for the user of the database.Fields inherited from interface io.debezium.config.Configuration
CONFIGURATION_LOGGER, PASSWORD_PATTERN
-
Method Summary
Modifier and TypeMethodDescriptionstatic JdbcConfiguration
adapt
(Configuration config) Obtain aJdbcConfiguration
adapter for the givenConfiguration
.static JdbcConfiguration.Builder
copy
(Configuration config) Create a newconfiguration builder
that starts with a copy of the supplied configuration.static JdbcConfiguration.Builder
create()
Create a newconfiguration builder
that starts with an empty configuration.static JdbcConfiguration
empty()
Obtain an empty configuration.default String
Get the datasource factory property from the configuration.default Duration
Get the connection timeout from the configuration.default String
Get the database name property from the configuration.default String
Get the hostname property from the configuration.default String
Get the password property from the configuration.default int
getPort()
Get the port property from the configuration.default String
Get the port property from the configuration.default String
getUser()
Get the user property from the configuration.Get a predicate that determines if supplied keys are pre-defined field names.default Configuration
Get a view of this configuration that does not contain theknown fields
.Methods inherited from interface io.debezium.config.Configuration
asMap, asMap, asProperties, asProperties, edit, filter, forEach, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithString, forEachMatchingFieldNameWithString, forEachMatchingFieldNameWithString, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getDuration, getFallbackStringProperty, getFallbackStringPropertyWithWarning, 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, getTrimmedStrings, hasKey, hasKey, isEmpty, keys, map, mapped, subset, validate, validate, validateAndRecord, withMasked, withMasked, withMaskedPasswords, withReplacedVariables, withSystemProperties, withSystemProperties
-
Field Details
-
DATABASE
A field for the name of the database. This field has no default value. -
USER
A field for the user of the database. This field has no default value. -
PASSWORD
A field for the password of the database. This field has no default value. -
HOSTNAME
A field for the hostname of the database server. This field has no default value. -
PORT
A field for the port of the database server. There is no default value. -
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. -
CONNECTION_FACTORY_CLASS
An optional field for datasource factory class that will be used to build the datasource connection pool. -
CONNECTION_TIMEOUT_MS
-
ALL_KNOWN_FIELDS
-
-
Method Details
-
adapt
Obtain aJdbcConfiguration
adapter for the givenConfiguration
.- Parameters:
config
- the configuration; may not be null- Returns:
- the ClientConfiguration; never null
-
empty
Description copied from interface:Configuration
Obtain an empty configuration.- Returns:
- an empty configuration; never null
-
copy
Create a newconfiguration builder
that starts with a copy of the supplied configuration.- Parameters:
config
- the configuration to copy- Returns:
- the configuration builder
-
create
Create a newconfiguration builder
that starts with an empty configuration.- Returns:
- the configuration builder
-
knownFieldNames
Get a predicate that determines if supplied keys are pre-defined field names.- Returns:
- the predicate; never null
-
withoutKnownFields
Get a view of this configuration that does not contain theknown fields
.- Returns:
- the filtered view of this configuration; never null
-
getHostname
Get the hostname property from the configuration.- Returns:
- the specified or default host name, or null if there is none.
-
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
Get the database name property from the configuration.- Returns:
- the specified or default database name, or null if there is none.
-
getUser
Get the user property from the configuration.- Returns:
- the specified or default username, or null if there is none.
-
getPassword
Get the password property from the configuration.- Returns:
- the specified or default password value, or null if there is none.
-
getConnectionFactoryClassName
Get the datasource factory property from the configuration.- Returns:
- the specified value, or null if there is none.
-
getConnectionTimeout
Get the connection timeout from the configuration.- Returns:
- the specified value, or null if there is none.
-