Package org.apache.beam.sdk.io.iceberg

Class SerializableTableSpec

java.lang.Object

org.apache.beam.sdk.io.iceberg.SerializableTableSpec

All Implemented Interfaces:

Serializable

@DefaultSchema(AutoValueSchema.class)
public abstract class SerializableTableSpec
extends Object
implements Serializable

A serializable, lightweight representation of an Iceberg Table's declarative metadata.

Captures the table's schemas, partition specs, sort orders, location, properties, identifier, encrypted keys, and serialized FileIO configuration. Suitable for broadcasting across worker nodes via Beam's side-input mechanism.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SerializableTableSpec.Builder

Constructor Summary

Constructors

Constructor	Description
SerializableTableSpec()

Method Summary

Modifier and Type	Method	Description
static SerializableTableSpec.Builder	builder()
static SerializableTableSpec	fromTable(String tableIdentifierString, org.apache.iceberg.Table table)	Constructs a SerializableTableSpec from an explicit table identifier string and a Table.
static SerializableTableSpec	fromTable(org.apache.iceberg.catalog.TableIdentifier tableIdentifier, org.apache.iceberg.Table table)	Constructs a SerializableTableSpec from a TableIdentifier and a Table.
static SerializableTableSpec	fromTable(org.apache.iceberg.Table table)	Constructs a SerializableTableSpec from a Table, using Table.name() as the table identifier string.
static SchemaCoder<SerializableTableSpec>	getCoder()	Returns the cached SchemaCoder for SerializableTableSpec.
abstract List<String>	getEncryptedKeyJsons()
List<org.apache.iceberg.encryption.EncryptedKey>	getEncryptedKeys()
org.apache.iceberg.io.FileIO	getFileIO()	Returns a cached FileIO instance for this table using default configuration.
org.apache.iceberg.io.FileIO	getFileIO(@Nullable org.apache.hadoop.conf.Configuration conf)	Returns a cached FileIO instance for this table, configured with the provided Hadoop Configuration if supported.
abstract String	getFileIoJson()
abstract long	getLastUpdatedMillis()
abstract String	getLocation()
abstract String	getName()
abstract int	getOrderId()
org.apache.iceberg.PartitionSpec	getPartitionSpec()
@Nullable org.apache.iceberg.PartitionSpec	getPartitionSpec(int specId)
Map<Integer,org.apache.iceberg.PartitionSpec>	getPartitionSpecs()
abstract Map<Integer,String>	getPartitionSpecsJson()
abstract Map<String,String>	getProperties()
org.apache.iceberg.Schema	getSchema()
@Nullable org.apache.iceberg.Schema	getSchema(int schemaId)
abstract int	getSchemaId()
Map<Integer,org.apache.iceberg.Schema>	getSchemas()
abstract Map<Integer,String>	getSchemasJson()
org.apache.iceberg.SortOrder	getSortOrder()
@Nullable org.apache.iceberg.SortOrder	getSortOrder(int orderId)
Map<Integer,org.apache.iceberg.SortOrder>	getSortOrders()
abstract Map<Integer,String>	getSortOrdersJson()
abstract int	getSpecId()
org.apache.iceberg.catalog.TableIdentifier	getTableIdentifier()
abstract String	getTableIdentifierString()
abstract SerializableTableSpec.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Details

SerializableTableSpec

public SerializableTableSpec()

Method Details

getTableIdentifierString

@SchemaFieldNumber("0")
public abstract String getTableIdentifierString()

getName

@SchemaFieldNumber("1")
public abstract String getName()

getLocation

@SchemaFieldNumber("2")
public abstract String getLocation()

getSchemaId

@SchemaFieldNumber("3")
public abstract int getSchemaId()

getSchemasJson

@SchemaFieldNumber("4")
public abstract Map<Integer,String> getSchemasJson()

getSpecId

@SchemaFieldNumber("5")
public abstract int getSpecId()

getPartitionSpecsJson

@SchemaFieldNumber("6")
public abstract Map<Integer,String> getPartitionSpecsJson()

getOrderId

@SchemaFieldNumber("7")
public abstract int getOrderId()

getSortOrdersJson

@SchemaFieldNumber("8")
public abstract Map<Integer,String> getSortOrdersJson()

getProperties

@SchemaFieldNumber("9")
public abstract Map<String,String> getProperties()

getFileIoJson

@SchemaFieldNumber("10")
public abstract String getFileIoJson()

getEncryptedKeyJsons

@SchemaFieldNumber("11")
public abstract List<String> getEncryptedKeyJsons()

getLastUpdatedMillis

@SchemaFieldNumber("12")
public abstract long getLastUpdatedMillis()

getSchemas

@SchemaIgnore
public Map<Integer,org.apache.iceberg.Schema> getSchemas()

getSchema

@SchemaIgnore
public org.apache.iceberg.Schema getSchema()

getSchema

@SchemaIgnore
public @Nullable org.apache.iceberg.Schema getSchema(int schemaId)

getPartitionSpecs

@SchemaIgnore
public Map<Integer,org.apache.iceberg.PartitionSpec> getPartitionSpecs()

getPartitionSpec

@SchemaIgnore
public org.apache.iceberg.PartitionSpec getPartitionSpec()

getPartitionSpec

@SchemaIgnore
public @Nullable org.apache.iceberg.PartitionSpec getPartitionSpec(int specId)

getSortOrders

@SchemaIgnore
public Map<Integer,org.apache.iceberg.SortOrder> getSortOrders()

getSortOrder

@SchemaIgnore
public org.apache.iceberg.SortOrder getSortOrder()

getSortOrder

@SchemaIgnore
public @Nullable org.apache.iceberg.SortOrder getSortOrder(int orderId)

getTableIdentifier

@SchemaIgnore
public org.apache.iceberg.catalog.TableIdentifier getTableIdentifier()

getFileIO

@SchemaIgnore
public org.apache.iceberg.io.FileIO getFileIO()

Returns a cached FileIO instance for this table using default configuration.

getFileIO

@SchemaIgnore
public org.apache.iceberg.io.FileIO getFileIO(@Nullable org.apache.hadoop.conf.Configuration conf)

Returns a cached FileIO instance for this table, configured with the provided Hadoop Configuration if supported.

getEncryptedKeys

@SchemaIgnore
public List<org.apache.iceberg.encryption.EncryptedKey> getEncryptedKeys()

builder

public static SerializableTableSpec.Builder builder()

toBuilder

public abstract SerializableTableSpec.Builder toBuilder()

fromTable

public static SerializableTableSpec fromTable(org.apache.iceberg.Table table)

Constructs a SerializableTableSpec from a Table, using Table.name() as the table identifier string.

Note: When possible, prefer fromTable(TableIdentifier, Table) to avoid catalog name prefix ambiguities in Table.name().

fromTable

public static SerializableTableSpec fromTable(org.apache.iceberg.catalog.TableIdentifier tableIdentifier,
 org.apache.iceberg.Table table)

Constructs a SerializableTableSpec from a TableIdentifier and a Table.

fromTable

public static SerializableTableSpec fromTable(String tableIdentifierString,
 org.apache.iceberg.Table table)

Constructs a SerializableTableSpec from an explicit table identifier string and a Table.

getCoder

public static SchemaCoder<SerializableTableSpec> getCoder()

Returns the cached SchemaCoder for SerializableTableSpec.