org.apache.paimon.table

Interface FileStoreTable

All Superinterfaces:

DataTable, InnerTable, Serializable, Table

All Known Subinterfaces:

ObjectTable

All Known Implementing Classes:

AppendOnlyFileStoreTable, DelegatedFileStoreTable, FallbackReadFileStoreTable, LookupFileStoreTable, ObjectTable.ObjectTableImpl, PrimaryKeyFileStoreTable, PrivilegedFileStoreTable, PrivilegedObjectTable

public interface FileStoreTable
extends DataTable

An abstraction layer above FileStore to provide reading and writing of InternalRow.

Method Summary

Modifier and Type	Method and Description
default BucketMode	bucketMode()
default BucketSpec	bucketSpec()
CatalogEnvironment	catalogEnvironment()
default Optional<String>	comment() Optional comment of this table.
FileStoreTable	copy(Map<String,String> dynamicOptions) Copy this table with adding dynamic options.
FileStoreTable	copy(TableSchema newTableSchema)
FileStoreTable	copyWithLatestSchema() TODO: this method is weird, old options will overwrite new options.
FileStoreTable	copyWithoutTimeTravel(Map<String,String> dynamicOptions) Doesn't change table schema even when there exists time travel scan options.
RowKeyExtractor	createRowKeyExtractor()
TableCommitImpl	newCommit(String commitUser)
LocalTableQuery	newLocalTableQuery()
TableWriteImpl<?>	newWrite(String commitUser)
TableWriteImpl<?>	newWrite(String commitUser, ManifestCacheFilter manifestFilter)
default Map<String,String>	options() Options of this table.
default List<String>	partitionKeys() Partition keys of this table.
default List<String>	primaryKeys() Primary keys of this table.
default void	purgeFiles() Purge all files in this table.
default RowType	rowType() Returns the row type of this table.
TableSchema	schema()
void	setManifestCache(SegmentsCache<Path> manifestCache)
void	setSnapshotCache(org.apache.paimon.shade.caffeine2.com.github.benmanes.caffeine.cache.Cache<Path,Snapshot> cache)
void	setStatsCache(org.apache.paimon.shade.caffeine2.com.github.benmanes.caffeine.cache.Cache<String,Statistics> cache)
FileStore<?>	store()
boolean	supportStreamingReadOverwrite()
FileStoreTable	switchToBranch(String branchName) Get DataTable with branch identified by branchName.

Methods inherited from interface org.apache.paimon.table.DataTable

branchManager, changelogManager, consumerManager, coreOptions, location, newScan, newSnapshotReader, schemaManager, snapshotManager, tagManager

Methods inherited from interface org.apache.paimon.table.InnerTable

newBatchWriteBuilder, newRead, newReadBuilder, newStreamScan, newStreamWriteBuilder, newWriteSelector

Methods inherited from interface org.apache.paimon.table.Table

createBranch, createBranch, createTag, createTag, createTag, createTag, deleteBranch, deleteBranches, deleteTag, deleteTags, fastForward, fileIO, fullName, indexManifestFileReader, latestSnapshot, manifestFileReader, manifestListReader, name, newExpireChangelog, newExpireSnapshots, renameTag, replaceTag, rollbackTo, rollbackTo, snapshot, statistics, uuid

Method Detail

setManifestCache

void setManifestCache(SegmentsCache<Path> manifestCache)

setSnapshotCache

void setSnapshotCache(org.apache.paimon.shade.caffeine2.com.github.benmanes.caffeine.cache.Cache<Path,Snapshot> cache)

setStatsCache

void setStatsCache(org.apache.paimon.shade.caffeine2.com.github.benmanes.caffeine.cache.Cache<String,Statistics> cache)

rowType

default RowType rowType()

Description copied from interface: Table

Returns the row type of this table.

Specified by:

rowType in interface Table

partitionKeys

default List<String> partitionKeys()

Description copied from interface: Table

Partition keys of this table.

Specified by:

partitionKeys in interface Table

primaryKeys

default List<String> primaryKeys()

Description copied from interface: Table

Primary keys of this table.

Specified by:

primaryKeys in interface Table

bucketSpec

default BucketSpec bucketSpec()

bucketMode

default BucketMode bucketMode()

options

default Map<String,String> options()

Description copied from interface: Table

Options of this table.

Specified by:

options in interface Table

comment

default Optional<String> comment()

Description copied from interface: Table

Optional comment of this table.

Specified by:

comment in interface Table

schema

TableSchema schema()

store

FileStore<?> store()

catalogEnvironment

CatalogEnvironment catalogEnvironment()

copy

FileStoreTable copy(Map<String,String> dynamicOptions)

Description copied from interface: Table

Copy this table with adding dynamic options.

Specified by:

copy in interface Table

copy

FileStoreTable copy(TableSchema newTableSchema)

copyWithoutTimeTravel

FileStoreTable copyWithoutTimeTravel(Map<String,String> dynamicOptions)

Doesn't change table schema even when there exists time travel scan options.

copyWithLatestSchema

FileStoreTable copyWithLatestSchema()

TODO: this method is weird, old options will overwrite new options.

newWrite

TableWriteImpl<?> newWrite(String commitUser)

Specified by:

newWrite in interface InnerTable

newWrite

TableWriteImpl<?> newWrite(String commitUser,
                           ManifestCacheFilter manifestFilter)

newCommit

TableCommitImpl newCommit(String commitUser)

Specified by:

newCommit in interface InnerTable

newLocalTableQuery

LocalTableQuery newLocalTableQuery()

supportStreamingReadOverwrite

boolean supportStreamingReadOverwrite()

createRowKeyExtractor

RowKeyExtractor createRowKeyExtractor()

switchToBranch

FileStoreTable switchToBranch(String branchName)

Get DataTable with branch identified by branchName. Note that this method does not keep dynamic options in current table.

Specified by:

switchToBranch in interface DataTable

purgeFiles

default void purgeFiles()
                 throws Exception

Purge all files in this table.

Throws:

Exception