Package org.apache.iceberg

Class BaseTable

java.lang.Object

org.apache.iceberg.BaseTable

All Implemented Interfaces:

Serializable, HasTableOperations, Table

public class BaseTable
extends Object
implements Table, HasTableOperations, Serializable

Base Table implementation.

This can be extended by providing a TableOperations to the constructor.

Serializing and deserializing a BaseTable object returns a read only implementation of the BaseTable using a StaticTableOperations. This way no Catalog related calls are needed when reading the table data after deserialization.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BaseTable(TableOperations ops, String name)
BaseTable(TableOperations ops, String name, MetricsReporter reporter)

Method Summary

Modifier and Type	Method	Description
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.
List<HistoryEntry>	history()	Get the snapshot history of this table.
FileIO	io()	Returns a FileIO to read and write table data and metadata files.
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.
String	name()	Return the full name for this table.
AppendFiles	newAppend()	Create a new append API to add files to this table and commit.
DeleteFiles	newDelete()	Create a new delete API to replace files in this table and commit.
AppendFiles	newFastAppend()	Create a new append API to add files to this table and commit.
IncrementalAppendScan	newIncrementalAppendScan()	Create a new scan for this table.
IncrementalChangelogScan	newIncrementalChangelogScan()	Create a new IncrementalChangelogScan for this table.
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.
Transaction	newTransaction()	Create a new transaction API to commit multiple table operations at once.
TableOperations	operations()
List<PartitionStatisticsFile>	partitionStatisticsFiles()	Returns the current partition statistics files for the table.
Map<String,String>	properties()	Return a map of string properties for this table.
void	refresh()	Refresh the current table metadata.
Map<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.
Map<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.
Iterable<Snapshot>	snapshots()	Get the snapshots of this table.
SortOrder	sortOrder()	Return the sort order for this table.
Map<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.
Map<Integer,PartitionSpec>	specs()	Return a map of partition specs for this table.
List<StatisticsFile>	statisticsFiles()	Returns the current statistics files for the table
String	toString()
UpdateLocation	updateLocation()	Create a new UpdateLocation to update table location and commit the changes.
UpdatePartitionStatistics	updatePartitionStatistics()	Create a new update partition statistics API to add or remove partition statistics files in this table.
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.
UUID	uuid()	Returns the UUID of the table

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iceberg.Table

newBatchScan, snapshot

Constructor Details

BaseTable

public BaseTable(TableOperations ops,
 String name)

BaseTable

public BaseTable(TableOperations ops,
 String name,
 MetricsReporter reporter)

Method Details

operations

public TableOperations operations()

Specified by:

operations in interface HasTableOperations

name

public 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

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

newIncrementalAppendScan

public IncrementalAppendScan newIncrementalAppendScan()

Description copied from interface: Table

Create a new scan for this table.

Once a scan is created, it can be refined to project columns and filter data.

Specified by:

newIncrementalAppendScan in interface Table

Returns:

an incremental scan for appends only snapshots

newIncrementalChangelogScan

public IncrementalChangelogScan newIncrementalChangelogScan()

Description copied from interface: Table

Create a new IncrementalChangelogScan for this table.

Once a scan is created, it can be refined to project columns and filter data.

Specified by:

newIncrementalChangelogScan in interface Table

Returns:

an incremental changelog scan

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 Map<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 Map<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 Map<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

properties

public Map<String,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

location

public String location()

Description copied from interface: Table

Return the table's base location.

Specified by:

location in interface Table

Returns:

this table's location

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

newFastAppend

public AppendFiles newFastAppend()

Description copied from interface: Table

Create a new append API to add files to this table and commit.

Using this method signals to the underlying implementation that the append should not perform extra work in order to commit quickly. Fast appends are not recommended for normal writes because the fast commit may cause split planning to slow down over time.

Implementations may not support fast appends, in which case this will return the same appender as Table.newAppend().

Specified by:

newFastAppend 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

updatePartitionStatistics

public UpdatePartitionStatistics updatePartitionStatistics()

Description copied from interface: Table

Create a new update partition statistics API to add or remove partition statistics files in this table.

Specified by:

updatePartitionStatistics in interface Table

Returns:

a new UpdatePartitionStatistics

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

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

partitionStatisticsFiles

public List<PartitionStatisticsFile> partitionStatisticsFiles()

Description copied from interface: Table

Returns the current partition statistics files for the table.

Specified by:

partitionStatisticsFiles in interface Table

refs

public Map<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

uuid

public UUID uuid()

Description copied from interface: Table

Returns the UUID of the table

Specified by:

uuid in interface Table

Returns:

the UUID of the table

toString

public String toString()

Overrides:

toString in class Object