Skip to content

IcebergMetadata

Source code in docs_src/capo_s3tables/types/iceberg_metadata.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class IcebergMetadata(TypedDict, closed=True):
    schema: NotRequired["capo_s3tables.types.iceberg_schema.IcebergSchema"]
    """<p>The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as <code>struct</code>, <code>list</code>, or <code>map</code>, use <code>schemaV2</code> instead.</p>"""
    schema_v2: NotRequired["capo_s3tables.types.iceberg_schema_v2.IcebergSchemaV2"]
    """<p>The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as <code>struct</code>, <code>list</code>, or <code>map</code>, in addition to primitive types. For schemas with only primitive types, you can use either <code>schema</code> or <code>schemaV2</code>.</p>"""
    partition_spec: NotRequired[
        "capo_s3tables.types.iceberg_partition_spec.IcebergPartitionSpec"
    ]
    """<p>The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.</p>"""
    write_order: NotRequired["capo_s3tables.types.iceberg_sort_order.IcebergSortOrder"]
    """<p>The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.</p>"""
    properties: NotRequired["capo_s3tables.types.table_properties.TableProperties"]
    """<p>A map of custom configuration properties for the Iceberg table.</p>"""

partition_spec instance-attribute 

partition_spec: NotRequired[IcebergPartitionSpec]

The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.

properties instance-attribute 

properties: NotRequired[TableProperties]

A map of custom configuration properties for the Iceberg table.

schema instance-attribute 

schema: NotRequired[IcebergSchema]

The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as struct, list, or map, use schemaV2 instead.

schema_v2 instance-attribute 

schema_v2: NotRequired[IcebergSchemaV2]

The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as struct, list, or map, in addition to primitive types. For schemas with only primitive types, you can use either schema or schemaV2.

write_order instance-attribute 

write_order: NotRequired[IcebergSortOrder]

The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.