Package org.apache.iceberg

Class TableMetadata.Builder

java.lang.Object

org.apache.iceberg.TableMetadata.Builder

Enclosing class:

TableMetadata

public static class TableMetadata.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
TableMetadata.Builder	addEncryptionKey(EncryptedKey key)
TableMetadata.Builder	addPartitionSpec(PartitionSpec spec)
TableMetadata.Builder	addPartitionSpec(UnboundPartitionSpec spec)
TableMetadata.Builder	addSchema(Schema schema)
TableMetadata.Builder	addSnapshot(Snapshot snapshot)
TableMetadata.Builder	addSortOrder(SortOrder order)
TableMetadata.Builder	addSortOrder(UnboundSortOrder order)
TableMetadata.Builder	assignUUID()
TableMetadata.Builder	assignUUID(String newUuid)
TableMetadata	build()
TableMetadata.Builder	discardChanges()
TableMetadata.Builder	removeEncryptionKey(String keyId)
TableMetadata.Builder	removePartitionStatistics(long snapshotId)
TableMetadata.Builder	removeProperties(Set<String> removed)
TableMetadata.Builder	removeRef(String name)
TableMetadata.Builder	removeSnapshots(Collection<Long> idsToRemove)
TableMetadata.Builder	removeSnapshots(List<Snapshot> snapshotsToRemove)
TableMetadata.Builder	removeStatistics(long snapshotId)
TableMetadata.Builder	setBranchSnapshot(long snapshotId, String branch)
TableMetadata.Builder	setBranchSnapshot(Snapshot snapshot, String branch)
TableMetadata.Builder	setCurrentSchema(int schemaId)
TableMetadata.Builder	setCurrentSchema(Schema newSchema, int newLastColumnId)
TableMetadata.Builder	setDefaultPartitionSpec(int specId)
TableMetadata.Builder	setDefaultPartitionSpec(PartitionSpec spec)
TableMetadata.Builder	setDefaultSortOrder(int sortOrderId)
TableMetadata.Builder	setDefaultSortOrder(SortOrder order)
TableMetadata.Builder	setLocation(String newLocation)
TableMetadata.Builder	setPartitionStatistics(PartitionStatisticsFile file)
TableMetadata.Builder	setPreviousFileLocation(String previousFileLocation)
TableMetadata.Builder	setProperties(Map<String,String> updated)
TableMetadata.Builder	setRef(String name, SnapshotRef ref)
TableMetadata.Builder	setSnapshotsSupplier(SerializableSupplier<List<Snapshot>> snapshotsSupplier)
TableMetadata.Builder	setStatistics(StatisticsFile statisticsFile)
TableMetadata.Builder	suppressHistoricalSnapshots()	Suppresses snapshots that are historical, removing the metadata for lazy snapshot loading.
TableMetadata.Builder	upgradeFormatVersion(int newFormatVersion)
TableMetadata.Builder	withMetadataLocation(String newMetadataLocation)

Methods inherited from class java.lang.Object

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

Method Details

withMetadataLocation

public TableMetadata.Builder withMetadataLocation(String newMetadataLocation)

assignUUID

public TableMetadata.Builder assignUUID()

assignUUID

public TableMetadata.Builder assignUUID(String newUuid)

upgradeFormatVersion

public TableMetadata.Builder upgradeFormatVersion(int newFormatVersion)

setCurrentSchema

public TableMetadata.Builder setCurrentSchema(Schema newSchema,
 int newLastColumnId)

setCurrentSchema

public TableMetadata.Builder setCurrentSchema(int schemaId)

addSchema

public TableMetadata.Builder addSchema(Schema schema)

setDefaultPartitionSpec

public TableMetadata.Builder setDefaultPartitionSpec(PartitionSpec spec)

setDefaultPartitionSpec

public TableMetadata.Builder setDefaultPartitionSpec(int specId)

addPartitionSpec

public TableMetadata.Builder addPartitionSpec(UnboundPartitionSpec spec)

addPartitionSpec

public TableMetadata.Builder addPartitionSpec(PartitionSpec spec)

setDefaultSortOrder

public TableMetadata.Builder setDefaultSortOrder(SortOrder order)

setDefaultSortOrder

public TableMetadata.Builder setDefaultSortOrder(int sortOrderId)

addSortOrder

public TableMetadata.Builder addSortOrder(UnboundSortOrder order)

addSortOrder

public TableMetadata.Builder addSortOrder(SortOrder order)

addSnapshot

public TableMetadata.Builder addSnapshot(Snapshot snapshot)

setSnapshotsSupplier

public TableMetadata.Builder setSnapshotsSupplier(SerializableSupplier<List<Snapshot>> snapshotsSupplier)

setBranchSnapshot

public TableMetadata.Builder setBranchSnapshot(Snapshot snapshot,
 String branch)

setBranchSnapshot

public TableMetadata.Builder setBranchSnapshot(long snapshotId,
 String branch)

setRef

public TableMetadata.Builder setRef(String name,
 SnapshotRef ref)

removeRef

public TableMetadata.Builder removeRef(String name)

setStatistics

public TableMetadata.Builder setStatistics(StatisticsFile statisticsFile)

removeStatistics

public TableMetadata.Builder removeStatistics(long snapshotId)

suppressHistoricalSnapshots

public TableMetadata.Builder suppressHistoricalSnapshots()

Suppresses snapshots that are historical, removing the metadata for lazy snapshot loading.

Note that the snapshots are not considered removed from metadata and no RemoveSnapshot changes are created.

A snapshot is historical if no ref directly references its ID.

Returns:

this for method chaining

setPartitionStatistics

public TableMetadata.Builder setPartitionStatistics(PartitionStatisticsFile file)

removePartitionStatistics

public TableMetadata.Builder removePartitionStatistics(long snapshotId)

removeSnapshots

public TableMetadata.Builder removeSnapshots(List<Snapshot> snapshotsToRemove)

removeSnapshots

public TableMetadata.Builder removeSnapshots(Collection<Long> idsToRemove)

setProperties

public TableMetadata.Builder setProperties(Map<String,String> updated)

removeProperties

public TableMetadata.Builder removeProperties(Set<String> removed)

setLocation

public TableMetadata.Builder setLocation(String newLocation)

addEncryptionKey

public TableMetadata.Builder addEncryptionKey(EncryptedKey key)

removeEncryptionKey

public TableMetadata.Builder removeEncryptionKey(String keyId)

discardChanges

public TableMetadata.Builder discardChanges()

setPreviousFileLocation

public TableMetadata.Builder setPreviousFileLocation(String previousFileLocation)

build

public TableMetadata build()