Class BaseTable
- java.lang.Object
-
- org.apache.iceberg.BaseTable
-
- All Implemented Interfaces:
java.io.Serializable
,HasTableOperations
,Table
public class BaseTable extends java.lang.Object implements Table, HasTableOperations, java.io.Serializable
BaseTable
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, java.lang.String name)
BaseTable(TableOperations ops, java.lang.String name, MetricsReporter reporter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Snapshot
currentSnapshot()
Get the currentsnapshot
for this table, or null if there are no snapshots.EncryptionManager
encryption()
Returns anEncryptionManager
to encrypt and decrypt data files.ExpireSnapshots
expireSnapshots()
Create a newexpire API
to manage snapshots in this table and commit.java.util.List<HistoryEntry>
history()
Get the snapshot history of this table.FileIO
io()
Returns aFileIO
to read and write table data and metadata files.java.lang.String
location()
Return the table's base location.LocationProvider
locationProvider()
Returns aLocationProvider
to provide locations for new data files.ManageSnapshots
manageSnapshots()
Create a newmanage 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 newappend API
to add files to this table and commit.DeleteFiles
newDelete()
Create a newdelete API
to replace files in this table and commit.AppendFiles
newFastAppend()
Create a newappend API
to add files to this table and commit.IncrementalAppendScan
newIncrementalAppendScan()
Create a newscan
for this table.IncrementalChangelogScan
newIncrementalChangelogScan()
Create a newIncrementalChangelogScan
for this table.OverwriteFiles
newOverwrite()
Create a newoverwrite API
to overwrite files by a filter expression.ReplacePartitions
newReplacePartitions()
Not recommended: Create a newreplace partitions API
to dynamically overwrite partitions in the table with new data.RewriteFiles
newRewrite()
Create a newrewrite API
to replace files in this table and commit.RowDelta
newRowDelta()
Create a newrow-level delta API
to remove or replace rows in existing data files.TableScan
newScan()
Create a newscan
for this table.Transaction
newTransaction()
Create a newtransaction API
to commit multiple table operations at once.TableOperations
operations()
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 tableReplaceSortOrder
replaceSortOrder()
Create a newReplaceSortOrder
to set the table sort order and commit the change.RewriteManifests
rewriteManifests()
Create a newrewrite manifests API
to replace manifests for this table and commit.Schema
schema()
Return theschema
for this table.java.util.Map<java.lang.Integer,Schema>
schemas()
Return a map ofschema
for this table.Snapshot
snapshot(long snapshotId)
Get thesnapshot
of this table with the given id, or null if there is no matching snapshot.java.lang.Iterable<Snapshot>
snapshots()
Get thesnapshots
of this table.SortOrder
sortOrder()
Return thesort order
for this table.java.util.Map<java.lang.Integer,SortOrder>
sortOrders()
Return a map of sort order IDs tosort orders
for this table.PartitionSpec
spec()
Return thepartition spec
for this table.java.util.Map<java.lang.Integer,PartitionSpec>
specs()
Return a map ofpartition specs
for this table.java.util.List<StatisticsFile>
statisticsFiles()
Returns the current statistics files for the tablejava.lang.String
toString()
UpdateLocation
updateLocation()
Create a newUpdateLocation
to update table location and commit the changes.UpdateProperties
updateProperties()
Create a newUpdateProperties
to update table properties and commit the changes.UpdateSchema
updateSchema()
Create a newUpdateSchema
to alter the columns of this table and commit the change.UpdatePartitionSpec
updateSpec()
Create a newUpdatePartitionSpec
to alter the partition spec of this table and commit the change.UpdateStatistics
updateStatistics()
Create a newupdate 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, wait, wait, wait
-
Methods inherited from interface org.apache.iceberg.Table
newBatchScan, snapshot
-
-
-
-
Constructor Detail
-
BaseTable
public BaseTable(TableOperations ops, java.lang.String name)
-
BaseTable
public BaseTable(TableOperations ops, java.lang.String name, MetricsReporter reporter)
-
-
Method Detail
-
operations
public TableOperations operations()
- Specified by:
operations
in interfaceHasTableOperations
-
name
public java.lang.String name()
Description copied from interface:Table
Return the full name for this table.
-
refresh
public void refresh()
Description copied from interface:Table
Refresh the current table metadata.
-
newScan
public TableScan newScan()
Description copied from interface:Table
Create a newscan
for this table.Once a table scan is created, it can be refined to project columns and filter data.
-
newIncrementalAppendScan
public IncrementalAppendScan newIncrementalAppendScan()
Description copied from interface:Table
Create a newscan
for this table.Once a scan is created, it can be refined to project columns and filter data.
- Specified by:
newIncrementalAppendScan
in interfaceTable
- Returns:
- an incremental scan for appends only snapshots
-
newIncrementalChangelogScan
public IncrementalChangelogScan newIncrementalChangelogScan()
Description copied from interface:Table
Create a newIncrementalChangelogScan
for this table.Once a scan is created, it can be refined to project columns and filter data.
- Specified by:
newIncrementalChangelogScan
in interfaceTable
- Returns:
- an incremental changelog scan
-
schema
public Schema schema()
Description copied from interface:Table
Return theschema
for this table.
-
schemas
public java.util.Map<java.lang.Integer,Schema> schemas()
Description copied from interface:Table
Return a map ofschema
for this table.
-
spec
public PartitionSpec spec()
Description copied from interface:Table
Return thepartition spec
for this table.
-
specs
public java.util.Map<java.lang.Integer,PartitionSpec> specs()
Description copied from interface:Table
Return a map ofpartition specs
for this table.
-
sortOrder
public SortOrder sortOrder()
Description copied from interface:Table
Return thesort order
for this table.
-
sortOrders
public java.util.Map<java.lang.Integer,SortOrder> sortOrders()
Description copied from interface:Table
Return a map of sort order IDs tosort orders
for this table.- Specified by:
sortOrders
in interfaceTable
- Returns:
- this table's sort orders map
-
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 interfaceTable
- Returns:
- this table's properties map
-
location
public java.lang.String location()
Description copied from interface:Table
Return the table's base location.
-
currentSnapshot
public Snapshot currentSnapshot()
Description copied from interface:Table
Get the currentsnapshot
for this table, or null if there are no snapshots.- Specified by:
currentSnapshot
in interfaceTable
- Returns:
- the current table Snapshot.
-
snapshot
public Snapshot snapshot(long snapshotId)
Description copied from interface:Table
Get thesnapshot
of this table with the given id, or null if there is no matching snapshot.
-
snapshots
public java.lang.Iterable<Snapshot> snapshots()
Description copied from interface:Table
Get thesnapshots
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 interfaceTable
- Returns:
- a list of
history entries
-
updateSchema
public UpdateSchema updateSchema()
Description copied from interface:Table
Create a newUpdateSchema
to alter the columns of this table and commit the change.- Specified by:
updateSchema
in interfaceTable
- Returns:
- a new
UpdateSchema
-
updateSpec
public UpdatePartitionSpec updateSpec()
Description copied from interface:Table
Create a newUpdatePartitionSpec
to alter the partition spec of this table and commit the change.- Specified by:
updateSpec
in interfaceTable
- Returns:
- a new
UpdatePartitionSpec
-
updateProperties
public UpdateProperties updateProperties()
Description copied from interface:Table
Create a newUpdateProperties
to update table properties and commit the changes.- Specified by:
updateProperties
in interfaceTable
- Returns:
- a new
UpdateProperties
-
replaceSortOrder
public ReplaceSortOrder replaceSortOrder()
Description copied from interface:Table
Create a newReplaceSortOrder
to set the table sort order and commit the change.- Specified by:
replaceSortOrder
in interfaceTable
- Returns:
- a new
ReplaceSortOrder
-
updateLocation
public UpdateLocation updateLocation()
Description copied from interface:Table
Create a newUpdateLocation
to update table location and commit the changes.- Specified by:
updateLocation
in interfaceTable
- Returns:
- a new
UpdateLocation
-
newAppend
public AppendFiles newAppend()
Description copied from interface:Table
Create a newappend API
to add files to this table and commit.- Specified by:
newAppend
in interfaceTable
- Returns:
- a new
AppendFiles
-
newFastAppend
public AppendFiles newFastAppend()
Description copied from interface:Table
Create a newappend 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 interfaceTable
- Returns:
- a new
AppendFiles
-
newRewrite
public RewriteFiles newRewrite()
Description copied from interface:Table
Create a newrewrite API
to replace files in this table and commit.- Specified by:
newRewrite
in interfaceTable
- Returns:
- a new
RewriteFiles
-
rewriteManifests
public RewriteManifests rewriteManifests()
Description copied from interface:Table
Create a newrewrite manifests API
to replace manifests for this table and commit.- Specified by:
rewriteManifests
in interfaceTable
- Returns:
- a new
RewriteManifests
-
newOverwrite
public OverwriteFiles newOverwrite()
Description copied from interface:Table
Create a newoverwrite API
to overwrite files by a filter expression.- Specified by:
newOverwrite
in interfaceTable
- Returns:
- a new
OverwriteFiles
-
newRowDelta
public RowDelta newRowDelta()
Description copied from interface:Table
Create a newrow-level delta API
to remove or replace rows in existing data files.- Specified by:
newRowDelta
in interfaceTable
- Returns:
- a new
RowDelta
-
newReplacePartitions
public ReplacePartitions newReplacePartitions()
Description copied from interface:Table
Not recommended: Create a newreplace 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 interfaceTable
- Returns:
- a new
ReplacePartitions
-
newDelete
public DeleteFiles newDelete()
Description copied from interface:Table
Create a newdelete API
to replace files in this table and commit.- Specified by:
newDelete
in interfaceTable
- Returns:
- a new
DeleteFiles
-
updateStatistics
public UpdateStatistics updateStatistics()
Description copied from interface:Table
Create a newupdate table statistics API
to add or remove statistics files in this table.- Specified by:
updateStatistics
in interfaceTable
- Returns:
- a new
UpdateStatistics
-
expireSnapshots
public ExpireSnapshots expireSnapshots()
Description copied from interface:Table
Create a newexpire API
to manage snapshots in this table and commit.- Specified by:
expireSnapshots
in interfaceTable
- Returns:
- a new
ExpireSnapshots
-
manageSnapshots
public ManageSnapshots manageSnapshots()
Description copied from interface:Table
Create a newmanage snapshots API
to manage snapshots in this table and commit.- Specified by:
manageSnapshots
in interfaceTable
- Returns:
- a new
ManageSnapshots
-
newTransaction
public Transaction newTransaction()
Description copied from interface:Table
Create a newtransaction API
to commit multiple table operations at once.- Specified by:
newTransaction
in interfaceTable
- Returns:
- a new
Transaction
-
io
public FileIO io()
Description copied from interface:Table
Returns aFileIO
to read and write table data and metadata files.
-
encryption
public EncryptionManager encryption()
Description copied from interface:Table
Returns anEncryptionManager
to encrypt and decrypt data files.- Specified by:
encryption
in interfaceTable
-
locationProvider
public LocationProvider locationProvider()
Description copied from interface:Table
Returns aLocationProvider
to provide locations for new data files.- Specified by:
locationProvider
in interfaceTable
-
statisticsFiles
public java.util.List<StatisticsFile> statisticsFiles()
Description copied from interface:Table
Returns the current statistics files for the table- Specified by:
statisticsFiles
in interfaceTable
- 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
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-