Package 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

  • Field Details

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

    • CONNECTION_FACTORY_CLASS

      static final 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 Field CONNECTION_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(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()
      Description copied from interface: Configuration
      Obtain an empty configuration.
      Returns:
      an empty configuration; never null

    • copy

      static JdbcConfiguration.Builder copy(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 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.