ReadonlyTable (Paimon : 1.0-SNAPSHOT API)

All Superinterfaces:

InnerTable, Serializable, Table

All Known Implementing Classes:

AggregationFieldsTable, AllTableOptionsTable, AuditLogTable, BranchesTable, BucketsTable, CatalogOptionsTable, CompactBucketsTable, ConsumersTable, FileMonitorTable, FilesTable, KnownSplitsTable, ManifestsTable, OptionsTable, PartitionsTable, ReadOptimizedTable, SchemasTable, SinkTableLineageTable, SnapshotsTable, SourceTableLineageTable, StatisticTable, TableLineageTable, TagsTable
```
public interface ReadonlyTable
extends InnerTable
```
Readonly table which only provide implementation for scan and read.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Optional<String>`	`comment()` Optional comment of this table.
`default void`	`createBranch(String branchName)` Create an empty branch.
`default void`	`createBranch(String branchName, String tagName)` Create a branch from given tag.
`default void`	`createTag(String tagName)` Create a tag from latest snapshot.
`default void`	`createTag(String tagName, java.time.Duration timeRetained)`
`default void`	`createTag(String tagName, long fromSnapshotId)` Create a tag from given snapshot.
`default void`	`createTag(String tagName, long fromSnapshotId, java.time.Duration timeRetained)`
`default void`	`deleteBranch(String branchName)` Delete a branch by branchName.
`default void`	`deleteTag(String tagName)` Delete a tag by name.
`default void`	`fastForward(String branchName)` Merge a branch to main branch.
`default SimpleFileReader<IndexManifestEntry>`	`indexManifestFileReader()` Reader to read index manifest entry from index manifest file.
`default OptionalLong`	`latestSnapshotId()` Get the latest snapshot id for this table, or empty if there are no snapshots.
`default SimpleFileReader<ManifestEntry>`	`manifestFileReader()` Reader to read manifest entry from manifest file.
`default SimpleFileReader<ManifestFileMeta>`	`manifestListReader()` Reader to read manifest file meta from manifest list file.
`default BatchWriteBuilder`	`newBatchWriteBuilder()` Returns a new batch write builder.
`default InnerTableCommit`	`newCommit(String commitUser)`
`default ExpireSnapshots`	`newExpireChangelog()`
`default ExpireSnapshots`	`newExpireSnapshots()` Manually expire snapshots, parameters can be controlled independently of table options.
`default StreamDataTableScan`	`newStreamScan()`
`default StreamWriteBuilder`	`newStreamWriteBuilder()` Returns a new stream write builder.
`default InnerTableWrite`	`newWrite(String commitUser)`
`default Optional<WriteSelector>`	`newWriteSelector()`
`default Map<String,String>`	`options()` Options of this table.
`default List<String>`	`partitionKeys()` Partition keys of this table.
`default void`	`renameTag(String tagName, String targetTagName)`
`default void`	`replaceTag(String tagName, Long fromSnapshotId, java.time.Duration timeRetained)` Replace a tag with new snapshot id and new time retained.
`default void`	`rollbackTo(long snapshotId)` Rollback table's state to a specific snapshot.
`default void`	`rollbackTo(String tagName)` Rollback table's state to a specific tag.
`default Snapshot`	`snapshot(long snapshotId)` Get the `Snapshot` from snapshot id.
`default Optional<Statistics>`	`statistics()` Optional statistics of this table.

Methods inherited from interface org.apache.paimon.table.InnerTable
newRead, newReadBuilder, newScan

Methods inherited from interface org.apache.paimon.table.Table
copy, deleteBranches, deleteTags, fullName, name, primaryKeys, rowType

- Method Detail
  - partitionKeys
```
default List<String> partitionKeys()
```
    Description copied from interface: Table
    
    Partition keys of this table.
    
    Specified by:
    
    partitionKeys in interface Table
  - 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
  - statistics
```
default Optional<Statistics> statistics()
```
    Description copied from interface: Table
    
    Optional statistics of this table.
    
    Specified by:
    
    statistics in interface Table
  - newBatchWriteBuilder
```
default BatchWriteBuilder newBatchWriteBuilder()
```
    Description copied from interface: Table
    
    Returns a new batch write builder.
    
    Specified by:
    
    newBatchWriteBuilder in interface InnerTable
    
    Specified by:
    
    newBatchWriteBuilder in interface Table
  - newStreamWriteBuilder
```
default StreamWriteBuilder newStreamWriteBuilder()
```
    Description copied from interface: Table
    
    Returns a new stream write builder.
    
    Specified by:
    
    newStreamWriteBuilder in interface InnerTable
    
    Specified by:
    
    newStreamWriteBuilder in interface Table
  - newWriteSelector
```
default Optional<WriteSelector> newWriteSelector()
```
    Specified by:
    
    newWriteSelector in interface InnerTable
  - newWrite
```
default InnerTableWrite newWrite(String commitUser)
```
    Specified by:
    
    newWrite in interface InnerTable
  - newCommit
```
default InnerTableCommit newCommit(String commitUser)
```
    Specified by:
    
    newCommit in interface InnerTable
  - newStreamScan
```
default StreamDataTableScan newStreamScan()
```
    Specified by:
    
    newStreamScan in interface InnerTable
  - latestSnapshotId
```
default 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
  - snapshot
