Skip to content

IcebergSchemaV2

Source code in docs_src/capo_s3tables/types/iceberg_schema_v2.py
class IcebergSchemaV2(TypedDict, closed=True):
    type: "capo_s3tables.types.schema_v2_field_type.SchemaV2FieldType"
    """<p>The type of the top-level schema, which is always a <code>struct</code> type as defined in the <a href="https://iceberg.apache.org/spec/#schemas-and-data-types">Apache Iceberg specification</a>. This value must be <code>struct</code>.</p>"""
    fields: "capo_s3tables.types.schema_v2_field_list.SchemaV2FieldList"
    """<p>The schema fields for the table. Each field defines a column in the table, including its name, type, and whether it is required.</p>"""
    schema_id: NotRequired["int"]
    """<p>An optional unique identifier for the schema. Schema IDs are used by Apache Iceberg to track schema evolution.</p>"""
    identifier_field_ids: NotRequired["capo_s3tables.types.integer_list.IntegerList"]
    """<p>A list of field IDs that are used as the identifier fields for the table. Identifier fields uniquely identify a row in the table.</p>"""

fields instance-attribute

The schema fields for the table. Each field defines a column in the table, including its name, type, and whether it is required.

identifier_field_ids instance-attribute

identifier_field_ids: NotRequired[IntegerList]

A list of field IDs that are used as the identifier fields for the table. Identifier fields uniquely identify a row in the table.

schema_id instance-attribute

schema_id: NotRequired[int]

An optional unique identifier for the schema. Schema IDs are used by Apache Iceberg to track schema evolution.

type instance-attribute

The type of the top-level schema, which is always a struct type as defined in the Apache Iceberg specification. This value must be struct.