org.apache.paimon.privilege

Class PrivilegedFileStoreTable

java.lang.Object

org.apache.paimon.table.DelegatedFileStoreTable

org.apache.paimon.privilege.PrivilegedFileStoreTable

All Implemented Interfaces:

Serializable, DataTable, FileStoreTable, InnerTable, Table

Direct Known Subclasses:

PrivilegedObjectTable

public class PrivilegedFileStoreTable
extends DelegatedFileStoreTable

FileStoreTable with privilege checks.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Identifier	identifier
protected PrivilegeChecker	privilegeChecker

Fields inherited from class org.apache.paimon.table.DelegatedFileStoreTable

wrapped

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrivilegedFileStoreTable(FileStoreTable wrapped, PrivilegeChecker privilegeChecker, Identifier identifier)

Method Summary

Modifier and Type	Method and Description
BranchManager	branchManager()
PrivilegedFileStoreTable	copy(Map<String,String> dynamicOptions) Copy this table with adding dynamic options.
PrivilegedFileStoreTable	copy(TableSchema newTableSchema)
PrivilegedFileStoreTable	copyWithLatestSchema() TODO: this method is weird, old options will overwrite new options.
PrivilegedFileStoreTable	copyWithoutTimeTravel(Map<String,String> dynamicOptions) Doesn't change table schema even when there exists time travel scan 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.
void	deleteTag(String tagName) Delete a tag by name.
boolean	equals(Object o)
void	fastForward(String branchName) Merge a branch to main branch.
OptionalLong	latestSnapshotId() Get the latest snapshot id for this table, or empty if there are no snapshots.
TableCommitImpl	newCommit(String commitUser)
ExpireSnapshots	newExpireChangelog()
ExpireSnapshots	newExpireSnapshots() Manually expire snapshots, parameters can be controlled independently of table options.
LocalTableQuery	newLocalTableQuery()
InnerTableRead	newRead()
DataTableScan	newScan()
SnapshotReader	newSnapshotReader()
StreamDataTableScan	newStreamScan()
TableWriteImpl<?>	newWrite(String commitUser)
TableWriteImpl<?>	newWrite(String commitUser, ManifestCacheFilter manifestFilter)
Optional<WriteSelector>	newWriteSelector()
void	renameTag(String tagName, String targetTagName)
void	rollbackTo(long snapshotId) Rollback table's state to a specific snapshot.
void	rollbackTo(String tagName) Rollback table's state to a specific tag.
Snapshot	snapshot(long snapshotId) Get the Snapshot from snapshot id.
SnapshotManager	snapshotManager()
Optional<Statistics>	statistics() Optional statistics of this table.
FileStore<?>	store()
PrivilegedFileStoreTable	switchToBranch(String branchName) Get DataTable with branch identified by branchName.
TagManager	tagManager()
static PrivilegedFileStoreTable	wrap(FileStoreTable table, PrivilegeChecker privilegeChecker, Identifier identifier)

Methods inherited from class org.apache.paimon.table.DelegatedFileStoreTable

catalogEnvironment, coreOptions, createRowKeyExtractor, fileIO, fullName, indexManifestFileReader, location, manifestFileReader, manifestListReader, name, replaceTag, schema, schemaManager, setManifestCache, setSnapshotCache, supportStreamingReadOverwrite, uuid, wrapped

Methods inherited from class java.lang.Object

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

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

bucketMode, bucketSpec, comment, options, partitionKeys, primaryKeys, rowType

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

newBatchWriteBuilder, newReadBuilder, newStreamWriteBuilder

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

deleteBranches, deleteTags

Field Detail

privilegeChecker

protected final PrivilegeChecker privilegeChecker

identifier

protected final Identifier identifier

Constructor Detail

PrivilegedFileStoreTable

protected PrivilegedFileStoreTable(FileStoreTable wrapped,
                                   PrivilegeChecker privilegeChecker,
                                   Identifier identifier)

Method Detail

snapshotManager

public SnapshotManager snapshotManager()

Specified by:

snapshotManager in interface DataTable

Overrides:

snapshotManager in class DelegatedFileStoreTable

latestSnapshotId

public OptionalLong latestSnapshotId()

Description copied from interface: Table

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

Specified by:

latestSnapshotId in interface Table

Overrides:

latestSnapshotId in class DelegatedFileStoreTable

snapshot

public Snapshot snapshot(long snapshotId)

Description copied from interface: Table

Get the Snapshot from snapshot id.

Specified by:

snapshot in interface Table

Overrides:

snapshot in class DelegatedFileStoreTable

newSnapshotReader

public SnapshotReader newSnapshotReader()

Specified by:

newSnapshotReader in interface DataTable

Overrides:

newSnapshotReader in class DelegatedFileStoreTable

tagManager

public TagManager tagManager()

Specified by:

tagManager in interface DataTable

Overrides:

tagManager in class DelegatedFileStoreTable

branchManager

public BranchManager branchManager()

Specified by:

branchManager in interface DataTable

Overrides:

branchManager in class DelegatedFileStoreTable

store

public FileStore<?> store()

Specified by:

store in interface FileStoreTable

Overrides:

store in class DelegatedFileStoreTable

statistics

public Optional<Statistics> statistics()

Description copied from interface: Table

Optional statistics of this table.

Specified by:

statistics in interface Table

Overrides:

