iceberg::MetadataColumns Struct Reference

A class containing constants and utility methods for metadata columns. More...

#include <metadata_columns.h>

Static Public Member Functions
static const std::set< int32_t > &	MetadataFieldIds ()
	Get the set of metadata field IDs.
static bool	IsMetadataColumn (std::string_view name)
	Check if a column name is a metadata column.
static bool	IsMetadataColumn (int32_t id)
	Check if a column ID is a metadata column.
static Result< const SchemaField * >	MetadataColumn (std::string_view name)
	Get a metadata column by name.

Static Public Attributes
static constexpr int32_t	kInt32Max = std::numeric_limits<int32_t>::max()
static constexpr int32_t	kFilePathColumnId = kInt32Max - 1
static const SchemaField	kFilePath
static constexpr int32_t	kFilePositionColumnId = kInt32Max - 2
static const SchemaField	kRowPosition
static constexpr int32_t	kIsDeletedColumnId = kInt32Max - 3
static const SchemaField	kIsDeleted
static constexpr int32_t	kSpecIdColumnId = kInt32Max - 4
static const SchemaField	kSpecId
static constexpr int32_t	kPartitionColumnId = kInt32Max - 5
static constexpr std::string_view	kPartitionColumnName = "_partition"
static constexpr std::string_view	kPartitionColumnDoc
static constexpr int32_t	kContentOffsetColumnId = kInt32Max - 6
static constexpr int32_t	kContentSizeInBytesColumnId = kInt32Max - 7
static constexpr int32_t	kDeleteFilePathColumnId = kInt32Max - 101
static const SchemaField	kDeleteFilePath
static constexpr int32_t	kDeleteFilePosColumnId = kInt32Max - 102
static const SchemaField	kDeleteFilePos
static constexpr int32_t	kDeleteFileRowColumnId = kInt32Max - 103
static constexpr std::string_view	kDeleteFileRowFieldName = "row"
static constexpr std::string_view	kDeleteFileRowDoc = "Deleted row values"
static constexpr int32_t	kChangeTypeColumnId = kInt32Max - 104
static const SchemaField	kChangeType
static constexpr int32_t	kChangeOrdinalColumnId = kInt32Max - 105
static const SchemaField	kChangeOrdinal
static constexpr int32_t	kCommitSnapshotIdColumnId = kInt32Max - 106
static const SchemaField	kCommitSnapshotId
static constexpr int32_t	kRowIdColumnId = kInt32Max - 107
static const SchemaField	kRowId
static constexpr int32_t	kLastUpdatedSequenceNumberColumnId = kInt32Max - 108
static const SchemaField	kLastUpdatedSequenceNumber

Detailed Description

A class containing constants and utility methods for metadata columns.

Member Function Documentation

MetadataColumn()

Result< const SchemaField * > iceberg::MetadataColumns::MetadataColumn ( std::string_view  name )

static

Get a metadata column by name.

Parameters

name	The name of the metadata column.

Returns

The metadata column, or an error if the name does not refer to a metadata column. The returned pointer is guaranteed to be valid.

Member Data Documentation

kChangeOrdinal

const SchemaField iceberg::MetadataColumns::kChangeOrdinal

inlinestatic

Initial value:

= SchemaField::MakeOptional(
      kChangeOrdinalColumnId, "_change_ordinal", int32(), "Change ordinal in changelog")

kChangeType

const SchemaField iceberg::MetadataColumns::kChangeType

inlinestatic

Initial value:

= SchemaField::MakeRequired(
      kChangeTypeColumnId, "_change_type", string(), "Record type in changelog")

kCommitSnapshotId

const SchemaField iceberg::MetadataColumns::kCommitSnapshotId

inlinestatic

Initial value:

= SchemaField::MakeOptional(
      kCommitSnapshotIdColumnId, "_commit_snapshot_id", int64(), "Commit snapshot ID")

kDeleteFilePath

const SchemaField iceberg::MetadataColumns::kDeleteFilePath

inlinestatic

Initial value:

=
      SchemaField::MakeRequired(kDeleteFilePathColumnId, "file_path", string(),
                                "Path of a file in which a deleted row is stored")

kDeleteFilePos

const SchemaField iceberg::MetadataColumns::kDeleteFilePos

inlinestatic

Initial value:

=
      SchemaField::MakeRequired(kDeleteFilePosColumnId, "pos", int64(),
                                "Ordinal position of a deleted row in the data file")

kFilePath

const SchemaField iceberg::MetadataColumns::kFilePath

inlinestatic

Initial value:

= SchemaField::MakeRequired(
      kFilePathColumnId, "_file", string(), "Path of the file in which a row is stored")

kIsDeleted

const SchemaField iceberg::MetadataColumns::kIsDeleted

inlinestatic

Initial value:

= SchemaField::MakeRequired(
      kIsDeletedColumnId, "_deleted", boolean(), "Whether the row has been deleted")

kLastUpdatedSequenceNumber

const SchemaField iceberg::MetadataColumns::kLastUpdatedSequenceNumber

inlinestatic

Initial value:

= SchemaField::MakeOptional(
      kLastUpdatedSequenceNumberColumnId, "_last_updated_sequence_number", int64(),
      "Sequence number when the row was last updated")

kPartitionColumnDoc

constexpr std::string_view iceberg::MetadataColumns::kPartitionColumnDoc

staticconstexpr

Initial value:

=
      "Partition to which a row belongs to"

kRowId

const SchemaField iceberg::MetadataColumns::kRowId

inlinestatic

Initial value:

=
      SchemaField::MakeOptional(kRowIdColumnId, "_row_id", int64(),
                                "Implicit row ID that is automatically assigned")

kRowPosition

const SchemaField iceberg::MetadataColumns::kRowPosition

inlinestatic

Initial value:

=
      SchemaField::MakeRequired(kFilePositionColumnId, "_pos", int64(),
                                "Ordinal position of a row in the source data file")

kSpecId

const SchemaField iceberg::MetadataColumns::kSpecId

inlinestatic

Initial value:

=
      SchemaField::MakeRequired(kSpecIdColumnId, "_spec_id", int32(),
                                "Spec ID used to track the file containing a row")

---

The documentation for this struct was generated from the following files:

• iceberg/metadata_columns.h
• iceberg/metadata_columns.cc