Module metadata_columns

Metadata columns (virtual/reserved fields) for Iceberg tables.

This module defines metadata columns that can be requested in projections but are not stored in data files. Instead, they are computed on-the-fly during reading. Examples include the _file column (file path) and future columns like partition values or row numbers.

Constants

RESERVED_COL_NAME_CHANGE_ORDINAL

Reserved column name for the change ordinal metadata column

RESERVED_COL_NAME_CHANGE_TYPE

Reserved column name for the change type metadata column

RESERVED_COL_NAME_COMMIT_SNAPSHOT_ID

Reserved column name for the commit snapshot ID metadata column

RESERVED_COL_NAME_DELETED

Reserved column name for the deleted metadata column

RESERVED_COL_NAME_DELETE_FILE_PATH

Reserved column name for the file path in position delete files

RESERVED_COL_NAME_DELETE_FILE_POS

Reserved column name for the position in position delete files

RESERVED_COL_NAME_FILE

Reserved column name for the file path metadata column

RESERVED_COL_NAME_LAST_UPDATED_SEQUENCE_NUMBER

Reserved column name for the last updated sequence number metadata column

RESERVED_COL_NAME_PARTITION

Reserved column name for the partition metadata column

RESERVED_COL_NAME_POS

Reserved column name for the position metadata column

RESERVED_COL_NAME_ROW_ID

Reserved column name for the row ID metadata column

RESERVED_COL_NAME_SPEC_ID

Reserved column name for the spec ID metadata column

RESERVED_FIELD_ID_CHANGE_ORDINAL

Reserved field ID for the change ordinal (_change_ordinal) column per Iceberg spec

RESERVED_FIELD_ID_CHANGE_TYPE

Reserved field ID for the change type (_change_type) column per Iceberg spec

RESERVED_FIELD_ID_COMMIT_SNAPSHOT_ID

Reserved field ID for the commit snapshot ID (_commit_snapshot_id) column per Iceberg spec

RESERVED_FIELD_ID_DELETED

Reserved field ID for the deleted (_deleted) column per Iceberg spec

RESERVED_FIELD_ID_DELETE_FILE_PATH

Reserved field ID for the file path in position delete files

RESERVED_FIELD_ID_DELETE_FILE_POS

Reserved field ID for the position in position delete files

RESERVED_FIELD_ID_FILE

Reserved field ID for the file path (_file) column per Iceberg spec

RESERVED_FIELD_ID_LAST_UPDATED_SEQUENCE_NUMBER

Reserved field ID for the last updated sequence number (_last_updated_sequence_number) column per Iceberg spec

RESERVED_FIELD_ID_PARTITION

Reserved field ID for the partition (_partition) column per Iceberg spec

RESERVED_FIELD_ID_POS

Reserved field ID for the position (_pos) column per Iceberg spec

RESERVED_FIELD_ID_ROW_ID

Reserved field ID for the row ID (_row_id) column per Iceberg spec

RESERVED_FIELD_ID_SPEC_ID

Reserved field ID for the spec ID (_spec_id) column per Iceberg spec

Functions

change_ordinal_field

Returns the Iceberg field definition for the _change_ordinal metadata column.

change_type_field

Returns the Iceberg field definition for the _change_type metadata column.

commit_snapshot_id_field

Returns the Iceberg field definition for the _commit_snapshot_id metadata column.

delete_file_path_field

Returns the Iceberg field definition for the file_path column in position delete files.

delete_file_pos_field

Returns the Iceberg field definition for the pos column in position delete files.

deleted_field

Returns the Iceberg field definition for the _deleted metadata column.

file_field

Returns the Iceberg field definition for the _file metadata column.

get_metadata_field

Returns the Iceberg field definition for a metadata field ID.

get_metadata_field_id

Returns the field ID for a metadata column name.

is_metadata_column_name

Checks if a column name is a metadata column.

is_metadata_field

Checks if a field ID is a metadata field.

last_updated_sequence_number_field

Returns the Iceberg field definition for the _last_updated_sequence_number metadata column.

partition_field

Creates the Iceberg field definition for the _partition metadata column.

pos_field

Returns the Iceberg field definition for the _pos metadata column.

row_id_field

Returns the Iceberg field definition for the _row_id metadata column.

spec_id_field

Returns the Iceberg field definition for the _spec_id metadata column.