Package org.apache.iceberg

Class RefsTable

java.lang.Object

org.apache.iceberg.BaseMetadataTable

org.apache.iceberg.RefsTable

All Implemented Interfaces:

Serializable, Table

public class RefsTable
extends BaseMetadataTable

A Table implementation that exposes a table's known snapshot references as rows.

SnapshotRefType stores the valid snapshot references type.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
ExpireSnapshots	expireSnapshots()	Create a new expire API to manage snapshots in this table and commit.
ManageSnapshots	manageSnapshots()	Create a new manage snapshots API to manage snapshots in this table and commit.
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.
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.
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.
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.

Methods inherited from class org.apache.iceberg.BaseMetadataTable

currentSnapshot, encryption, history, io, location, locationProvider, name, partitionStatisticsFiles, properties, refresh, refs, schemas, snapshot, snapshots, sortOrder, sortOrders, spec, specs, statisticsFiles, table, toString, uuid

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, newFastAppend, newIncrementalAppendScan, newIncrementalChangelogScan, snapshot

Method Details

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.

Returns:

a table scan for this table

schema

public Schema schema()

Description copied from interface: Table

Return the schema for this table.

Returns:

this table's schema

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

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