Skip to content

refactor: replace HashMap with TableProperties in TableMetadata (#2028) #2037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vigneshsiva11 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

refactor: replace HashMap with TableProperties in TableMetadata (#2028) #2037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a0b53f8
refactor: replace HashMap with TableProperties in TableMetadata (#2028)
Jan 16, 2026
c8e2003
fix: resolve integration errors and add serde flattening
Jan 16, 2026
4af9794
style: fix mixed indentation in datafusion and location_generator
Jan 16, 2026
cfd42b7
fix: resolve compilation errors and structure test modules
Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions crates/iceberg/src/catalog/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2384,11 +2384,11 @@ mod tests {
let updated_table = table_commit.apply(table).unwrap();

assert_eq!(
updated_table.metadata().properties.get("prop1").unwrap(),
updated_table.metadata().properties.other.get("prop1").unwrap(),
"v1"
);
assert_eq!(
updated_table.metadata().properties.get("prop2").unwrap(),
updated_table.metadata().properties.other.get("prop2").unwrap(),
"v2"
);

Expand Down
113 changes: 42 additions & 71 deletions crates/iceberg/src/spec/table_metadata.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,10 @@ pub use super::table_metadata_builder::{TableMetadataBuildResult, TableMetadataB
use super::{
DEFAULT_PARTITION_SPEC_ID, PartitionSpecRef, PartitionStatisticsFile, SchemaId, SchemaRef,
SnapshotRef, SnapshotRetention, SortOrder, SortOrderRef, StatisticsFile, StructType,
TableProperties,
};
use crate::error::{Result, timestamp_ms_to_utc};
use crate::io::FileIO;
use crate::spec::EncryptedKey;
use crate::spec::{EncryptedKey, TableProperties};
use crate::{Error, ErrorKind};

static MAIN_BRANCH: &str = "main";
Expand Down Expand Up @@ -91,7 +90,7 @@ pub struct TableMetadata {
///A string to string map of table properties. This is used to control settings that
/// affect reading and writing and is not intended to be used for arbitrary metadata.
/// For example, commit.retry.num-retries is used to control the number of commit retries.
pub(crate) properties: HashMap<String, String>,
pub(crate) properties: TableProperties,
/// long ID of the current table snapshot; must be the same as the current
/// ID of the main branch in refs.
pub(crate) current_snapshot_id: Option<i64>,
Expand Down Expand Up @@ -358,16 +357,13 @@ impl TableMetadata {
/// Returns properties of table.
#[inline]
pub fn properties(&self) -> &HashMap<String, String> {
&self.properties
&self.properties.other
}

/// Returns typed table properties parsed from the raw properties map with defaults.
pub fn table_properties(&self) -> Result<TableProperties> {
TableProperties::try_from(&self.properties).map_err(|e| {
Error::new(ErrorKind::DataInvalid, "Invalid table properties").with_source(e)
})
pub fn table_properties(&self) -> &TableProperties {
&self.properties
}

/// Return location of statistics files.
#[inline]
pub fn statistics_iter(&self) -> impl ExactSizeIterator<Item = &StatisticsFile> {
Expand Down Expand Up @@ -969,7 +965,7 @@ pub(super) mod _serde {
default_partition_type,
default_spec,
last_partition_id: value.last_partition_id,
properties: value.properties.unwrap_or_default(),
properties: crate::spec::TableProperties::new(value.properties.unwrap_or_default()),
current_snapshot_id,
snapshots: snapshots
.map(|snapshots| {
Expand Down Expand Up @@ -1082,7 +1078,7 @@ pub(super) mod _serde {
default_partition_type,
default_spec,
last_partition_id: value.last_partition_id,
properties: value.properties.unwrap_or_default(),
properties: crate::spec::TableProperties::new(value.properties.unwrap_or_default()),
current_snapshot_id,
snapshots: snapshots
.map(|snapshots| {
Expand Down Expand Up @@ -1234,7 +1230,7 @@ pub(super) mod _serde {
.unwrap_or_else(|| partition_specs.keys().copied().max().unwrap_or_default()),
partition_specs,
schemas,
properties: value.properties.unwrap_or_default(),
properties: crate::spec::TableProperties::new(value.properties.unwrap_or_default()),
current_snapshot_id,
snapshots: value
.snapshots
Expand Down Expand Up @@ -1361,10 +1357,10 @@ pub(super) mod _serde {
.collect(),
default_spec_id: v.default_spec.spec_id(),
last_partition_id: v.last_partition_id,
properties: if v.properties.is_empty() {
properties: if v.properties.other.is_empty() {
None
} else {
Some(v.properties)
Some(v.properties.other.clone())
},
current_snapshot_id: v.current_snapshot_id,
snapshot_log: if v.snapshot_log.is_empty() {
Expand Down Expand Up @@ -1430,10 +1426,10 @@ pub(super) mod _serde {
),
default_spec_id: Some(v.default_spec.spec_id()),
last_partition_id: Some(v.last_partition_id),
properties: if v.properties.is_empty() {
properties: if v.properties.other.is_empty() {
None
} else {
Some(v.properties)
Some(v.properties.other.clone())
},
current_snapshot_id: v.current_snapshot_id,
snapshots: if v.snapshots.is_empty() {
Expand Down Expand Up @@ -1557,6 +1553,7 @@ impl SnapshotLog {

#[cfg(test)]
mod tests {
use super::*;
use std::collections::HashMap;
use std::fs;
use std::io::Write as _;
Expand All @@ -1577,7 +1574,7 @@ mod tests {
SnapshotReference, SnapshotRetention, SortDirection, SortField, SortOrder, StatisticsFile,
Summary, Transform, Type, UnboundPartitionField,
};
use crate::{ErrorKind, TableCreation};
use crate::TableCreation;

fn check_table_metadata_serde(json: &str, expected_type: TableMetadata) {
let desered_type: TableMetadata = serde_json::from_str(json).unwrap();
Expand Down Expand Up @@ -1709,10 +1706,10 @@ mod tests {
snapshots: HashMap::default(),
current_snapshot_id: None,
last_sequence_number: 1,
properties: HashMap::from_iter(vec![(
"commit.retry.num-retries".to_string(),
"1".to_string(),
)]),
properties: TableProperties::new(HashMap::from_iter(vec![(
"commit.retry.num-retries".to_string(),
"1".to_string(),
)])),
snapshot_log: Vec::new(),
metadata_log: vec![MetadataLog {
metadata_file: "s3://bucket/.../v1.json".to_string(),
Expand Down Expand Up @@ -1847,7 +1844,7 @@ mod tests {
.with_encryption_key_id(Some("key1".to_string()))
.with_summary(Summary {
operation: Operation::Append,
additional_properties: HashMap::new(),
additional_properties: HashMap::new()
})
.with_manifest_list("/home/iceberg/warehouse/nyc/taxis/metadata/snap-638933773299822130-1-7e6760f0-4f6c-4b23-b907-0a5a174e3863.avro".to_string())
.with_schema_id(0)
Expand Down Expand Up @@ -1885,10 +1882,10 @@ mod tests {
snapshots: HashMap::from_iter(vec![(1, snapshot.into())]),
current_snapshot_id: None,
last_sequence_number: 1,
properties: HashMap::from_iter(vec![(
properties: TableProperties::new(HashMap::from_iter(vec![(
"commit.retry.num-retries".to_string(),
"1".to_string(),
)]),
)])),
snapshot_log: Vec::new(),
metadata_log: vec![MetadataLog {
metadata_file: "s3://bucket/.../v1.json".to_string(),
Expand Down Expand Up @@ -2044,8 +2041,13 @@ mod tests {
.with_sequence_number(0)
.with_schema_id(0)
.with_manifest_list("/home/iceberg/warehouse/nyc/taxis/metadata/snap-638933773299822130-1-7e6760f0-4f6c-4b23-b907-0a5a174e3863.avro")
.with_summary(Summary { operation: Operation::Append, additional_properties: HashMap::from_iter(vec![("spark.app.id".to_string(), "local-1662532784305".to_string()), ("added-data-files".to_string(), "4".to_string()), ("added-records".to_string(), "4".to_string()), ("added-files-size".to_string(), "6001".to_string())]) })
.build();
.with_summary(Summary { operation: Operation::Append,
additional_properties: HashMap::from_iter(vec![
("spark.app.id".to_string(), "local-1662532784305".to_string()),
("added-data-files".to_string(), "4".to_string()),
("added-records".to_string(), "4".to_string()),
("added-files-size".to_string(), "6001".to_string()) ]) })
.build();

let default_partition_type = partition_spec.partition_type(&schema).unwrap();
let expected = TableMetadata {
Expand All @@ -2065,7 +2067,7 @@ mod tests {
snapshots: HashMap::from_iter(vec![(638933773299822130, Arc::new(snapshot))]),
current_snapshot_id: Some(638933773299822130),
last_sequence_number: 0,
properties: HashMap::from_iter(vec![("owner".to_string(), "root".to_string())]),
properties: TableProperties::new(HashMap::from_iter(vec![("owner".to_string(), "root".to_string())])),
snapshot_log: vec![SnapshotLog {
snapshot_id: 638933773299822130,
timestamp_ms: 1662532818843,
Expand Down Expand Up @@ -2164,7 +2166,7 @@ mod tests {
snapshots: HashMap::default(),
current_snapshot_id: None,
last_sequence_number: 1,
properties: HashMap::new(),
properties: TableProperties::default(),
snapshot_log: Vec::new(),
metadata_log: vec![MetadataLog {
metadata_file: "s3://bucket/.../v1.json".to_string(),
Expand Down Expand Up @@ -2682,7 +2684,7 @@ mod tests {
snapshots: HashMap::from_iter(vec![(3055729675574597004, Arc::new(snapshot))]),
current_snapshot_id: Some(3055729675574597004),
last_sequence_number: 34,
properties: HashMap::new(),
properties: TableProperties::default(),
snapshot_log: Vec::new(),
metadata_log: Vec::new(),
statistics: HashMap::from_iter(vec![(3055729675574597004, StatisticsFile {
Expand All @@ -2696,7 +2698,7 @@ mod tests {
sequence_number: 1,
fields: vec![1],
r#type: "ndv".to_string(),
properties: HashMap::new(),
properties: HashMap::new(),
}],
})]),
partition_statistics: HashMap::new(),
Expand Down Expand Up @@ -2824,7 +2826,7 @@ mod tests {
snapshots: HashMap::from_iter(vec![(3055729675574597004, Arc::new(snapshot))]),
current_snapshot_id: Some(3055729675574597004),
last_sequence_number: 34,
properties: HashMap::new(),
properties: TableProperties::default(),
snapshot_log: Vec::new(),
metadata_log: Vec::new(),
statistics: HashMap::new(),
Expand Down Expand Up @@ -2950,7 +2952,7 @@ mod tests {
snapshots: HashMap::default(),
current_snapshot_id: None,
last_sequence_number: 34,
properties: HashMap::new(),
properties: TableProperties::default(),
snapshot_log: Vec::new(),
metadata_log: Vec::new(),
refs: HashMap::new(),
Expand Down Expand Up @@ -3074,7 +3076,7 @@ mod tests {
]),
current_snapshot_id: Some(3055729675574597004),
last_sequence_number: 34,
properties: HashMap::new(),
properties: TableProperties::default(),
snapshot_log: vec![
SnapshotLog {
snapshot_id: 3051729675574597004,
Expand Down Expand Up @@ -3176,7 +3178,7 @@ mod tests {
snapshots: HashMap::default(),
current_snapshot_id: None,
last_sequence_number: 34,
properties: HashMap::new(),
properties: TableProperties::default(),
snapshot_log: vec![],
metadata_log: Vec::new(),
refs: HashMap::new(),
Expand Down Expand Up @@ -3246,7 +3248,7 @@ mod tests {
snapshots: HashMap::new(),
current_snapshot_id: None,
last_sequence_number: 0,
properties: HashMap::new(),
properties: TableProperties::default(),
snapshot_log: vec![],
metadata_log: Vec::new(),
refs: HashMap::new(),
Expand Down Expand Up @@ -3510,7 +3512,7 @@ mod tests {
.len(),
0
);
assert_eq!(table_metadata.properties.len(), 0);
assert_eq!(table_metadata.properties.other.len(), 0);
assert_eq!(
table_metadata.partition_specs,
HashMap::from([(
Expand Down Expand Up @@ -3894,7 +3896,7 @@ mod tests {
.unwrap()
.metadata;

let props = metadata.table_properties().unwrap();
let props = metadata.table_properties();

assert_eq!(
props.commit_num_retries,
Expand Down Expand Up @@ -3941,41 +3943,10 @@ mod tests {
.unwrap()
.metadata;

let props = metadata.table_properties().unwrap();

assert_eq!(props.commit_num_retries, 10);
let props = metadata.table_properties();
assert_eq!(props.commit_num_retries, 10);
assert_eq!(props.write_target_file_size_bytes, 1024);
}

#[test]
fn test_table_properties_with_invalid_value() {
let schema = Schema::builder()
.with_fields(vec![
NestedField::required(1, "id", Type::Primitive(PrimitiveType::Long)).into(),
])
.build()
.unwrap();

let properties = HashMap::from([(
"commit.retry.num-retries".to_string(),
"not_a_number".to_string(),
)]);

let metadata = TableMetadataBuilder::new(
schema,
PartitionSpec::unpartition_spec().into_unbound(),
SortOrder::unsorted_order(),
"s3://test/location".to_string(),
FormatVersion::V2,
properties,
)
.unwrap()
.build()
.unwrap()
.metadata;

let err = metadata.table_properties().unwrap_err();
assert_eq!(err.kind(), ErrorKind::DataInvalid);
assert!(err.message().contains("Invalid table properties"));
}
}
11 changes: 6 additions & 5 deletions crates/iceberg/src/spec/table_metadata_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ impl TableMetadataBuilder {
), // Overwritten immediately by add_default_partition_spec
default_partition_type: StructType::new(vec![]),
last_partition_id: UNPARTITIONED_LAST_ASSIGNED_ID,
properties: HashMap::new(),
properties: TableProperties::default(),
current_snapshot_id: None,
snapshots: HashMap::new(),
snapshot_log: vec![],
Expand Down Expand Up @@ -272,7 +272,7 @@ impl TableMetadataBuilder {
return Ok(self);
}

self.metadata.properties.extend(properties.clone());
self.metadata.properties.other.extend(properties.clone());
self.changes.push(TableUpdate::SetProperties {
updates: properties,
});
Expand Down Expand Up @@ -307,7 +307,7 @@ impl TableMetadataBuilder {
}

for property in &properties {
self.metadata.properties.remove(property);
self.metadata.properties.other.remove(property);
}

if !properties.is_empty() {
Expand Down Expand Up @@ -1128,6 +1128,7 @@ impl TableMetadataBuilder {
let max_size = self
.metadata
.properties
.other
.get(TableProperties::PROPERTY_METADATA_PREVIOUS_VERSIONS_MAX)
.and_then(|v| v.parse::<usize>().ok())
.unwrap_or(TableProperties::PROPERTY_METADATA_PREVIOUS_VERSIONS_MAX_DEFAULT)
Expand Down Expand Up @@ -1510,7 +1511,7 @@ mod tests {
assert_eq!(metadata.snapshots.len(), 0);
assert_eq!(metadata.current_snapshot_id, None);
assert_eq!(metadata.refs.len(), 0);
assert_eq!(metadata.properties.len(), 0);
assert_eq!(metadata.properties.other.len(), 0);
assert_eq!(metadata.metadata_log.len(), 0);
assert_eq!(metadata.last_sequence_number, 0);
assert_eq!(metadata.last_column_id, LAST_ASSIGNED_COLUMN_ID);
Expand Down Expand Up @@ -1559,7 +1560,7 @@ mod tests {
assert_eq!(metadata.snapshots.len(), 0);
assert_eq!(metadata.current_snapshot_id, None);
assert_eq!(metadata.refs.len(), 0);
assert_eq!(metadata.properties.len(), 0);
assert_eq!(metadata.properties.other.len(), 0);
assert_eq!(metadata.metadata_log.len(), 0);
assert_eq!(metadata.last_sequence_number, 0);
}
Expand Down
Loading
Loading