Package io.debezium.relational.history

Class AbstractDatabaseHistory

java.lang.Object

io.debezium.relational.history.AbstractDatabaseHistory

All Implemented Interfaces:

DatabaseHistory

Direct Known Subclasses:

FileDatabaseHistory, KafkaDatabaseHistory, MemoryDatabaseHistory

public abstract class AbstractDatabaseHistory
extends Object
implements DatabaseHistory

Author:

Randall Hauch

Field Summary

Fields

Modifier and Type	Field	Description
private HistoryRecordComparator	comparator
protected Configuration	config
private Function<String,Optional<Pattern>>	ddlFilter
static Field	INTERNAL_PREFER_DDL
private DatabaseHistoryListener	listener
protected org.slf4j.Logger	logger
private boolean	preferDdl
private boolean	skipUnparseableDDL
private boolean	storeOnlyCapturedTablesDdl
private TableChanges.TableChangesSerializer<Array>	tableChangesSerializer
private boolean	useCatalogBeforeSchema

Fields inherited from interface io.debezium.relational.history.DatabaseHistory

CONFIGURATION_FIELD_PREFIX_STRING, DDL_FILTER, NAME, SKIP_UNPARSEABLE_DDL_STATEMENTS, STORE_ONLY_CAPTURED_TABLES_DDL, STORE_ONLY_MONITORED_TABLES_DDL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDatabaseHistory()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration config, HistoryRecordComparator comparator, DatabaseHistoryListener listener, boolean useCatalogBeforeSchema)	Configure this instance.
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.
protected abstract void	recoverRecords(Consumer<HistoryRecord> records)
boolean	skipUnparseableDdlStatements()
void	start()	Start the history.
void	stop()	Stop recording history and release any resources acquired since #configure(Configuration, HistoryRecordComparator, DatabaseHistoryListener).
boolean	storeOnlyCapturedTables()
protected abstract void	storeRecord(HistoryRecord record)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.debezium.relational.history.DatabaseHistory

exists, storageExists

Field Detail

logger

protected final org.slf4j.Logger logger

INTERNAL_PREFER_DDL

public static final Field INTERNAL_PREFER_DDL

config

protected Configuration config

comparator

private HistoryRecordComparator comparator

skipUnparseableDDL

private boolean skipUnparseableDDL

storeOnlyCapturedTablesDdl

private boolean storeOnlyCapturedTablesDdl

ddlFilter

private Function<String,Optional<Pattern>> ddlFilter

listener

private DatabaseHistoryListener listener

useCatalogBeforeSchema

private boolean useCatalogBeforeSchema

preferDdl

private boolean preferDdl

tableChangesSerializer

private TableChanges.TableChangesSerializer<Array> tableChangesSerializer

Constructor Detail

AbstractDatabaseHistory

protected AbstractDatabaseHistory()

Method Detail

configure

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

Description copied from interface: DatabaseHistory

Configure this instance.

Specified by:

configure in interface DatabaseHistory

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

public void start()

Description copied from interface: DatabaseHistory

Start the history.

Specified by:

start in interface DatabaseHistory

record

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

Description copied from interface: DatabaseHistory

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

Specified by:

record in interface DatabaseHistory

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

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

Specified by:

record in interface DatabaseHistory

Throws:

DatabaseHistoryException

recover

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

Description copied from interface: DatabaseHistory

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.

Specified by:

recover in interface DatabaseHistory

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

storeRecord

protected abstract void storeRecord(HistoryRecord record)
                             throws DatabaseHistoryException

Throws:

DatabaseHistoryException

recoverRecords

protected abstract void recoverRecords(Consumer<HistoryRecord> records)

stop

public void stop()

Description copied from interface: DatabaseHistory

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

Specified by:

stop in interface DatabaseHistory

initializeStorage

public void initializeStorage()

Description copied from interface: DatabaseHistory

Called to initialize permanent storage of the history.

Specified by:

initializeStorage in interface DatabaseHistory

storeOnlyCapturedTables

public boolean storeOnlyCapturedTables()

Specified by:

storeOnlyCapturedTables in interface DatabaseHistory

skipUnparseableDdlStatements

public boolean skipUnparseableDdlStatements()

Specified by:

skipUnparseableDdlStatements in interface DatabaseHistory