org.apache.paimon.table

Interface Table

All Superinterfaces:

Serializable

All Known Subinterfaces:

DataTable, FileStoreTable, FormatTable, InnerTable, ReadonlyTable

All Known Implementing Classes:

AggregationFieldsTable, AllTableOptionsTable, AuditLogTable, BranchesTable, BucketsTable, CatalogOptionsTable, CompactBucketsTable, ConsumersTable, DelegatedFileStoreTable, FallbackReadFileStoreTable, FileMonitorTable, FilesTable, FormatTable.FormatTableImpl, KnownSplitsTable, LookupFileStoreTable, ManifestsTable, OptionsTable, PartitionsTable, PrivilegedFileStoreTable, ReadOptimizedTable, SchemasTable, SinkTableLineageTable, SnapshotsTable, SourceTableLineageTable, StatisticTable, TableLineageTable, TagsTable

@Public
public interface Table
extends Serializable

A table provides basic abstraction for table type and table scan and table read.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
Optional<String>	comment() Optional comment of this table.
Table	copy(Map<String,String> dynamicOptions) Copy this table with adding dynamic options.
void	createBranch(String branchName) Create an empty branch.
void	createBranch(String branchName, String tagName) Create a branch from given tag.
void	createTag(String tagName) Create a tag from latest snapshot.
void	createTag(String tagName, java.time.Duration timeRetained)
void	createTag(String tagName, long fromSnapshotId) Create a tag from given snapshot.
void	createTag(String tagName, long fromSnapshotId, java.time.Duration timeRetained)
void	deleteBranch(String branchName) Delete a branch by branchName.
default void	deleteBranches(String branchNames) Delete branches, branches are separated by commas.
void	deleteTag(String tagName) Delete a tag by name.
default void	deleteTags(String tagStr) Delete tags, tags are separated by commas.
void	fastForward(String branchName) Merge a branch to main branch.
default String	fullName()
SimpleFileReader<IndexManifestEntry>	indexManifestFileReader() Reader to read index manifest entry from index manifest file.
OptionalLong	latestSnapshotId() Get the latest snapshot id for this table, or empty if there are no snapshots.
SimpleFileReader<ManifestEntry>	manifestFileReader() Reader to read manifest entry from manifest file.
SimpleFileReader<ManifestFileMeta>	manifestListReader() Reader to read manifest file meta from manifest list file.
String	name() A name to identify this table.
BatchWriteBuilder	newBatchWriteBuilder() Returns a new batch write builder.
ExpireSnapshots	newExpireChangelog()
ExpireSnapshots	newExpireSnapshots() Manually expire snapshots, parameters can be controlled independently of table options.
ReadBuilder	newReadBuilder() Returns a new read builder.
StreamWriteBuilder	newStreamWriteBuilder() Returns a new stream write builder.
Map<String,String>	options() Options of this table.
List<String>	partitionKeys() Partition keys of this table.
List<String>	primaryKeys() Primary keys of this table.
void	renameTag(String tagName, String targetTagName)
void	replaceTag(String tagName, Long fromSnapshotId, java.time.Duration timeRetained) Replace a tag with new snapshot id and new time retained.
void	rollbackTo(long snapshotId) Rollback table's state to a specific snapshot.
void	rollbackTo(String tagName) Rollback table's state to a specific tag.
RowType	rowType() Returns the row type of this table.
Snapshot	snapshot(long snapshotId) Get the Snapshot from snapshot id.
Optional<Statistics>	statistics() Optional statistics of this table.

Method Detail

name

String name()

A name to identify this table.

fullName

default String fullName()

rowType

RowType rowType()

Returns the row type of this table.

partitionKeys

List<String> partitionKeys()

Partition keys of this table.

primaryKeys

List<String> primaryKeys()

Primary keys of this table.

options

Map<String,String> options()

Options of this table.

comment

Optional<String> comment()

Optional comment of this table.

statistics

@Experimental
Optional<Statistics> statistics()

Optional statistics of this table.

copy

Table copy(Map<String,String> dynamicOptions)

Copy this table with adding dynamic options.

latestSnapshotId

@Experimental
OptionalLong latestSnapshotId()

Get the latest snapshot id for this table, or empty if there are no snapshots.

snapshot

@Experimental
Snapshot snapshot(long snapshotId)

Get the Snapshot from snapshot id.

manifestListReader

@Experimental
SimpleFileReader<ManifestFileMeta> manifestListReader()

Reader to read manifest file meta from manifest list file.

manifestFileReader

@Experimental
SimpleFileReader<ManifestEntry> manifestFileReader()

Reader to read manifest entry from manifest file.

indexManifestFileReader

@Experimental
SimpleFileReader<IndexManifestEntry> indexManifestFileReader()

Reader to read index manifest entry from index manifest file.

rollbackTo

@Experimental
void rollbackTo(long snapshotId)

Rollback table's state to a specific snapshot.

createTag

@Experimental
void createTag(String tagName,
                             long fromSnapshotId)

Create a tag from given snapshot.

createTag

@Experimental
void createTag(String tagName,
                             long fromSnapshotId,
                             java.time.Duration timeRetained)

createTag

@Experimental
void createTag(String tagName)

Create a tag from latest snapshot.

createTag

@Experimental
void createTag(String tagName,
                             java.time.Duration timeRetained)

renameTag

@Experimental
void renameTag(String tagName,
                             String targetTagName)

replaceTag

@Experimental
void replaceTag(String tagName,
                              Long fromSnapshotId,
                              java.time.Duration timeRetained)

Replace a tag with new snapshot id and new time retained.

deleteTag

@Experimental
void deleteTag(String tagName)

Delete a tag by name.

deleteTags

@Experimental
default void deleteTags(String tagStr)

Delete tags, tags are separated by commas.

rollbackTo

@Experimental
void rollbackTo(String tagName)

Rollback table's state to a specific tag.

createBranch

@Experimental
void createBranch(String branchName)

Create an empty branch.

createBranch

@Experimental
void createBranch(String branchName,
                                String tagName)

Create a branch from given tag.

deleteBranch

@Experimental
void deleteBranch(String branchName)

Delete a branch by branchName.

deleteBranches

@Experimental
default void deleteBranches(String branchNames)

Delete branches, branches are separated by commas.

fastForward

@Experimental
void fastForward(String branchName)

Merge a branch to main branch.

newExpireSnapshots

@Experimental
ExpireSnapshots newExpireSnapshots()

Manually expire snapshots, parameters can be controlled independently of table options.

newExpireChangelog

@Experimental
ExpireSnapshots newExpireChangelog()

newReadBuilder

ReadBuilder newReadBuilder()

Returns a new read builder.

newBatchWriteBuilder

BatchWriteBuilder newBatchWriteBuilder()

Returns a new batch write builder.

newStreamWriteBuilder

StreamWriteBuilder newStreamWriteBuilder()

Returns a new stream write builder.