Skip to content

SchemaV2Field

Source code in docs_src/capo_s3tables/types/schema_v2_field.py 
 8
 9
10
11
12
13
14
15
16
17
18
class SchemaV2Field(TypedDict, closed=True):
    id: "int"
    """<p>The unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes.</p>"""
    name: "str"
    """<p>The name of the field.</p>"""
    type: "object"
    """<p>The data type of the field. This can be a primitive type string such as <code>boolean</code>, <code>int</code>, <code>long</code>, <code>float</code>, <code>double</code>, <code>string</code>, <code>binary</code>, <code>date</code>, <code>timestamp</code>, or <code>timestamptz</code>, or a complex type represented as a JSON object for nested types such as <code>struct</code>, <code>list</code>, or <code>map</code>. For more information, see the <a href="https://iceberg.apache.org/spec/#schemas-and-data-types">Apache Iceberg schemas and data types documentation</a>.</p>"""
    required: "bool"
    """<p>A Boolean value that specifies whether values are required for each row in this field. If this is <code>true</code>, the field does not allow null values.</p>"""
    doc: NotRequired["str"]
    """<p>An optional description of the field.</p>"""

doc instance-attribute 

doc: NotRequired[str]

An optional description of the field.

id instance-attribute 

id: int

The unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes.

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. If this is true, the field does not allow null values.

type instance-attribute 

type: object

The data type of the field. This can be a primitive type string such as boolean, int, long, float, double, string, binary, date, timestamp, or timestamptz, or a complex type represented as a JSON object for nested types such as struct, list, or map. For more information, see the Apache Iceberg schemas and data types documentation.