java.lang.Object
- org.apache.iceberg.SerializableTable

All Implemented Interfaces:

java.io.Serializable, Table

Direct Known Subclasses:

SerializableTable.SerializableMetadataTable, SerializableTableWithSize
```
public class SerializableTable
extends java.lang.Object
implements Table, java.io.Serializable
```
A read-only serializable table that can be sent to other nodes in a cluster.
An instance of this class represents an immutable serializable copy of a table state and will not reflect any subsequent changed made to the original table.
While this class captures the metadata file location that can be used to load the complete table metadata, it directly persists the current schema, spec, sort order, table properties to avoid reading the metadata file from other nodes for frequently needed metadata.
The implementation assumes the passed instances of FileIO, EncryptionManager, LocationProvider are serializable. If you are serializing the table using a custom serialization framework like Kryo, those instances of FileIO, EncryptionManager, LocationProvider must be supported by that particular serialization framework.
Note: loading the complete metadata from a large number of nodes can overwhelm the storage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SerializableTable.SerializableMetadataTable

Constructor Summary

Constructors
Modifier Constructor Description

protected SerializableTable(Table table)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Table`	`copyOf(Table table)`	Creates a read-only serializable table that can be sent to other nodes in a cluster.
`Snapshot`	`currentSnapshot()`	Get the current `snapshot` for this table, or null if there are no snapshots.
`EncryptionManager`	`encryption()`	Returns an `EncryptionManager` to encrypt and decrypt data files.
`ExpireSnapshots`	`expireSnapshots()`	Create a new `expire API` to manage snapshots in this table and commit.
`java.util.List<HistoryEntry>`	`history()`	Get the snapshot history of this table.
`FileIO`	`io()`	Returns a `FileIO` to read and write table data and metadata files.
`java.lang.String`	`location()`	Return the table's base location.
`LocationProvider`	`locationProvider()`	Returns a `LocationProvider` to provide locations for new data files.
`ManageSnapshots`	`manageSnapshots()`	Create a new `manage snapshots API` to manage snapshots in this table and commit.
`java.lang.String`	`name()`	Return the full name for this table.
`AppendFiles`	`newAppend()`	Create a new `append API` to add files to this table and commit.
`BatchScan`	`newBatchScan()`	Create a new `batch scan` for this table.
`DeleteFiles`	`newDelete()`	Create a new `delete API` to replace files in this table and commit.
`OverwriteFiles`	`newOverwrite()`	Create a new `overwrite API` to overwrite files by a filter expression.
`ReplacePartitions`	`newReplacePartitions()`	Not recommended: Create a new `replace partitions API` to dynamically overwrite partitions in the table with new data.
`RewriteFiles`	`newRewrite()`	Create a new `rewrite API` to replace files in this table and commit.
`RowDelta`	`newRowDelta()`	Create a new `row-level delta API` to remove or replace rows in existing data files.
`TableScan`	`newScan()`	Create a new `scan` for this table.
`protected Table`	`newTable(TableOperations ops, java.lang.String tableName)`
`Transaction`	`newTransaction()`	Create a new `transaction API` to commit multiple table operations at once.
`java.util.Map<java.lang.String,java.lang.String>`	`properties()`	Return a map of string properties for this table.
`void`	`refresh()`	Refresh the current table metadata.
`java.util.Map<java.lang.String,SnapshotRef>`	`refs()`	Returns the current refs for the table
`ReplaceSortOrder`	`replaceSortOrder()`	Create a new `ReplaceSortOrder` to set the table sort order and commit the change.
`RewriteManifests`	`rewriteManifests()`	Create a new `rewrite manifests API` to replace manifests for this table and commit.
`Schema`	`schema()`	Return the `schema` for this table.
`java.util.Map<java.lang.Integer,Schema>`	`schemas()`	Return a map of `schema` for this table.
`Snapshot`	`snapshot(long snapshotId)`	Get the `snapshot` of this table with the given id, or null if there is no matching snapshot.
`java.lang.Iterable<Snapshot>`	`snapshots()`	Get the `snapshots` of this table.
`SortOrder`	`sortOrder()`	Return the `sort order` for this table.
`java.util.Map<java.lang.Integer,SortOrder>`	`sortOrders()`	Return a map of sort order IDs to `sort orders` for this table.
`PartitionSpec`	`spec()`	Return the `partition spec` for this table.
`java.util.Map<java.lang.Integer,PartitionSpec>`	`specs()`	Return a map of `partition specs` for this table.
`java.util.List<StatisticsFile>`	`statisticsFiles()`	Returns the current statistics files for the table
`UpdateLocation`	`updateLocation()`	Create a new `UpdateLocation` to update table location and commit the changes.
`UpdateProperties`	`updateProperties()`	Create a new `UpdateProperties` to update table properties and commit the changes.
`UpdateSchema`	`updateSchema()`	Create a new `UpdateSchema` to alter the columns of this table and commit the change.
`UpdatePartitionSpec`	`updateSpec()`	Create a new `UpdatePartitionSpec` to alter the partition spec of this table and commit the change.
`UpdateStatistics`	`updateStatistics()`	Create a new `update table statistics API` to add or remove statistics files in this table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.iceberg.Table
newFastAppend, newIncrementalAppendScan, newIncrementalChangelogScan, snapshot

- Constructor Detail
  - SerializableTable
```
protected SerializableTable(Table table)
```
- Method Detail
  - copyOf
```
public static Table copyOf(Table table)
```
    Creates a read-only serializable table that can be sent to other nodes in a cluster.
    
    Parameters:
    
    table - the original table to copy the state from
    
    Returns:
    
    a read-only serializable table reflecting the current state of the original table
  - newTable
```
protected Table newTable(TableOperations ops,
                         java.lang.String tableName)
