Package io.debezium.connector.binlog.util

Class UniqueDatabase

java.lang.Object
io.debezium.connector.binlog.util.UniqueDatabase
public abstract class UniqueDatabase extends Object
Create and populate a unique instance of a binlog-based connector database for each run of a Junit test. A user of class needs to provide a logical name for Debezium and the database. It is expected that there is an init file in src/test/resources/ddl/<database_name>.sql.

The database name is enriched with a unique suffix that guarantees complete isolation between runs: <database_name>_<suffix>
Author:
jpechane, Chris Cranford

  • Field Details

    • TIMEZONE

      public static final ZoneId TIMEZONE

    • DEFAULT_DATABASE

      private static final String DEFAULT_DATABASE
      See Also:

    • CREATE_DATABASE_DDL

      private static final String[] CREATE_DATABASE_DDL

    • CREATE_DATABASE_WITH_CHARSET_DDL

      private static final String[] CREATE_DATABASE_WITH_CHARSET_DDL

    • COMMENT_PATTERN

      private static final Pattern COMMENT_PATTERN

    • databaseName

      private final String databaseName

    • charset

      private final String charset

    • templateName

      private final String templateName

    • serverName

      private final String serverName

    • dbHistoryPath

      private Path dbHistoryPath

    • identifier

      private final String identifier

  • Constructor Details

    • UniqueDatabase

      public UniqueDatabase(String serverName, String databaseName, String identifier, String charset)

    • UniqueDatabase

      public UniqueDatabase(String serverName, String databaseName)
      Creates an instance with given Debezium logical name and database name
      Parameters:
      serverName - - logical Debezium server name
      databaseName - - the name of the database (prix)

    • UniqueDatabase

      public UniqueDatabase(String serverName, String databaseName, String charset)
      Creates an instance with given Debezium logical name and database name and a set default charset
      Parameters:
      serverName - - logical Debezium server name
      databaseName - - the name of the database (prix)

    • UniqueDatabase

      public UniqueDatabase(String serverName, String databaseName, UniqueDatabase sibling)
      Creates an instance with given Debezium logical name and database name and id suffix same as another database. This is handy for tests that need multpli databases and can use regex based whitelisting.
      Parameters:
      serverName - - logical Debezium server name
      databaseName - - the name of the database (prix)
      sibling - - a database whose unique suffix will be used

  • Method Details

    • convertSQL

      private String convertSQL(String sql)

    • getDatabaseName

      public String getDatabaseName()

    • topicForTable

      public String topicForTable(String tableName)
      Parameters:
      tableName -
      Returns:
      Fully qualified Kafka topic name for a given table <serverName>.<databaseName>.<tableName>

    • qualifiedTableName

      public String qualifiedTableName(String tableName)
      Parameters:
      tableName -
      Returns:
      Fully qualified table name <databaseName>.<tableName>

    • getServerName

      public String getServerName()

    • getTopicPrefix

      public String getTopicPrefix()

    • createAndInitialize

      public void createAndInitialize()
      Creates the database and populates it with initialization SQL script. To use multiline statements for stored procedures definition use delimiter $$ to delimit statements in the procedure. See fnDbz162 procedure in reqression_test.sql for example of usage.

    • createAndInitialize

      public void createAndInitialize(Map<String,Object> urlProperties)
      Creates the database and populates it with initialization SQL script. To use multiline statements for stored procedures definition use delimiter $$ to delimit statements in the procedure. See fnDbz162 procedure in reqression_test.sql for example of usage.
      Parameters:
      urlProperties - jdbc url properties

    • readFileContents

      private List<String> readFileContents(URI uri, Function<Stream<String>,List<String>> handler) throws IOException
      Supports reading the contents of the SQL file, regardless if its bundled in a jar or not.
      Parameters:
      uri - the file URI
      handler - the handler to receive the file contents
      Returns:
      the contents
      Throws:
      IOException - if there was an error reading the file contents

    • withDbHistoryPath

      public UniqueDatabase withDbHistoryPath(Path dbHistoryPath)
      Parameters:
      dbHistoryPath - - directory where to store database schema history
      See Also:
      • FileSchemaHistory

    • defaultJdbcConfigBuilder

      public Configuration.Builder defaultJdbcConfigBuilder()
      Returns:
      Configuration builder initialized with JDBC connection parameters.

    • defaultConfig

      public Configuration.Builder defaultConfig()
      Returns:
      Configuration builder initialized with JDBC connection parameters and most frequently used parameters

    • defaultConfigWithoutDatabaseFilter

      public Configuration.Builder defaultConfigWithoutDatabaseFilter()
      Returns:
      Configuration builder initialized with JDBC connection parameters and most frequently used parameters, database not filtered by default

    • getIdentifier

      public String getIdentifier()
      Returns:
      The unique database suffix

    • timezone

      public ZoneId timezone()
      Returns:
      timezone in which the database is located

    • applyConnectorDefaultJdbcConfiguration

      protected Configuration.Builder applyConnectorDefaultJdbcConfiguration(Configuration.Builder builder)

    • forTestDatabase

      protected abstract JdbcConnection forTestDatabase(String databaseName, Map<String,Object> urlProperties)