Interface IIcebergPartitionField

(experimental) Partition field definition for Iceberg table.

Namespace: Amazon.CDK.AWS.S3Tables.Alpha

Assembly: Amazon.CDK.AWS.S3Tables.Alpha.dll

Syntax (csharp)

public interface IIcebergPartitionField

Syntax (vb)

Public Interface IIcebergPartitionField

Remarks

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

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3Tables.Alpha;

             IcebergTransform icebergTransform;

             var icebergPartitionField = new IcebergPartitionField {
                 Name = "name",
                 SourceId = 123,
                 Transform = icebergTransform,

                 // the properties below are optional
                 FieldId = 123
             };

Synopsis

Properties

FieldId	(experimental) The unique identifier for the partition field.
Name	(experimental) The name of the partition field.
SourceId	(experimental) The source field ID from the schema.
Transform	(experimental) The partition transform function.

Properties

FieldId

(experimental) The unique identifier for the partition field.

double? FieldId { get; }

Property Value

double?

Remarks

Default: - Auto-assigned starting from 1000

Stability: Experimental

Name

(experimental) The name of the partition field.

string Name { get; }

Property Value

string

Remarks

Stability: Experimental

SourceId

(experimental) The source field ID from the schema.

double SourceId { get; }

Property Value

double

Remarks

Stability: Experimental

Transform

(experimental) The partition transform function.

IcebergTransform Transform { get; }

Property Value

IcebergTransform

Remarks

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

Stability: Experimental