Skip to content

IcebergPartitionField

Source code in docs_src/capo_s3tables/types/iceberg_partition_field.py 
 8
 9
10
11
12
13
14
15
16
class IcebergPartitionField(TypedDict, closed=True):
    source_id: "int"
    """<p>The ID of the source schema field to partition by. This must reference a valid field ID from the table schema.</p>"""
    transform: "str"
    """<p>The partition transform to apply to the source field. Supported transforms include <code>identity</code>, <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code>, <code>bucket</code>, and <code>truncate</code>. For more information, see the <a href="https://iceberg.apache.org/spec/#partition-transforms">Apache Iceberg partition transforms documentation</a>.</p>"""
    name: "str"
    """<p>The name for this partition field. This name is used in the partitioned file paths.</p>"""
    field_id: NotRequired["int"]
    """<p>An optional unique identifier for this partition field. If not specified, S3 Tables automatically assigns a field ID.</p>"""

field_id instance-attribute 

field_id: NotRequired[int]

An optional unique identifier for this partition field. If not specified, S3 Tables automatically assigns a field ID.

name instance-attribute 

name: str

The name for this partition field. This name is used in the partitioned file paths.

source_id instance-attribute 

source_id: int

The ID of the source schema field to partition by. This must reference a valid field ID from the table schema.

transform instance-attribute 

transform: str

The partition transform to apply to the source field. Supported transforms include identity, year, month, day, hour, bucket, and truncate. For more information, see the Apache Iceberg partition transforms documentation.