```
  - name
```
public java.lang.String name()
```
    Description copied from interface: Table
    
    Return the full name for this table.
    
    Specified by:
    
    name in interface Table
    
    Returns:
    
    this table's name
  - location
```
public java.lang.String location()
```
    Description copied from interface: Table
    
    Return the table's base location.
    
    Specified by:
    
    location in interface Table
    
    Returns:
    
    this table's location
  - properties
```
public java.util.Map<java.lang.String,java.lang.String> properties()
```
    Description copied from interface: Table
    
    Return a map of string properties for this table.
    
    Specified by:
    
    properties in interface Table
    
    Returns:
    
    this table's properties map
  - schema
```
public Schema schema()
```
    Description copied from interface: Table
    
    Return the schema for this table.
    
    Specified by:
    
    schema in interface Table
    
    Returns:
    
    this table's schema
  - schemas
```
public java.util.Map<java.lang.Integer,Schema> schemas()
```
    Description copied from interface: Table
    
    Return a map of schema for this table.
    
    Specified by:
    
    schemas in interface Table
    
    Returns:
    
    this table's schema map
  - spec
```
public PartitionSpec spec()
```
    Description copied from interface: Table
    
    Return the partition spec for this table.
    
    Specified by:
    
    spec in interface Table
    
    Returns:
    
    this table's partition spec
  - specs
```
public java.util.Map<java.lang.Integer,PartitionSpec> specs()
```
    Description copied from interface: Table
    
    Return a map of partition specs for this table.
    
    Specified by:
    
    specs in interface Table
    
    Returns:
    
    this table's partition specs map
  - sortOrder
```
public SortOrder sortOrder()
```
    Description copied from interface: Table
    
    Return the sort order for this table.
    
    Specified by:
    
    sortOrder in interface Table
    
    Returns:
    
    this table's sort order
  - sortOrders
```
public java.util.Map<java.lang.Integer,SortOrder> sortOrders()
```
    Description copied from interface: Table
    
    Return a map of sort order IDs to sort orders for this table.
    
    Specified by:
    
    sortOrders in interface Table
    
    Returns:
    
    this table's sort orders map
  - io
```
public FileIO io()
```
    Description copied from interface: Table
    
    Returns a FileIO to read and write table data and metadata files.
    
    Specified by:
    
    io in interface Table
  - encryption
```
public EncryptionManager encryption()
```
    Description copied from interface: Table
    
    Returns an EncryptionManager to encrypt and decrypt data files.
    
    Specified by:
    
    encryption in interface Table
  - locationProvider
```
public LocationProvider locationProvider()
```
    Description copied from interface: Table
    
    Returns a LocationProvider to provide locations for new data files.
    
    Specified by:
    
    locationProvider in interface Table
  - statisticsFiles
```
public java.util.List<StatisticsFile> statisticsFiles()
```
    Description copied from interface: Table
    
    Returns the current statistics files for the table
    
    Specified by:
    
    statisticsFiles in interface Table
    
    Returns:
    
    the current statistics files for the table
  - refs
```
public java.util.Map<java.lang.String,SnapshotRef> refs()
```
    Description copied from interface: Table
    
    Returns the current refs for the table
    
    Specified by:
    
    refs in interface Table
    
    Returns:
    
    the current refs for the table
  - refresh
```
public void refresh()
```
    Description copied from interface: Table
    
    Refresh the current table metadata.
    
    Specified by:
    
    refresh in interface Table
  - newScan
```
public TableScan newScan()
```
    Description copied from interface: Table
    
    Create a new scan for this table.
    Once a table scan is created, it can be refined to project columns and filter data.
    
    Specified by:
    
    newScan in interface Table
    
    Returns:
    
    a table scan for this table
  - newBatchScan
```
public BatchScan newBatchScan()
```
    Description copied from interface: Table
    
    Create a new batch scan for this table.
    Once a batch scan is created, it can be refined to project columns and filter data.
    
    Specified by:
    
    newBatchScan in interface Table
    
    Returns:
    
    a batch scan for this table
  - currentSnapshot
```
public Snapshot currentSnapshot()
```
    Description copied from interface: Table
    
    Get the current snapshot for this table, or null if there are no snapshots.
    
    Specified by:
    
    currentSnapshot in interface Table
    
    Returns:
    
    the current table Snapshot.
  - snapshot
```
public Snapshot snapshot(long snapshotId)
```
    Description copied from interface: Table
    
    Get the snapshot of this table with the given id, or null if there is no matching snapshot.
    
    Specified by:
    
    snapshot in interface Table
    
    Returns:
    
    the Snapshot with the given id.
  - snapshots
```
public java.lang.Iterable<Snapshot> snapshots()
```
    Description copied from interface: Table
    
    Get the snapshots of this table.
    
    Specified by:
    
    snapshots in interface Table
    
    Returns:
    
    an Iterable of snapshots of this table.
  - history
```
public java.util.List<HistoryEntry> history()
```
    Description copied from interface: Table
    
    Get the snapshot history of this table.
    
    Specified by:
    
    history in interface Table
    
    Returns:
    
    a list of history entries
  - updateSchema
```
public UpdateSchema updateSchema()
```
    Description copied from interface: Table
    
    Create a new UpdateSchema to alter the columns of this table and commit the change.
    
    Specified by:
    
    updateSchema in interface Table
    
    Returns:
    
    a new UpdateSchema
  - updateSpec
```
public UpdatePartitionSpec updateSpec()
```
    Description copied from interface: Table
    
    Create a new UpdatePartitionSpec to alter the partition spec of this table and commit the change.
    
    Specified by:
    
    updateSpec in interface Table
    
    Returns:
    
    a new UpdatePartitionSpec
  - updateProperties
```
public UpdateProperties updateProperties()
```
    Description copied from interface: Table
    
    Create a new UpdateProperties to update table properties and commit the changes.
    
    Specified by:
    
    updateProperties in interface Table
    
    Returns:
    
    a new UpdateProperties
  - replaceSortOrder
```
public ReplaceSortOrder replaceSortOrder()
```
    Description copied from interface: Table
    
    Create a new ReplaceSortOrder to set the table sort order and commit the change.
    
    Specified by:
    
    replaceSortOrder in interface Table
    
    Returns:
    
    a new ReplaceSortOrder
  - updateLocation
```
public UpdateLocation updateLocation()
```
    Description copied from interface: Table
    
    Create a new UpdateLocation to update table location and commit the changes.
    
    Specified by:
    
    updateLocation in interface Table
    
    Returns:
    
    a new UpdateLocation
  - newAppend
```
public AppendFiles newAppend()
```
    Description copied from interface: Table
    
    Create a new append API to add files to this table and commit.
    
    Specified by:
    
    newAppend in interface Table
    
    Returns:
    
    a new AppendFiles
  - newRewrite
```
public RewriteFiles newRewrite()
```
    Description copied from interface: Table
    
    Create a new rewrite API to replace files in this table and commit.
    
    Specified by:
    
    newRewrite in interface Table
    
    Returns:
    
    a new RewriteFiles
  - rewriteManifests
```
public RewriteManifests rewriteManifests()
```
    Description copied from interface: Table
    
    Create a new rewrite manifests API to replace manifests for this table and commit.
    
    Specified by:
    
    rewriteManifests in interface Table
    
    Returns:
    
    a new RewriteManifests
  - newOverwrite
```
public OverwriteFiles newOverwrite()
```
    Description copied from interface: Table
    
    Create a new overwrite API to overwrite files by a filter expression.
    
    Specified by:
    
    newOverwrite in interface Table
    
    Returns:
    
    a new OverwriteFiles
  - newRowDelta
```
public RowDelta newRowDelta()
```
    Description copied from interface: Table
    
    Create a new row-level delta API to remove or replace rows in existing data files.
    
    Specified by:
    
    newRowDelta in interface Table
    
    Returns:
    
    a new RowDelta
  - newReplacePartitions
```
public ReplacePartitions newReplacePartitions()
```
    Description copied from interface: Table
    
    Not recommended: Create a new replace partitions API to dynamically overwrite partitions in the table with new data.
    This is provided to implement SQL compatible with Hive table operations but is not recommended. Instead, use the overwrite API to explicitly overwrite data.
    
    Specified by:
    
    newReplacePartitions in interface Table
    
    Returns:
    
    a new ReplacePartitions
  - newDelete
```
public DeleteFiles newDelete()
```
    Description copied from interface: Table
    
    Create a new delete API to replace files in this table and commit.
    
    Specified by:
    
    newDelete in interface Table
    
    Returns:
    
    a new DeleteFiles
  - updateStatistics
```
public UpdateStatistics updateStatistics()
```
    Description copied from interface: Table
    
    Create a new update table statistics API to add or remove statistics files in this table.
    
    Specified by:
    
    updateStatistics in interface Table
    
    Returns:
    
    a new UpdateStatistics
  - expireSnapshots
```
public ExpireSnapshots expireSnapshots()
```
    Description copied from interface: Table
    
    Create a new expire API to manage snapshots in this table and commit.
    
    Specified by:
    
    expireSnapshots in interface Table
    
    Returns:
    
    a new ExpireSnapshots
  - manageSnapshots
```
public ManageSnapshots manageSnapshots()
```
    Description copied from interface: Table
    
    Create a new manage snapshots API to manage snapshots in this table and commit.
    
    Specified by:
    
    manageSnapshots in interface Table
    
    Returns:
    
    a new ManageSnapshots
  - newTransaction
```
public Transaction newTransaction()
```
    Description copied from interface: Table
    
    Create a new transaction API to commit multiple table operations at once.
    
    Specified by:
    
    newTransaction in interface Table
    
    Returns:
    
    a new Transaction

Class SerializableTable

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.iceberg.Table

Constructor Detail

SerializableTable

Method Detail

copyOf

newTable

name

location

properties

schema

schemas

spec

specs

sortOrder

sortOrders

io

encryption

locationProvider

statisticsFiles

refs

refresh

newScan

newBatchScan

currentSnapshot

snapshot

snapshots

history

updateSchema

updateSpec

updateProperties

replaceSortOrder

updateLocation

newAppend

newRewrite

rewriteManifests

newOverwrite

newRowDelta

newReplacePartitions

newDelete

updateStatistics

expireSnapshots

manageSnapshots

newTransaction