org.apache.paimon.table.object

Interface ObjectTable

All Superinterfaces:

DataTable, FileStoreTable, InnerTable, Serializable, Table

All Known Implementing Classes:

ObjectTable.ObjectTableImpl, PrivilegedObjectTable

public interface ObjectTable
extends FileStoreTable

An object table refers to a directory that contains multiple objects (files). Object table provides metadata indexes for unstructured data objects in this directory, allowing users to analyze unstructured data in Object Storage.

Object Table stores the metadata of objects in the underlying table.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectTable.Builder Builder for ObjectTable.
static class	ObjectTable.ObjectTableImpl An implementation for ObjectTable.

Field Summary

Fields

Modifier and Type	Field and Description
static RowType	SCHEMA

Method Summary

Modifier and Type	Method and Description
static ObjectTable.Builder	builder() Create a new builder for ObjectTable.
ObjectTable	copy(Map<String,String> dynamicOptions) Copy this table with adding dynamic options.
ObjectTable	copy(TableSchema newTableSchema)
ObjectTable	copyWithLatestSchema() TODO: this method is weird, old options will overwrite new options.
ObjectTable	copyWithoutTimeTravel(Map<String,String> dynamicOptions) Doesn't change table schema even when there exists time travel scan options.
FileIO	objectFileIO() File io for object file system.
String	objectLocation() Object location in file system.
long	refresh()
ObjectTable	switchToBranch(String branchName) Get DataTable with branch identified by branchName.
FileStoreTable	underlyingTable() Underlying table to store metadata.

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

bucketMode, bucketSpec, catalogEnvironment, comment, createRowKeyExtractor, newCommit, newLocalTableQuery, newWrite, newWrite, options, partitionKeys, primaryKeys, purgeFiles, rowType, schema, setManifestCache, setSnapshotCache, setStatsCache, store, supportStreamingReadOverwrite

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

Field Detail

SCHEMA

static final RowType SCHEMA

Method Detail

objectLocation

String objectLocation()

Object location in file system.

underlyingTable

FileStoreTable underlyingTable()

Underlying table to store metadata.

objectFileIO

FileIO objectFileIO()

File io for object file system.

refresh

long refresh()

copy

ObjectTable copy(Map<String,String> dynamicOptions)

Description copied from interface: Table

Copy this table with adding dynamic options.

Specified by:

copy in interface FileStoreTable

Specified by:

copy in interface Table

copy

ObjectTable copy(TableSchema newTableSchema)

Specified by:

copy in interface FileStoreTable

copyWithoutTimeTravel

ObjectTable copyWithoutTimeTravel(Map<String,String> dynamicOptions)

Description copied from interface: FileStoreTable

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

Specified by:

copyWithoutTimeTravel in interface FileStoreTable

copyWithLatestSchema

ObjectTable copyWithLatestSchema()

Description copied from interface: FileStoreTable

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

Specified by:

copyWithLatestSchema in interface FileStoreTable

switchToBranch

ObjectTable 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.

Specified by:

switchToBranch in interface DataTable

Specified by:

switchToBranch in interface FileStoreTable

builder

static ObjectTable.Builder builder()

Create a new builder for ObjectTable.