Struct TableProperties 

pub struct TableProperties<'properties> { /* private fields */ }

Typed view over the properties of a table.

Implementations

impl<'properties> TableProperties<'properties>

pub fn new(properties: &'properties HashMap<String, String>) -> Self

Creates a property view without parsing any values.

pub fn commit_num_retries(&self) -> Result<usize>

The number of times to retry a commit.

pub fn commit_min_retry_wait_ms(&self) -> Result<u64>

The minimum wait time between retries.

pub fn commit_max_retry_wait_ms(&self) -> Result<u64>

The maximum wait time between retries.

pub fn commit_total_retry_timeout_ms(&self) -> Result<u64>

The total timeout for commit retries.

pub fn write_format_default(&self) -> Result<String>

The default format for files.

pub fn write_target_file_size_bytes(&self) -> Result<usize>

The target file size for files.

pub fn write_metadata_path(&self) -> Result<Option<String>>

Base directory for metadata files (manifests, manifest lists), with any trailing slash trimmed. None if write.metadata.path is not set.

pub fn metadata_compression_codec(&self) -> Result<CompressionCodec>

Compression codec for metadata files (JSON)

pub fn write_datafusion_fanout_enabled(&self) -> Result<bool>

Whether to use FanoutWriter for partitioned tables.

pub fn gc_enabled(&self) -> Result<bool>

Whether garbage collection is enabled on drop. When false, data files will not be deleted when a table is dropped.

pub fn max_snapshot_age_ms(&self) -> Result<i64>

Default maximum age of a snapshot to keep when expiring snapshots.

pub fn min_snapshots_to_keep(&self) -> Result<usize>

Default minimum number of snapshots to keep per branch when expiring snapshots.

pub fn max_ref_age_ms(&self) -> Result<i64>

Default maximum age of a snapshot reference to keep when expiring snapshots.

pub fn cdc_enabled(&self) -> Result<bool>

Whether content-defined chunking is enabled. true only when write.parquet.content-defined-chunking.enabled = "true".

pub fn cdc_min_chunk_size(&self) -> Result<usize>

Content-defined chunking minimum chunk size in bytes.

pub fn cdc_max_chunk_size(&self) -> Result<usize>

Content-defined chunking maximum chunk size in bytes.

pub fn cdc_norm_level(&self) -> Result<i32>

Content-defined chunking normalization level (gearhash bit adjustment).

pub fn parquet_compression_codec(&self) -> Result<CompressionCodec>

Parquet compression codec for data files, with the resolved compression level folded in (from write.parquet.compression-level, or the codec’s default when unset).

pub fn parquet_row_group_size_bytes(&self) -> Result<usize>

Approximate maximum Parquet row group size in bytes.

pub fn parquet_page_size_bytes(&self) -> Result<usize>

Approximate maximum Parquet data page size in bytes.

pub fn parquet_page_row_limit(&self) -> Result<usize>

Maximum number of rows per Parquet data page.

pub fn parquet_dict_size_bytes(&self) -> Result<usize>

Approximate maximum Parquet dictionary page size in bytes.

pub fn encryption_key_id(&self) -> Result<Option<String>>

The master key id used to encrypt this table’s manifest list and data files. None if encryption.key-id is not set.

pub fn encryption_data_key_length(&self) -> Result<usize>

The encryption data encryption key length in bytes.

pub fn write_data_location(&self) -> Result<Option<String>>

Base directory for data files, with any trailing slash trimmed.

pub fn write_folder_storage_location(&self) -> Result<Option<String>>

Deprecated table property for data file write location, with any trailing slash trimmed.

Property will be removed at a later date. Superseded by TableProperties::write_data_location.

pub fn write_object_storage_location(&self) -> Result<Option<String>>

Deprecated table property for data file write location for object storage location generator, with any trailing slash trimmed.

Property will be removed at a later date. Superseded by TableProperties::write_data_location.

pub fn write_object_storage_partitioned_paths(&self) -> Result<bool>

Whether partition values are included in object storage paths.

pub fn default_name_mapping(&self) -> Result<Option<NameMapping>>

The table’s default name mapping, used to assign field ids when reading data files that carry no field id metadata. None if schema.name-mapping.default is not set.

impl TableProperties<'_>

pub const PROPERTY_FORMAT_VERSION: &'static str = "format-version"

Reserved table property for table format version.

Iceberg will default a new table’s format version to the latest stable and recommended version. This reserved property keyword allows users to override the Iceberg format version of the table metadata.

If this table property exists when creating a table, the table will use the specified format version. If a table updates this property, it will try to upgrade to the specified format version.

pub const PROPERTY_UUID: &'static str = "uuid"

Reserved table property for table UUID.

pub const PROPERTY_SNAPSHOT_COUNT: &'static str = "snapshot-count"

Reserved table property for the total number of snapshots.

pub const PROPERTY_CURRENT_SNAPSHOT_SUMMARY: &'static str = "current-snapshot-summary"

Reserved table property for current snapshot summary.

pub const PROPERTY_CURRENT_SNAPSHOT_ID: &'static str = "current-snapshot-id"

Reserved table property for current snapshot id.

pub const PROPERTY_CURRENT_SNAPSHOT_TIMESTAMP: &'static str = "current-snapshot-timestamp-ms"

Reserved table property for current snapshot timestamp.

pub const PROPERTY_CURRENT_SCHEMA: &'static str = "current-schema"

Reserved table property for the JSON representation of current schema.

pub const PROPERTY_DEFAULT_PARTITION_SPEC: &'static str = "default-partition-spec"

Reserved table property for the JSON representation of current(default) partition spec.

pub const PROPERTY_DEFAULT_SORT_ORDER: &'static str = "default-sort-order"

Reserved table property for the JSON representation of current(default) sort order.

pub const PROPERTY_METADATA_PREVIOUS_VERSIONS_MAX: &'static str = "write.metadata.previous-versions-max"

Property key for max number of previous versions to keep.

pub const PROPERTY_METADATA_PREVIOUS_VERSIONS_MAX_DEFAULT: usize = 100

Default value for max number of previous versions to keep.

pub const PROPERTY_WRITE_PARTITION_SUMMARY_LIMIT: &'static str = "write.summary.partition-limit"

Property key for max number of partitions to keep summary stats for.

pub const PROPERTY_WRITE_PARTITION_SUMMARY_LIMIT_DEFAULT: u64 = 0

Default value for the max number of partitions to keep summary stats for.

pub const RESERVED_PROPERTIES: [&'static str; 9]

Reserved Iceberg table properties list.

Reserved table properties are only used to control behaviors when creating or updating a table. The value of these properties are not persisted as a part of the table metadata.

pub const PROPERTY_COMMIT_NUM_RETRIES: &'static str = "commit.retry.num-retries"

Property key for number of commit retries.

pub const PROPERTY_COMMIT_NUM_RETRIES_DEFAULT: usize = 4

Default value for number of commit retries.

pub const PROPERTY_COMMIT_MIN_RETRY_WAIT_MS: &'static str = "commit.retry.min-wait-ms"

Property key for minimum wait time (ms) between retries.

pub const PROPERTY_COMMIT_MIN_RETRY_WAIT_MS_DEFAULT: u64 = 100

Default value for minimum wait time (ms) between retries.

pub const PROPERTY_COMMIT_MAX_RETRY_WAIT_MS: &'static str = "commit.retry.max-wait-ms"

Property key for maximum wait time (ms) between retries.

pub const PROPERTY_COMMIT_MAX_RETRY_WAIT_MS_DEFAULT: u64

Default value for maximum wait time (ms) between retries.

pub const PROPERTY_COMMIT_TOTAL_RETRY_TIME_MS: &'static str = "commit.retry.total-timeout-ms"

Property key for total maximum retry time (ms).

pub const PROPERTY_COMMIT_TOTAL_RETRY_TIME_MS_DEFAULT: u64

Default value for total maximum retry time (ms).

pub const PROPERTY_DEFAULT_FILE_FORMAT: &'static str = "write.format.default"

Default file format for data files

pub const PROPERTY_DELETE_DEFAULT_FILE_FORMAT: &'static str = "write.delete.format.default"

Default file format for delete files

pub const PROPERTY_DEFAULT_FILE_FORMAT_DEFAULT: &'static str = "parquet"

Default value for data file format

pub const PROPERTY_WRITE_TARGET_FILE_SIZE_BYTES: &'static str = "write.target-file-size-bytes"

Target file size for newly written files.

pub const PROPERTY_WRITE_TARGET_FILE_SIZE_BYTES_DEFAULT: usize

Default target file size

pub const PROPERTY_WRITE_METADATA_PATH: &'static str = "write.metadata.path"

Base location for metadata files (manifests, manifest lists, table metadata). When unset, metadata files default to the metadata directory under the table location.

pub const PROPERTY_DEFAULT_NAME_MAPPING: &'static str = "schema.name-mapping.default"

Property key for the table’s default name mapping, stored as a JSON NameMapping document.

pub const PROPERTY_METADATA_COMPRESSION_CODEC: &'static str = "write.metadata.compression-codec"

Compression codec for metadata files (JSON)

pub const PROPERTY_METADATA_COMPRESSION_CODEC_DEFAULT: &'static str = "none"

Default metadata compression codec - uncompressed

pub const PROPERTY_DATAFUSION_WRITE_FANOUT_ENABLED: &'static str = "write.datafusion.fanout.enabled"

Whether to use FanoutWriter for partitioned tables (handles unsorted data). If false, uses ClusteredWriter (requires sorted data, more memory efficient).

pub const PROPERTY_DATAFUSION_WRITE_FANOUT_ENABLED_DEFAULT: bool = true

Default value for fanout writer enabled

pub const PROPERTY_GC_ENABLED: &'static str = "gc.enabled"

Property key for enabling garbage collection on drop. When set to false, data files will not be deleted when a table is dropped. Defaults to true.

pub const PROPERTY_GC_ENABLED_DEFAULT: bool = true

Default value for gc.enabled

pub const PROPERTY_MAX_SNAPSHOT_AGE_MS: &'static str = "history.expire.max-snapshot-age-ms"

Property key for the default maximum age of a snapshot to keep when expiring snapshots.

pub const PROPERTY_MAX_SNAPSHOT_AGE_MS_DEFAULT: i64

Default value for history.expire.max-snapshot-age-ms (5 days).

pub const PROPERTY_MIN_SNAPSHOTS_TO_KEEP: &'static str = "history.expire.min-snapshots-to-keep"

Property key for the default minimum number of snapshots to keep when expiring snapshots.

pub const PROPERTY_MIN_SNAPSHOTS_TO_KEEP_DEFAULT: usize = 1

Default value for history.expire.min-snapshots-to-keep.

pub const PROPERTY_MAX_REF_AGE_MS: &'static str = "history.expire.max-ref-age-ms"

Property key for the default maximum age of a snapshot reference to keep when expiring.

pub const PROPERTY_MAX_REF_AGE_MS_DEFAULT: i64 = i64::MAX

Default value for history.expire.max-ref-age-ms (effectively never expire refs).

pub const PROPERTY_PARQUET_CDC_ENABLED: &'static str = "write.parquet.content-defined-chunking.enabled"

Enable content-defined chunking with parquet defaults (or per-property overrides).

pub const PROPERTY_PARQUET_CDC_ENABLED_DEFAULT: bool = false

Default value for content-defined chunking enabled.

pub const PROPERTY_PARQUET_CDC_MIN_CHUNK_SIZE: &'static str = "write.parquet.content-defined-chunking.min-chunk-size"

Minimum chunk size in bytes for content-defined chunking.

pub const PROPERTY_PARQUET_CDC_MIN_CHUNK_SIZE_DEFAULT: usize

Default matches parquet::file::properties::DEFAULT_CDC_MIN_CHUNK_SIZE.

pub const PROPERTY_PARQUET_CDC_MAX_CHUNK_SIZE: &'static str = "write.parquet.content-defined-chunking.max-chunk-size"

Maximum chunk size in bytes for content-defined chunking.

pub const PROPERTY_PARQUET_CDC_MAX_CHUNK_SIZE_DEFAULT: usize

Default matches parquet::file::properties::DEFAULT_CDC_MAX_CHUNK_SIZE.

pub const PROPERTY_PARQUET_CDC_NORM_LEVEL: &'static str = "write.parquet.content-defined-chunking.norm-level"

Normalization level (gearhash bit adjustment) for content-defined chunking.

pub const PROPERTY_PARQUET_CDC_NORM_LEVEL_DEFAULT: i32 = 0

Default matches parquet::file::properties::DEFAULT_CDC_NORM_LEVEL.

pub const PROPERTY_PARQUET_COMPRESSION_CODEC: &'static str = "write.parquet.compression-codec"

Compression codec for Parquet data files (e.g. zstd, gzip, snappy, lz4, lz4_raw, brotli, lzo, uncompressed). The codec name is parsed into a CompressionCodec when properties are parsed; the level’s range is validated when the writer is built.

pub const PROPERTY_PARQUET_COMPRESSION_CODEC_DEFAULT: &'static str = "zstd"

Default Parquet compression codec.

pub const PROPERTY_PARQUET_COMPRESSION_LEVEL: &'static str = "write.parquet.compression-level"

Compression level for Parquet data files, for codecs that take one (gzip, zstd, brotli). When unset, the codec’s default level is used.

pub const PROPERTY_PARQUET_ROW_GROUP_SIZE_BYTES: &'static str = "write.parquet.row-group-size-bytes"

Approximate maximum size of a Parquet row group in bytes.

pub const PROPERTY_PARQUET_ROW_GROUP_SIZE_BYTES_DEFAULT: usize

Default Parquet row group size in bytes.

pub const PROPERTY_PARQUET_PAGE_SIZE_BYTES: &'static str = "write.parquet.page-size-bytes"

Approximate maximum size of a Parquet data page in bytes.

pub const PROPERTY_PARQUET_PAGE_SIZE_BYTES_DEFAULT: usize

Default Parquet page size in bytes.

pub const PROPERTY_PARQUET_PAGE_ROW_LIMIT: &'static str = "write.parquet.page-row-limit"

Maximum number of rows per Parquet data page.

pub const PROPERTY_PARQUET_PAGE_ROW_LIMIT_DEFAULT: usize = 20000

Default Parquet page row limit.

pub const PROPERTY_PARQUET_DICT_SIZE_BYTES: &'static str = "write.parquet.dict-size-bytes"

Approximate maximum size of the Parquet dictionary page in bytes.

pub const PROPERTY_PARQUET_DICT_SIZE_BYTES_DEFAULT: usize

Default Parquet dictionary page size in bytes.

pub const PROPERTY_ENCRYPTION_KEY_ID: &'static str = "encryption.key-id"

Property key for the master key id used to encrypt the table’s manifest list and data files as defined in https://iceberg.apache.org/docs/nightly/encryption/.

pub const PROPERTY_ENCRYPTION_DATA_KEY_LENGTH: &'static str = "encryption.data-key-length"

Property key for the encryption data encryption key (DEK) length in bytes.

pub const PROPERTY_ENCRYPTION_DATA_KEY_LENGTH_DEFAULT: usize = 16

Default value for the encryption DEK length (16 bytes = AES-128).

pub const PROPERTY_WRITE_DATA_LOCATION: &'static str = "write.data.path"

Property key for the base directory for data files

pub const PROPERTY_WRITE_FOLDER_STORAGE_LOCATION: &'static str = "write.folder-storage.path"

Property key for deprecated TableProperties::write_folder_storage_location

pub const PROPERTY_WRITE_OBJECT_STORAGE_LOCATION: &'static str = "write.object-storage.path"

Property key for deprecated object storage path, kept as a fallback for compatibility.

pub const PROPERTY_WRITE_OBJECT_STORAGE_PARTITIONED_PATHS: &'static str = "write.object-storage.partitioned-paths"

Property key for controlling whether partition values are included in object storage paths.

pub const PROPERTY_WRITE_OBJECT_STORAGE_PARTITIONED_PATHS_DEFAULT: bool = true

Default value for TableProperties::PROPERTY_WRITE_OBJECT_STORAGE_PARTITIONED_PATHS

pub fn data_encryption_key_size(&self) -> Result<AesKeySize>

The AES key size to use when generating data encryption keys, derived from encryption.data-key-length.

Trait Implementations

impl<'properties> Debug for TableProperties<'properties>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.