Struct TableProperties 

pub struct TableProperties {

    pub commit_num_retries: usize,
    pub commit_min_retry_wait_ms: u64,
    pub commit_max_retry_wait_ms: u64,
    pub commit_total_retry_timeout_ms: u64,
    pub write_format_default: String,
    pub write_target_file_size_bytes: usize,
    pub metadata_compression_codec: CompressionCodec,
    pub write_datafusion_fanout_enabled: bool,
    pub gc_enabled: bool,
    pub max_snapshot_age_ms: i64,
    pub min_snapshots_to_keep: usize,
    pub max_ref_age_ms: i64,
    pub cdc_enabled: bool,
    pub cdc_min_chunk_size: usize,
    pub cdc_max_chunk_size: usize,
    pub cdc_norm_level: i32,
    pub encryption_key_id: Option<String>,
    pub encryption_data_key_length: usize,
}

TableProperties that contains the properties of a table.

Fields

commit_num_retries: usize

The number of times to retry a commit.

commit_min_retry_wait_ms: u64

The minimum wait time between retries.

commit_max_retry_wait_ms: u64

The maximum wait time between retries.

commit_total_retry_timeout_ms: u64

The total timeout for commit retries.

write_format_default: String

The default format for files.

write_target_file_size_bytes: usize

The target file size for files.

metadata_compression_codec: CompressionCodec

Compression codec for metadata files (JSON)

write_datafusion_fanout_enabled: bool

Whether to use FanoutWriter for partitioned tables.

gc_enabled: bool

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

max_snapshot_age_ms: i64

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

min_snapshots_to_keep: usize

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

max_ref_age_ms: i64

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

cdc_enabled: bool

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

cdc_min_chunk_size: usize

Content-defined chunking minimum chunk size in bytes.

cdc_max_chunk_size: usize

Content-defined chunking maximum chunk size in bytes.

cdc_norm_level: i32

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

encryption_key_id: 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.

encryption_data_key_length: usize

The encryption data encryption key length in bytes.

Implementations

impl TableProperties

pub const PROPERTY_FORMAT_VERSION: &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: &str = "uuid"

Reserved table property for table UUID.

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

Reserved table property for the total number of snapshots.

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

Reserved table property for current snapshot summary.

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

Reserved table property for current snapshot id.

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

Reserved table property for current snapshot timestamp.

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

Reserved table property for the JSON representation of current schema.

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

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

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

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

pub const PROPERTY_METADATA_PREVIOUS_VERSIONS_MAX: &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: &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: [&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: &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: &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: &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: &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: &str = "write.format.default"

Default file format for data files

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

Default file format for delete files

pub const PROPERTY_DEFAULT_FILE_FORMAT_DEFAULT: &str = "parquet"

Default value for data file format

pub const PROPERTY_WRITE_TARGET_FILE_SIZE_BYTES: &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_METADATA_COMPRESSION_CODEC: &str = "write.metadata.compression-codec"

Compression codec for metadata files (JSON)

pub const PROPERTY_METADATA_COMPRESSION_CODEC_DEFAULT: &str = "none"

Default metadata compression codec - uncompressed

pub const PROPERTY_DATAFUSION_WRITE_FANOUT_ENABLED: &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: &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: &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: &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: &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: &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: &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: &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: &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_ENCRYPTION_KEY_ID: &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: &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).

Trait Implementations

impl Debug for TableProperties

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

Formats the value using the given formatter.

impl TryFrom<&HashMap<String, String>> for TableProperties

type Error = Error

The type returned in the event of a conversion error.

fn try_from(props: &HashMap<String, String>) -> Result<Self>

Performs the conversion.