Package io.debezium.relational.history

Class AbstractSchemaHistory

java.lang.Object

io.debezium.relational.history.AbstractSchemaHistory

All Implemented Interfaces:

SchemaHistory

Direct Known Subclasses:

AbstractFileBasedSchemaHistory, MemorySchemaHistory

public abstract class AbstractSchemaHistory
extends Object
implements SchemaHistory

Author:

Randall Hauch

Field Summary

Fields

Modifier and Type	Field	Description
static Field.Set	ALL_FIELDS
private HistoryRecordComparator	comparator
protected Configuration	config
private Predicate<String>	ddlFilter
private SchemaHistoryListener	listener
protected final org.slf4j.Logger	logger
private boolean	preferDdl
private boolean	skipUnparseableDDL
private final TableChanges.TableChangesSerializer<Array>	tableChangesSerializer
private boolean	useCatalogBeforeSchema

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

CONFIGURATION_FIELD_PREFIX_STRING, DDL_FILTER, INTERNAL_CONNECTOR_CLASS, INTERNAL_CONNECTOR_ID, INTERNAL_PREFER_DDL, NAME, SKIP_UNPARSEABLE_DDL_STATEMENTS, STORE_ONLY_CAPTURED_DATABASES_DDL, STORE_ONLY_CAPTURED_TABLES_DDL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSchemaHistory()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration config, HistoryRecordComparator comparator, SchemaHistoryListener listener, boolean useCatalogBeforeSchema)	Configure this instance.
void	initializeStorage()	Called to initialize permanent storage of the history.
final 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.
final void	record(Map<String,?> source, Map<String,?> position, String databaseName, String schemaName, String ddl, TableChanges changes, Instant timestamp)
void	recover(Map<Map<String,?>,Map<String,?>> offsets, Tables schema, DdlParser ddlParser)
protected abstract void	recoverRecords(Consumer<HistoryRecord> records)
void	start()	Start the history.
void	stop()	Stop recording history and release any resources acquired since SchemaHistory.configure(Configuration, HistoryRecordComparator, SchemaHistoryListener, boolean).
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.SchemaHistory

exists, recover, recover, storageExists

Field Details

logger

protected final org.slf4j.Logger logger

ALL_FIELDS

public static Field.Set ALL_FIELDS

config

protected Configuration config

comparator

private HistoryRecordComparator comparator

skipUnparseableDDL

private boolean skipUnparseableDDL

ddlFilter

private Predicate<String> ddlFilter

listener

private SchemaHistoryListener listener

useCatalogBeforeSchema

private boolean useCatalogBeforeSchema

preferDdl

private boolean preferDdl

tableChangesSerializer

private final TableChanges.TableChangesSerializer<Array> tableChangesSerializer

Constructor Details

AbstractSchemaHistory

protected AbstractSchemaHistory()

Method Details

configure

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

Description copied from interface: SchemaHistory

Configure this instance.

Specified by:

configure in interface SchemaHistory

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: SchemaHistory

Start the history.

Specified by:

start in interface SchemaHistory

record

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

Description copied from interface: SchemaHistory

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

Specified by:

record in interface SchemaHistory

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:

SchemaHistoryException - 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,
 Instant timestamp)
                  throws SchemaHistoryException

Specified by:

record in interface SchemaHistory

Throws:

SchemaHistoryException

recover

public void recover(Map<Map<String,?>,Map<String,?>> offsets,
 Tables schema,
 DdlParser ddlParser)

Specified by:

recover in interface SchemaHistory

storeRecord

protected abstract void storeRecord(HistoryRecord record)
                             throws SchemaHistoryException

Throws:

SchemaHistoryException

recoverRecords

protected abstract void recoverRecords(Consumer<HistoryRecord> records)

stop

public void stop()

Description copied from interface: SchemaHistory

Stop recording history and release any resources acquired since SchemaHistory.configure(Configuration, HistoryRecordComparator, SchemaHistoryListener, boolean).

Specified by:

stop in interface SchemaHistory

initializeStorage

public void initializeStorage()

Description copied from interface: SchemaHistory

Called to initialize permanent storage of the history.

Specified by:

initializeStorage in interface SchemaHistory