statistics in class DelegatedFileStoreTable

rollbackTo

public void rollbackTo(long snapshotId)

Description copied from interface: Table

Rollback table's state to a specific snapshot.

Specified by:

rollbackTo in interface Table

Overrides:

rollbackTo in class DelegatedFileStoreTable

createTag

public void createTag(String tagName)

Description copied from interface: Table

Create a tag from latest snapshot.

Specified by:

createTag in interface Table

Overrides:

createTag in class DelegatedFileStoreTable

createTag

public void createTag(String tagName,
                      long fromSnapshotId)

Description copied from interface: Table

Create a tag from given snapshot.

Specified by:

createTag in interface Table

Overrides:

createTag in class DelegatedFileStoreTable

createTag

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

Specified by:

createTag in interface Table

Overrides:

createTag in class DelegatedFileStoreTable

renameTag

public void renameTag(String tagName,
                      String targetTagName)

Specified by:

renameTag in interface Table

Overrides:

renameTag in class DelegatedFileStoreTable

createTag

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

Specified by:

createTag in interface Table

Overrides:

createTag in class DelegatedFileStoreTable

deleteTag

public void deleteTag(String tagName)

Description copied from interface: Table

Delete a tag by name.

Specified by:

deleteTag in interface Table

Overrides:

deleteTag in class DelegatedFileStoreTable

rollbackTo

public void rollbackTo(String tagName)

Description copied from interface: Table

Rollback table's state to a specific tag.

Specified by:

rollbackTo in interface Table

Overrides:

rollbackTo in class DelegatedFileStoreTable

createBranch

public void createBranch(String branchName)

Description copied from interface: Table

Create an empty branch.

Specified by:

createBranch in interface Table

Overrides:

createBranch in class DelegatedFileStoreTable

createBranch

public void createBranch(String branchName,
                         String tagName)

Description copied from interface: Table

Create a branch from given tag.

Specified by:

createBranch in interface Table

Overrides:

createBranch in class DelegatedFileStoreTable

deleteBranch

public void deleteBranch(String branchName)

Description copied from interface: Table

Delete a branch by branchName.

Specified by:

deleteBranch in interface Table

Overrides:

deleteBranch in class DelegatedFileStoreTable

fastForward

public void fastForward(String branchName)

Description copied from interface: Table

Merge a branch to main branch.

Specified by:

fastForward in interface Table

Overrides:

fastForward in class DelegatedFileStoreTable

newExpireSnapshots

public ExpireSnapshots newExpireSnapshots()

Description copied from interface: Table

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

Specified by:

newExpireSnapshots in interface Table

Overrides:

newExpireSnapshots in class DelegatedFileStoreTable

newExpireChangelog

public ExpireSnapshots newExpireChangelog()

Specified by:

newExpireChangelog in interface Table

Overrides:

newExpireChangelog in class DelegatedFileStoreTable

newScan

public DataTableScan newScan()

Specified by:

newScan in interface DataTable

Specified by:

newScan in interface InnerTable

Overrides:

newScan in class DelegatedFileStoreTable

newStreamScan

public StreamDataTableScan newStreamScan()

Specified by:

newStreamScan in interface InnerTable

Overrides:

newStreamScan in class DelegatedFileStoreTable

newRead

public InnerTableRead newRead()

Specified by:

newRead in interface InnerTable

Overrides:

newRead in class DelegatedFileStoreTable

newWriteSelector

public Optional<WriteSelector> newWriteSelector()

Specified by:

newWriteSelector in interface InnerTable

Overrides:

newWriteSelector in class DelegatedFileStoreTable

newWrite

public TableWriteImpl<?> newWrite(String commitUser)

Specified by:

newWrite in interface FileStoreTable

Specified by:

newWrite in interface InnerTable

Overrides:

newWrite in class DelegatedFileStoreTable

newWrite

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

Specified by:

newWrite in interface FileStoreTable

Overrides:

newWrite in class DelegatedFileStoreTable

newCommit

public TableCommitImpl newCommit(String commitUser)

Specified by:

newCommit in interface FileStoreTable

Specified by:

newCommit in interface InnerTable

Overrides:

newCommit in class DelegatedFileStoreTable

newLocalTableQuery

public LocalTableQuery newLocalTableQuery()

Specified by:

newLocalTableQuery in interface FileStoreTable

Overrides:

newLocalTableQuery in class DelegatedFileStoreTable

equals

public boolean equals(Object o)

Overrides:

equals in class DelegatedFileStoreTable

copy

public PrivilegedFileStoreTable copy(Map<String,String> dynamicOptions)

Description copied from interface: Table

Copy this table with adding dynamic options.

copy

public PrivilegedFileStoreTable copy(TableSchema newTableSchema)

copyWithoutTimeTravel

public PrivilegedFileStoreTable copyWithoutTimeTravel(Map<String,String> dynamicOptions)

Description copied from interface: FileStoreTable

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

copyWithLatestSchema

public PrivilegedFileStoreTable copyWithLatestSchema()

Description copied from interface: FileStoreTable

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

switchToBranch

public PrivilegedFileStoreTable switchToBranch(String branchName)

Description copied from interface: FileStoreTable

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

wrap

public static PrivilegedFileStoreTable wrap(FileStoreTable table,
                                            PrivilegeChecker privilegeChecker,
                                            Identifier identifier)