IcebergStructField
¶
Source code in docs_src/capo_glue/types/iceberg_struct_field.py
doc
instance-attribute
¶
doc: NotRequired[CommentString]
Optional documentation or description text that provides additional context about the purpose and usage of this field.
id
instance-attribute
¶
id: Integer
The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.
initial_default
instance-attribute
¶
initial_default: NotRequired[IcebergDocument]
Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.
name
instance-attribute
¶
name: ColumnNameString
The name of the field as it appears in the table schema and query operations.
required
instance-attribute
¶
required: Boolean
Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.
type
instance-attribute
¶
type: IcebergDocument
The data type definition for this field, specifying the structure and format of the data it contains.
write_default
instance-attribute
¶
write_default: NotRequired[IcebergDocument]
Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.