IcebergPartitionField

class aws_cdk.aws_s3tables_alpha.IcebergPartitionField(*, name, source_id, transform, field_id=None)

Bases: object

(experimental) Partition field definition for Iceberg table.

Defines a single partition column. Multiple partition fields can be combined in an IcebergPartitionSpec to create multi-level partitioning.

Parameters:
  • name (str) – (experimental) The name of the partition field.

  • source_id (Union[int, float]) – (experimental) The source field ID from the schema.

  • transform (IcebergTransform) – (experimental) The partition transform function. Use IcebergTransform static properties for common transforms (e.g., IcebergTransform.IDENTITY) or methods for parameterized transforms (e.g., IcebergTransform.bucket(16)).

  • field_id (Union[int, float, None]) – (experimental) The unique identifier for the partition field. Default: - Auto-assigned starting from 1000

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_s3tables_alpha as s3tables_alpha

# iceberg_transform: s3tables_alpha.IcebergTransform

iceberg_partition_field = s3tables_alpha.IcebergPartitionField(
    name="name",
    source_id=123,
    transform=iceberg_transform,

    # the properties below are optional
    field_id=123
)

Attributes

field_id

(experimental) The unique identifier for the partition field.

Default:
  • Auto-assigned starting from 1000

Stability:

experimental

name

(experimental) The name of the partition field.

Stability:

experimental

source_id

(experimental) The source field ID from the schema.

Stability:

experimental

transform

(experimental) The partition transform function.

Use IcebergTransform static properties for common transforms (e.g., IcebergTransform.IDENTITY) or methods for parameterized transforms (e.g., IcebergTransform.bucket(16)).

Stability:

experimental