```
default Snapshot snapshot(long snapshotId)
```
    Description copied from interface: Table
    
    Get the Snapshot from snapshot id.
    
    Specified by:
    
    snapshot in interface Table
  - manifestListReader
```
default SimpleFileReader<ManifestFileMeta> manifestListReader()
```
    Description copied from interface: Table
    
    Reader to read manifest file meta from manifest list file.
    
    Specified by:
    
    manifestListReader in interface Table
  - manifestFileReader
```
default SimpleFileReader<ManifestEntry> manifestFileReader()
```
    Description copied from interface: Table
    
    Reader to read manifest entry from manifest file.
    
    Specified by:
    
    manifestFileReader in interface Table
  - indexManifestFileReader
```
default SimpleFileReader<IndexManifestEntry> indexManifestFileReader()
```
    Description copied from interface: Table
    
    Reader to read index manifest entry from index manifest file.
    
    Specified by:
    
    indexManifestFileReader in interface Table
  - rollbackTo
```
default void rollbackTo(long snapshotId)
```
    Description copied from interface: Table
    
    Rollback table's state to a specific snapshot.
    
    Specified by:
    
    rollbackTo in interface Table
  - createTag
```
default void createTag(String tagName,
                       long fromSnapshotId)
```
    Description copied from interface: Table
    
    Create a tag from given snapshot.
    
    Specified by:
    
    createTag in interface Table
  - createTag
```
default void createTag(String tagName,
                       long fromSnapshotId,
                       java.time.Duration timeRetained)
```
    Specified by:
    
    createTag in interface Table
  - createTag
```
default void createTag(String tagName)
```
    Description copied from interface: Table
    
    Create a tag from latest snapshot.
    
    Specified by:
    
    createTag in interface Table
  - createTag
```
default void createTag(String tagName,
                       java.time.Duration timeRetained)
```
    Specified by:
    
    createTag in interface Table
  - renameTag
```
default void renameTag(String tagName,
                       String targetTagName)
```
    Specified by:
    
    renameTag in interface Table
  - replaceTag
```
default void replaceTag(String tagName,
                        Long fromSnapshotId,
                        java.time.Duration timeRetained)
```
    Description copied from interface: Table
    
    Replace a tag with new snapshot id and new time retained.
    
    Specified by:
    
    replaceTag in interface Table
  - deleteTag
```
default void deleteTag(String tagName)
```
    Description copied from interface: Table
    
    Delete a tag by name.
    
    Specified by:
    
    deleteTag in interface Table
  - rollbackTo
```
default void rollbackTo(String tagName)
```
    Description copied from interface: Table
    
    Rollback table's state to a specific tag.
    
    Specified by:
    
    rollbackTo in interface Table
  - createBranch
```
default void createBranch(String branchName)
```
    Description copied from interface: Table
    
    Create an empty branch.
    
    Specified by:
    
    createBranch in interface Table
  - createBranch
```
default void createBranch(String branchName,
                          String tagName)
```
    Description copied from interface: Table
    
    Create a branch from given tag.
    
    Specified by:
    
    createBranch in interface Table
  - deleteBranch
```
default void deleteBranch(String branchName)
```
    Description copied from interface: Table
    
    Delete a branch by branchName.
    
    Specified by:
    
    deleteBranch in interface Table
  - fastForward
```
default void fastForward(String branchName)
```
    Description copied from interface: Table
    
    Merge a branch to main branch.
    
    Specified by:
    
    fastForward in interface Table
  - newExpireSnapshots
```
default ExpireSnapshots newExpireSnapshots()
```
    Description copied from interface: Table
    
    Manually expire snapshots, parameters can be controlled independently of table options.
    
    Specified by:
    
    newExpireSnapshots in interface Table
  - newExpireChangelog
```
default ExpireSnapshots newExpireChangelog()
```
    Specified by:
    
    newExpireChangelog in interface Table

Back to Paimon Website

Interface ReadonlyTable

Method Summary

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

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

Method Detail

partitionKeys

options

comment

statistics

newBatchWriteBuilder

newStreamWriteBuilder

newWriteSelector

newWrite

newCommit

newStreamScan

latestSnapshotId

snapshot

manifestListReader

manifestFileReader

indexManifestFileReader

rollbackTo

createTag

createTag

createTag

createTag

renameTag

replaceTag

deleteTag

rollbackTo

createBranch

createBranch

deleteBranch

fastForward

newExpireSnapshots

newExpireChangelog

Back to Paimon Website