Package io.debezium.jdbc

Interface JdbcConfiguration

All Superinterfaces:
io.debezium.config.Configuration
@Immutable public interface JdbcConfiguration extends io.debezium.config.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
    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

    io.debezium.config.Configuration.ConfigBuilder<C extends io.debezium.config.Configuration,B extends io.debezium.config.Configuration.ConfigBuilder<C,B>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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.
    static final io.debezium.config.Field
    CONNECTION_FACTORY_CLASS
    An optional field for datasource factory class that will be used to build the datasource connection pool.
    static final io.debezium.config.Field
    CONNECTION_TIMEOUT_MS
     
    static final io.debezium.config.Field
    DATABASE
    A field for the name of the database.
    static final io.debezium.config.Field
    HOSTNAME
    A field for the hostname of the database server.
    static final io.debezium.config.Field
    ON_CONNECT_STATEMENTS
    A semicolon separated list of SQL statements to be executed when the connection to database is established.
    static final io.debezium.config.Field
    PASSWORD
    A field for the password of the database.
    static final io.debezium.config.Field
    PORT
    A field for the port of the database server.
    static final io.debezium.config.Field
    QUERY_TIMEOUT_MS
     
    static final io.debezium.config.Field
    USER
    A field for the user of the database.

    Fields inherited from interface io.debezium.config.Configuration

    CONFIGURATION_LOGGER, CUSTOM_SANITIZE_PATTERN_KEY, PASSWORD_PATTERN

  • Method Summary

    Modifier and Type
    Method
    Description
    static JdbcConfiguration
    adapt(io.debezium.config.Configuration config)
    Obtain a JdbcConfiguration adapter for the given Configuration.
    static JdbcConfiguration.Builder
    copy(io.debezium.config.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.
    static JdbcConfiguration
    empty()
     
    default String
    getConnectionFactoryClassName()
    Get the datasource factory property from the configuration.
    default Duration
    getConnectionTimeout()
    Get the connection timeout from the 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 Duration
    getQueryTimeout()
    Get the query timeout 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 io.debezium.config.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, filter, forEach, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldName, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithBoolean, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithInteger, forEachMatchingFieldNameWithString, forEachMatchingFieldNameWithString, forEachMatchingFieldNameWithString, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getDuration, getInstance, getInstance, getInstance, getInstance, getInstance, getInteger, getInteger, getInteger, getInteger, getInteger, getInteger, getList, getList, getList, getList, getLong, getLong, getLong, getLong, getLong, getLong, getNumber, getNumber, getString, getString, getString, getString, getString, getString, getStrings, getStrings, getTrimmedStrings, hasKey, hasKey, isEmpty, keys, map, mapped, merge, subset, validate, validate, validateAndRecord, withMasked, withMasked, withMaskedPasswords, withReplacedVariables, withSystemProperties, withSystemProperties

  • Field Details

    • DATABASE

      static final io.debezium.config.Field DATABASE
      A field for the name of the database. This field has no default value.

    • USER

      static final io.debezium.config.Field USER
      A field for the user of the database. This field has no default value.

    • PASSWORD

      static final io.debezium.config.Field PASSWORD
      A field for the password of the database. This field has no default value.

    • HOSTNAME

      static final io.debezium.config.Field HOSTNAME
      A field for the hostname of the database server. This field has no default value.

    • PORT

      static final io.debezium.config.Field PORT
      A field for the port of the database server. There is no default value.

    • ON_CONNECT_STATEMENTS

      static final io.debezium.config.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.

    • CONNECTION_FACTORY_CLASS

      static final io.debezium.config.Field CONNECTION_FACTORY_CLASS
      An optional field for datasource factory class that will be used to build the datasource connection pool.

    • CONNECTION_TIMEOUT_MS

      static final io.debezium.config.Field CONNECTION_TIMEOUT_MS

    • QUERY_TIMEOUT_MS

      static final io.debezium.config.Field QUERY_TIMEOUT_MS

    • 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 Details

    • adapt

      static JdbcConfiguration adapt(io.debezium.config.Configuration config)
      Obtain a JdbcConfiguration adapter for the given Configuration.
      Parameters:
      config - the configuration; may not be null
      Returns:
      the ClientConfiguration; never null

    • empty

      static JdbcConfiguration empty()

    • copy

      static JdbcConfiguration.Builder copy(io.debezium.config.Configuration config)
      Create a new configuration builder that starts with a copy of the supplied 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.
      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 io.debezium.config.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.

    • getConnectionFactoryClassName

      default String getConnectionFactoryClassName()
      Get the datasource factory property from the configuration.
      Returns:
      the specified value, or null if there is none.

    • getConnectionTimeout

      default Duration getConnectionTimeout()
      Get the connection timeout from the configuration.
      Returns:
      the specified value, or null if there is none.

    • getQueryTimeout

      default Duration getQueryTimeout()
      Get the query timeout from the configuration.
      Returns:
      the specified value, or null if there is none.