Package org.apache.iceberg

Class TableMetadata

java.lang.Object

org.apache.iceberg.TableMetadata

All Implemented Interfaces:

Serializable

public class TableMetadata
extends Object
implements Serializable

Metadata for a table.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableMetadata.Builder
static class	TableMetadata.MetadataLogEntry
static class	TableMetadata.SnapshotLogEntry

Method Summary

Modifier and Type	Method	Description
TableMetadata	addPartitionSpec(PartitionSpec newPartitionSpec)
static TableMetadata.Builder	buildFrom(TableMetadata base)
static TableMetadata.Builder	buildFromEmpty()
static TableMetadata.Builder	buildFromEmpty(int formatVersion)
TableMetadata	buildReplacement(Schema updatedSchema, PartitionSpec updatedPartitionSpec, SortOrder updatedSortOrder, String newLocation, Map<String,String> updatedProperties)
List<MetadataUpdate>	changes()
int	currentSchemaId()
Snapshot	currentSnapshot()
int	defaultSortOrderId()
int	defaultSpecId()
int	formatVersion()
int	lastAssignedPartitionId()
int	lastColumnId()
long	lastSequenceNumber()
long	lastUpdatedMillis()
String	location()
String	metadataFileLocation()
static TableMetadata	newTableMetadata(Schema schema, PartitionSpec spec, String location, Map<String,String> properties)
static TableMetadata	newTableMetadata(Schema schema, PartitionSpec spec, SortOrder sortOrder, String location, Map<String,String> properties)
long	nextRowId()
long	nextSequenceNumber()
List<PartitionStatisticsFile>	partitionStatisticsFiles()
List<TableMetadata.MetadataLogEntry>	previousFiles()
Map<String,String>	properties()
String	property(String property, String defaultValue)
boolean	propertyAsBoolean(String property, boolean defaultValue)
int	propertyAsInt(String property, int defaultValue)
long	propertyAsLong(String property, long defaultValue)
int	propertyTryAsInt(String property, int defaultValue)
SnapshotRef	ref(String name)
Map<String,SnapshotRef>	refs()
TableMetadata	removeSnapshotsIf(Predicate<Snapshot> removeIf)
TableMetadata	replaceProperties(Map<String,String> rawProperties)
TableMetadata	replaceSortOrder(SortOrder newOrder)
boolean	rowLineageEnabled()
Schema	schema()
List<Schema>	schemas()
Map<Integer,Schema>	schemasById()
Snapshot	snapshot(long snapshotId)
List<HistoryEntry>	snapshotLog()
List<Snapshot>	snapshots()
SortOrder	sortOrder()
List<SortOrder>	sortOrders()
Map<Integer,SortOrder>	sortOrdersById()
PartitionSpec	spec()
PartitionSpec	spec(int id)
List<PartitionSpec>	specs()
Map<Integer,PartitionSpec>	specsById()
List<StatisticsFile>	statisticsFiles()
TableMetadata	updateLocation(String newLocation)
TableMetadata	updatePartitionSpec(PartitionSpec newPartitionSpec)
TableMetadata	updateSchema(Schema newSchema)	Updates the schema
TableMetadata	updateSchema(Schema newSchema, int newLastColumnId)	Deprecated. since 1.8.0, will be removed in 1.9.0 or 2.0.0, use updateSchema(schema).
TableMetadata	upgradeToFormatVersion(int newFormatVersion)
String	uuid()
TableMetadata	withUUID()

Methods inherited from class java.lang.Object

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

Method Details

newTableMetadata

public static TableMetadata newTableMetadata(Schema schema,
 PartitionSpec spec,
 SortOrder sortOrder,
 String location,
 Map<String,String> properties)

newTableMetadata

public static TableMetadata newTableMetadata(Schema schema,
 PartitionSpec spec,
 String location,
 Map<String,String> properties)

formatVersion

public int formatVersion()

metadataFileLocation

public String metadataFileLocation()

uuid

public String uuid()

lastSequenceNumber

public long lastSequenceNumber()

nextSequenceNumber

public long nextSequenceNumber()

lastUpdatedMillis

public long lastUpdatedMillis()

lastColumnId

public int lastColumnId()

schema

public Schema schema()

schemas

public List<Schema> schemas()

schemasById

public Map<Integer,Schema> schemasById()

currentSchemaId

public int currentSchemaId()

spec

public PartitionSpec spec()

spec

public PartitionSpec spec(int id)

specs

public List<PartitionSpec> specs()

specsById

public Map<Integer,PartitionSpec> specsById()

lastAssignedPartitionId

public int lastAssignedPartitionId()

defaultSpecId

public int defaultSpecId()

defaultSortOrderId

public int defaultSortOrderId()

sortOrder

public SortOrder sortOrder()

sortOrders

public List<SortOrder> sortOrders()

sortOrdersById

public Map<Integer,SortOrder> sortOrdersById()

location

public String location()

properties

public Map<String,String> properties()

property

public String property(String property,
 String defaultValue)

propertyAsBoolean

public boolean propertyAsBoolean(String property,
 boolean defaultValue)

propertyAsInt

public int propertyAsInt(String property,
 int defaultValue)

propertyTryAsInt

public int propertyTryAsInt(String property,
 int defaultValue)

propertyAsLong

public long propertyAsLong(String property,
 long defaultValue)

snapshot

public Snapshot snapshot(long snapshotId)

currentSnapshot

public Snapshot currentSnapshot()

snapshots

public List<Snapshot> snapshots()

ref

public SnapshotRef ref(String name)

refs

public Map<String,SnapshotRef> refs()

statisticsFiles

public List<StatisticsFile> statisticsFiles()

partitionStatisticsFiles

public List<PartitionStatisticsFile> partitionStatisticsFiles()

snapshotLog

public List<HistoryEntry> snapshotLog()

previousFiles

public List<TableMetadata.MetadataLogEntry> previousFiles()

changes

public List<MetadataUpdate> changes()

withUUID

public TableMetadata withUUID()

rowLineageEnabled

public boolean rowLineageEnabled()

nextRowId

public long nextRowId()

updateSchema

@Deprecated
public TableMetadata updateSchema(Schema newSchema,
 int newLastColumnId)

Deprecated.

since 1.8.0, will be removed in 1.9.0 or 2.0.0, use updateSchema(schema).

Updates the schema

updateSchema

public TableMetadata updateSchema(Schema newSchema)

Updates the schema

updatePartitionSpec

public TableMetadata updatePartitionSpec(PartitionSpec newPartitionSpec)

addPartitionSpec

public TableMetadata addPartitionSpec(PartitionSpec newPartitionSpec)

replaceSortOrder

public TableMetadata replaceSortOrder(SortOrder newOrder)

removeSnapshotsIf

public TableMetadata removeSnapshotsIf(Predicate<Snapshot> removeIf)

replaceProperties

public TableMetadata replaceProperties(Map<String,String> rawProperties)

buildReplacement

public TableMetadata buildReplacement(Schema updatedSchema,
 PartitionSpec updatedPartitionSpec,
 SortOrder updatedSortOrder,
 String newLocation,
 Map<String,String> updatedProperties)

updateLocation

public TableMetadata updateLocation(String newLocation)

upgradeToFormatVersion

public TableMetadata upgradeToFormatVersion(int newFormatVersion)

buildFrom

public static TableMetadata.Builder buildFrom(TableMetadata base)

buildFromEmpty

public static TableMetadata.Builder buildFromEmpty()

buildFromEmpty

public static TableMetadata.Builder buildFromEmpty(int formatVersion)