io.debezium.relational.history

Interface DatabaseHistory

All Known Implementing Classes:

AbstractDatabaseHistory, FileDatabaseHistory, KafkaDatabaseHistory, MemoryDatabaseHistory

public interface DatabaseHistory

A history of the database schema described by a Tables. Changes to the database schema can be recorded, and a database schema can be recovered to various points in that history.

Author:

Randall Hauch

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_FIELD_PREFIX_STRING
static Field	DDL_FILTER
static Field	NAME
static Field	SKIP_UNPARSEABLE_DDL_STATEMENTS
static Field	STORE_ONLY_MONITORED_TABLES_DDL

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration config, HistoryRecordComparator comparator, DatabaseHistoryListener listener, boolean useCatalogBeforeSchema) Configure this instance.
boolean	exists() Determines if the DatabaseHistory entity exists
void	initializeStorage() Called to initialize permanent storage of the history.
void	record(Map<String,?> source, Map<String,?> position, String databaseName, String ddl) Record a change to the schema of the named database, and store it in the schema storage.
void	record(Map<String,?> source, Map<String,?> position, String databaseName, String schemaName, String ddl, TableChanges changes)
void	recover(Map<String,?> source, Map<String,?> position, Tables schema, DdlParser ddlParser) Recover the database schema to a known point in its history.
void	start() Start the history.
void	stop() Stop recording history and release any resources acquired since #configure(Configuration, HistoryRecordComparator, DatabaseHistoryListener).

Field Detail

CONFIGURATION_FIELD_PREFIX_STRING

static final String CONFIGURATION_FIELD_PREFIX_STRING

See Also:

Constant Field Values

NAME

static final Field NAME

SKIP_UNPARSEABLE_DDL_STATEMENTS

static final Field SKIP_UNPARSEABLE_DDL_STATEMENTS

STORE_ONLY_MONITORED_TABLES_DDL

static final Field STORE_ONLY_MONITORED_TABLES_DDL

DDL_FILTER

static final Field DDL_FILTER

Method Detail

configure

void configure(Configuration config,
               HistoryRecordComparator comparator,
               DatabaseHistoryListener listener,
               boolean useCatalogBeforeSchema)

Configure this instance.

Parameters:

config - the configuration for this history store

comparator - the function that should be used to compare history records during recovery; may be null if the default comparator is to be used

listener - TODO

useCatalogBeforeSchema - true if the parsed string for a table contains only 2 items and the first should be used as the catalog and the second as the table name, or false if the first should be used as the schema and the second as the table name

start

void start()

Start the history.

record

void record(Map<String,?> source,
            Map<String,?> position,
            String databaseName,
            String ddl)
     throws DatabaseHistoryException

Record a change to the schema of the named database, and store it in the schema storage.

Parameters:

source - the information about the source database; may not be null

position - the point in history where these DDL changes were made, which may be used when recovering the schema to some point in history; may not be null

databaseName - the name of the database whose schema is being changed; may be null

ddl - the DDL statements that describe the changes to the database schema; may not be null

Throws:

DatabaseHistoryException - if the record could not be written

record

void record(Map<String,?> source,
            Map<String,?> position,
            String databaseName,
            String schemaName,
            String ddl,
            TableChanges changes)
     throws DatabaseHistoryException

Throws:

DatabaseHistoryException

recover

void recover(Map<String,?> source,
             Map<String,?> position,
             Tables schema,
             DdlParser ddlParser)

Recover the database schema to a known point in its history. Note that it is possible to recover the database schema to a point in history that is earlier than what has been recorded. Likewise, when recovering to a point in history later than what was recorded, the database schema will reflect the latest state known to the history.

Parameters:

source - the information about the source database; may not be null

position - the point in history at which the database schema should be recovered; may not be null

schema - the table definitions that should be changed to reflect the database schema at the desired point in history; may not be null

ddlParser - the DDL parser that can be used to apply DDL statements to the given schema; may not be null

stop

void stop()

Stop recording history and release any resources acquired since #configure(Configuration, HistoryRecordComparator, DatabaseHistoryListener).

exists

boolean exists()

Determines if the DatabaseHistory entity exists

Returns:

initializeStorage

void initializeStorage()

Called to initialize permanent storage of the history.