Skip to content
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

name mapping serde #740

Merged
merged 1 commit into from
Dec 10, 2024
+308 −0
Merged

name mapping serde #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions crates/iceberg/src/spec/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
mod datatypes;
mod manifest;
mod manifest_list;
mod name_mapping;
Copy link
Contributor Author

@barronw barronw Nov 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please let me know if I should also expose the name mapping in TableMetadata and Table (as pyiceberg does).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can add them later on 👍

mod partition;
mod schema;
mod snapshot;
Expand Down
307 changes: 307 additions & 0 deletions crates/iceberg/src/spec/name_mapping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,307 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

//! Iceberg name mapping.

use serde::{Deserialize, Serialize};
use serde_with::{serde_as, DefaultOnNull};

/// Iceberg fallback field name to ID mapping.
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(transparent)]
pub struct NameMapping {
pub root: Vec<MappedField>,
}

/// Maps field names to IDs.
#[serde_as]
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "kebab-case")]
pub struct MappedField {
#[serde(skip_serializing_if = "Option::is_none")]
pub field_id: Option<i32>,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Fokko I noticed that pyiceberg has this field as required instead of optional (reference), but the spec says that tables may omit this field (reference).

Fields that exist in imported files but not in the Iceberg schema may omit field-id.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I noticed that field-id is optional in Java as well. Created an issue on PyIceberg: apache/iceberg-python#1420

pub names: Vec<String>,
#[serde(default)]
#[serde(skip_serializing_if = "Vec::is_empty")]
#[serde_as(deserialize_as = "DefaultOnNull")]
pub fields: Vec<MappedField>,
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn test_json_mapped_field_deserialization() {
let expected = MappedField {
field_id: Some(1),
names: vec!["id".to_string(), "record_id".to_string()],
fields: vec![],
};
let mapped_field = r#"
{
"field-id": 1,
"names": ["id", "record_id"]
}
"#;

let mapped_field: MappedField = serde_json::from_str(mapped_field).unwrap();
assert_eq!(mapped_field, expected);

let mapped_field_with_null_fields = r#"
{
"field-id": 1,
"names": ["id", "record_id"],
"fields": null
}
"#;

let mapped_field_with_null_fields: MappedField =
serde_json::from_str(mapped_field_with_null_fields).unwrap();
assert_eq!(mapped_field_with_null_fields, expected);
}

#[test]
fn test_json_mapped_field_no_names_deserialization() {
let expected = MappedField {
field_id: Some(1),
names: vec![],
fields: vec![],
};
let mapped_field = r#"
{
"field-id": 1,
"names": []
}
"#;

let mapped_field: MappedField = serde_json::from_str(mapped_field).unwrap();
assert_eq!(mapped_field, expected);

let mapped_field_with_null_fields = r#"
{
"field-id": 1,
"names": [],
"fields": null
}
"#;

let mapped_field_with_null_fields: MappedField =
serde_json::from_str(mapped_field_with_null_fields).unwrap();
assert_eq!(mapped_field_with_null_fields, expected);
}

#[test]
fn test_json_mapped_field_no_field_id_deserialization() {
let expected = MappedField {
field_id: None,
names: vec!["id".to_string(), "record_id".to_string()],
fields: vec![],
};
let mapped_field = r#"
{
"names": ["id", "record_id"]
}
"#;

let mapped_field: MappedField = serde_json::from_str(mapped_field).unwrap();
assert_eq!(mapped_field, expected);

let mapped_field_with_null_fields = r#"
{
"names": ["id", "record_id"],
"fields": null
}
"#;

let mapped_field_with_null_fields: MappedField =
serde_json::from_str(mapped_field_with_null_fields).unwrap();
assert_eq!(mapped_field_with_null_fields, expected);
}

#[test]
fn test_json_name_mapping_deserialization() {
let name_mapping = r#"
[
{
"field-id": 1,
"names": [
"id",
"record_id"
]
},
{
"field-id": 2,
"names": [
"data"
]
},
{
"field-id": 3,
"names": [
"location"
],
"fields": [
{
"field-id": 4,
"names": [
"latitude",
"lat"
]
},
{
"field-id": 5,
"names": [
"longitude",
"long"
]
}
]
}
]
"#;

let name_mapping: NameMapping = serde_json::from_str(name_mapping).unwrap();
assert_eq!(name_mapping, NameMapping {
root: vec![
MappedField {
field_id: Some(1),
names: vec!["id".to_string(), "record_id".to_string()],
fields: vec![]
},
MappedField {
field_id: Some(2),
names: vec!["data".to_string()],
fields: vec![]
},
MappedField {
field_id: Some(3),
names: vec!["location".to_string()],
fields: vec![
MappedField {
field_id: Some(4),
names: vec!["latitude".to_string(), "lat".to_string()],
fields: vec![]
},
MappedField {
field_id: Some(5),
names: vec!["longitude".to_string(), "long".to_string()],
fields: vec![]
},
]
}
]
});
}

#[test]
fn test_json_name_mapping_serialization() {
let name_mapping = NameMapping {
root: vec![
MappedField {
field_id: None,
names: vec!["foo".to_string()],
fields: vec![],
},
MappedField {
field_id: Some(2),
names: vec!["bar".to_string()],
fields: vec![],
},
MappedField {
field_id: Some(3),
names: vec!["baz".to_string()],
fields: vec![],
},
MappedField {
field_id: Some(4),
names: vec!["qux".to_string()],
fields: vec![MappedField {
field_id: Some(5),
names: vec!["element".to_string()],
fields: vec![],
}],
},
MappedField {
field_id: Some(6),
names: vec!["quux".to_string()],
fields: vec![
MappedField {
field_id: Some(7),
names: vec!["key".to_string()],
fields: vec![],
},
MappedField {
field_id: Some(8),
names: vec!["value".to_string()],
fields: vec![
MappedField {
field_id: Some(9),
names: vec!["key".to_string()],
fields: vec![],
},
MappedField {
field_id: Some(10),
names: vec!["value".to_string()],
fields: vec![],
},
],
},
],
},
MappedField {
field_id: Some(11),
names: vec!["location".to_string()],
fields: vec![MappedField {
field_id: Some(12),
names: vec!["element".to_string()],
fields: vec![
MappedField {
field_id: Some(13),
names: vec!["latitude".to_string()],
fields: vec![],
},
MappedField {
field_id: Some(14),
names: vec!["longitude".to_string()],
fields: vec![],
},
],
}],
},
MappedField {
field_id: Some(15),
names: vec!["person".to_string()],
fields: vec![
MappedField {
field_id: Some(16),
names: vec!["name".to_string()],
fields: vec![],
},
MappedField {
field_id: Some(17),
names: vec!["age".to_string()],
fields: vec![],
},
],
},
],
};
let expected = r#"[{"names":["foo"]},{"field-id":2,"names":["bar"]},{"field-id":3,"names":["baz"]},{"field-id":4,"names":["qux"],"fields":[{"field-id":5,"names":["element"]}]},{"field-id":6,"names":["quux"],"fields":[{"field-id":7,"names":["key"]},{"field-id":8,"names":["value"],"fields":[{"field-id":9,"names":["key"]},{"field-id":10,"names":["value"]}]}]},{"field-id":11,"names":["location"],"fields":[{"field-id":12,"names":["element"],"fields":[{"field-id":13,"names":["latitude"]},{"field-id":14,"names":["longitude"]}]}]},{"field-id":15,"names":["person"],"fields":[{"field-id":16,"names":["name"]},{"field-id":17,"names":["age"]}]}]"#;
assert_eq!(serde_json::to_string(&name_mapping).unwrap(), expected);
}
}
Loading