Package io.debezium.relational.history
Interface SchemaHistory
- All Known Implementing Classes:
AbstractSchemaHistory
,MemorySchemaHistory
public interface SchemaHistory
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Configuration config, HistoryRecordComparator comparator, SchemaHistoryListener listener, boolean useCatalogBeforeSchema) Configure this instance.boolean
exists()
Determines if the database schema history entity exists; i.e.void
Called to initialize permanent storage of the history.void
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, Instant timestamp) default void
Recover thedatabase schema
to a known point in its history.default void
Deprecated.void
Deprecated.Userecover(Offsets, Tables, DdlParser)
instead.boolean
void
start()
Start the history.void
stop()
Stop recording history and release any resources acquired sinceconfigure(Configuration, HistoryRecordComparator, SchemaHistoryListener, boolean)
.boolean
Determines if the underlying storage exists (e.g.boolean
-
Field Details
-
CONFIGURATION_FIELD_PREFIX_STRING
- See Also:
-
NAME
-
SKIP_UNPARSEABLE_DDL_STATEMENTS
-
STORE_ONLY_CAPTURED_TABLES_DDL
-
DDL_FILTER
-
-
Method Details
-
configure
void configure(Configuration config, HistoryRecordComparator comparator, SchemaHistoryListener listener, boolean useCatalogBeforeSchema) Configure this instance.- Parameters:
config
- the configuration for this history storecomparator
- the function that should be used to compare history records duringrecovery
; may be null if thedefault comparator
is to be usedlistener
- TODOuseCatalogBeforeSchema
- 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, throws SchemaHistoryException?> position, String databaseName, String ddl) 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 nullposition
- the point in history where these DDL changes were made, which may be used whenrecovering
the schema to some point in history; may not be nulldatabaseName
- the name of the database whose schema is being changed; may be nullddl
- 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
void record(Map<String, ?> source, Map<String, throws SchemaHistoryException?> position, String databaseName, String schemaName, String ddl, TableChanges changes, Instant timestamp) - Throws:
SchemaHistoryException
-
recover
@Deprecated default void recover(Map<String, ?> source, Map<String, ?> position, Tables schema, DdlParser ddlParser) Deprecated.Userecover(Offsets, Tables, DdlParser)
instead. -
recover
Recover thedatabase 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 beenrecorded
. 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:
offsets
- the map of information about the source database to corresponding point in history at which database schema should be recovered; should contain at least one non-null offset which is enforced inHistorizedRelationalDatabaseSchema.recover(Offsets)
schema
- the table definitions that should be changed to reflect the database schema at the desired point in history; may not be nullddlParser
- the DDL parser that can be used to apply DDL statements to the givenschema
; may not be null
-
recover
@Deprecated void recover(Map<Map<String, ?>, Map<String, ?>> offsets, Tables schema, DdlParser ddlParser) Deprecated.Userecover(Offsets, Tables, DdlParser)
instead. -
stop
void stop()Stop recording history and release any resources acquired sinceconfigure(Configuration, HistoryRecordComparator, SchemaHistoryListener, boolean)
. -
exists
boolean exists()Determines if the database schema history entity exists; i.e. the storage must have been initialized and the history must have been populated. -
storageExists
boolean storageExists()Determines if the underlying storage exists (e.g. a Kafka topic, file or similar). Note: storage may exist while history entities not yet written, seeexists()
-
initializeStorage
void initializeStorage()Called to initialize permanent storage of the history. -
storeOnlyCapturedTables
boolean storeOnlyCapturedTables() -
skipUnparseableDdlStatements
boolean skipUnparseableDdlStatements()
-
recover(Offsets, Tables, DdlParser)
instead.