Package io.debezium.relational.history

Class FileDatabaseHistory

java.lang.Object

io.debezium.relational.history.AbstractDatabaseHistory

io.debezium.relational.history.FileDatabaseHistory

All Implemented Interfaces:

DatabaseHistory

@ThreadSafe
public final class FileDatabaseHistory
extends AbstractDatabaseHistory

A DatabaseHistory implementation that stores the schema history in a local file.

Author:

Randall Hauch

Field Summary

Fields

Modifier and Type	Field	Description
static Collection<Field>	ALL_FIELDS
static final Field	FILE_PATH
private final FunctionalReadWriteLock	lock
private Path	path
private final DocumentReader	reader
private final AtomicBoolean	running
private static final Charset	UTF8
private final DocumentWriter	writer

Fields inherited from class io.debezium.relational.history.AbstractDatabaseHistory

config, INTERNAL_PREFER_DDL, logger

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

Constructor	Description
FileDatabaseHistory()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration config, HistoryRecordComparator comparator, DatabaseHistoryListener listener, boolean useCatalogBeforeSchema)	Configure this instance.
boolean	exists()	Determines if the database history entity exists; i.e.
protected void	recoverRecords(Consumer<HistoryRecord> records)
void	start()	Start the history.
void	stop()	Stop recording history and release any resources acquired since #configure(Configuration, HistoryRecordComparator, DatabaseHistoryListener).
boolean	storageExists()	Determines if the underlying storage exists (e.g.
protected void	storeRecord(HistoryRecord record)
String	toString()

Methods inherited from class io.debezium.relational.history.AbstractDatabaseHistory

initializeStorage, record, record, recover, skipUnparseableDdlStatements, storeOnlyCapturedTables

Methods inherited from class java.lang.Object

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

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

recover, recover

Field Details

FILE_PATH

public static final Field FILE_PATH

ALL_FIELDS

public static Collection<Field> ALL_FIELDS

UTF8

private static final Charset UTF8

lock

private final FunctionalReadWriteLock lock

writer

private final DocumentWriter writer

reader

private final DocumentReader reader

running

private final AtomicBoolean running

path

private Path path

Constructor Details

FileDatabaseHistory

public FileDatabaseHistory()

Method Details

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

Overrides:

configure in class AbstractDatabaseHistory

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

Overrides:

start in class AbstractDatabaseHistory

storeRecord

protected void storeRecord(HistoryRecord record)
                    throws DatabaseHistoryException

Specified by:

storeRecord in class AbstractDatabaseHistory

Throws:

DatabaseHistoryException

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

Overrides:

stop in class AbstractDatabaseHistory

recoverRecords

protected void recoverRecords(Consumer<HistoryRecord> records)

Specified by:

recoverRecords in class AbstractDatabaseHistory

storageExists

public boolean storageExists()

Description copied from interface: DatabaseHistory

Determines if the underlying storage exists (e.g. a Kafka topic, file or similar). Note: storage may exist while history entities not yet written, see DatabaseHistory.exists()

exists

public boolean exists()

Description copied from interface: DatabaseHistory

Determines if the database history entity exists; i.e. the storage must have been initialized and the history must have been populated.

toString

public String toString()

Overrides:

toString in class Object