Skip to content

SchemaField

Source code in docs_src/capo_s3tables/types/schema_field.py 
 8
 9
10
11
12
13
14
15
16
class SchemaField(TypedDict, closed=True):
    id: NotRequired["int"]
    """<p>An optional unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes. If not specified, S3 Tables automatically assigns field IDs.</p>"""
    name: "str"
    """<p>The name of the field.</p>"""
    type: "str"
    """<p>The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the <a href="https://iceberg.apache.org/spec/#primitive-types">Apache Iceberg documentation</a>.</p>"""
    required: "bool"
    """<p>A Boolean value that specifies whether values are required for each row in this field. By default, this is <code>false</code> and null values are allowed in the field. If this is <code>true</code> the field does not allow null values.</p>"""

id instance-attribute 

id: NotRequired[int]

An optional unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes. If not specified, S3 Tables automatically assigns field IDs.

name instance-attribute 

name: str

The name of the field.

required instance-attribute 

required: bool

A Boolean value that specifies whether values are required for each row in this field. By default, this is false and null values are allowed in the field. If this is true the field does not allow null values.

type instance-attribute 

type: str

The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the Apache Iceberg documentation.