org.apache.paimon.catalog

Interface SupportsSnapshots

All Superinterfaces:

AutoCloseable, Catalog

All Known Implementing Classes:

RESTCatalog

public interface SupportsSnapshots
extends Catalog

A Catalog supports committing and loading table snapshots.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.catalog.Catalog

Catalog.ColumnAlreadyExistException, Catalog.ColumnNotExistException, Catalog.DatabaseAlreadyExistException, Catalog.DatabaseNoPermissionException, Catalog.DatabaseNotEmptyException, Catalog.DatabaseNotExistException, Catalog.ProcessSystemDatabaseException, Catalog.TableAlreadyExistException, Catalog.TableNoPermissionException, Catalog.TableNotExistException, Catalog.ViewAlreadyExistException, Catalog.ViewNotExistException

Field Summary

Fields inherited from interface org.apache.paimon.catalog.Catalog

COMMENT_PROP, DB_LOCATION_PROP, DB_SUFFIX, DEFAULT_DATABASE, LAST_UPDATE_TIME_PROP, NUM_FILES_PROP, NUM_ROWS_PROP, OWNER_PROP, SYSTEM_BRANCH_PREFIX, SYSTEM_DATABASE_NAME, SYSTEM_TABLE_SPLITTER, TABLE_DEFAULT_OPTION_PREFIX, TOTAL_SIZE_PROP

Method Summary

Modifier and Type	Method and Description
boolean	commitSnapshot(Identifier identifier, Snapshot snapshot, List<Partition> statistics) Commit the Snapshot for table identified by the given Identifier.
Optional<Snapshot>	loadSnapshot(Identifier identifier) Return the snapshot of table identified by the given Identifier.

Methods inherited from interface org.apache.paimon.catalog.Catalog

alterDatabase, alterPartitions, alterTable, alterTable, caseSensitive, catalogLoader, createDatabase, createDatabase, createPartitions, createTable, createView, dropDatabase, dropPartitions, dropTable, dropView, getDatabase, getTable, getView, invalidateTable, listDatabases, listPartitions, listTables, listViews, markDonePartitions, options, renameTable, renameView, repairCatalog, repairDatabase, repairTable

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

commitSnapshot

boolean commitSnapshot(Identifier identifier,
                       Snapshot snapshot,
                       List<Partition> statistics)
                throws Catalog.TableNotExistException

Commit the Snapshot for table identified by the given Identifier.

Parameters:

identifier - Path of the table

snapshot - Snapshot to be committed

statistics - statistics information of this change

Returns:

Success or not

Throws:

Catalog.TableNotExistException - if the target does not exist

loadSnapshot

Optional<Snapshot> loadSnapshot(Identifier identifier)
                         throws Catalog.TableNotExistException

Return the snapshot of table identified by the given Identifier.

Parameters:

identifier - Path of the table

Returns:

The requested snapshot of the table

Throws:

Catalog.TableNotExistException - if the target does not exist