rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-26 14:49:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify the arguments for replace_field_metadata (#2053)

Browse Source 
When calling `replace_field_metadata` we pass in an iter of tuples
`(u32, HashMap<String, String>)`.

That `u32` needs to be the field id from the lance schema

7f60aa0a87/rust/lance-core/src/datatypes/field.rs (L123)

This can sometimes be different than the index of the field in the arrow
schema (e.g. if fields have been dropped).

This PR adds docs that try to clarify what that argument should be, as
well as corrects the usage in the test (which was improperly passing the
index of the arrow schema).
This commit is contained in:
Bert
2025-01-23 08:52:27 -05:00
committed by GitHub
parent 48ed3bb544
commit c05d45150d
1 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
rust/lancedb/src/table.rs
View File

@@ -1742,6 +1742,12 @@ impl NativeTable {
}
/// Update field metadata
///
/// # Arguments:
/// * `new_values` - An iterator of tuples where the first element is the
/// field id and the second element is a hashmap of metadata key-value
/// pairs.
///
pub async fn replace_field_metadata(
&self,
new_values: impl IntoIterator<Item = (u32, HashMap<String, String>)>,
@@ -3530,11 +3536,10 @@ mod tests {
.unwrap();
let native_tbl = table.as_native().unwrap();
let schema = native_tbl.schema().await.unwrap();
let schema = native_tbl.manifest().await.unwrap().schema;
let (field_idx, field) = schema.column_with_name("i").unwrap();
let field_metadata = field.metadata();
assert_eq!(field_metadata.len(), 0);
let field = schema.field("i").unwrap();
assert_eq!(field.metadata.len(), 0);
native_tbl
.replace_schema_metadata(vec![(
@@ -3555,16 +3560,15 @@ mod tests {
let mut new_field_metadata = HashMap::<String, String>::new();
new_field_metadata.insert("test_field_key1".into(), "test_field_val1".into());
native_tbl
.replace_field_metadata(vec![(field_idx as u32, new_field_metadata)])
.replace_field_metadata(vec![(field.id as u32, new_field_metadata)])
.await
.unwrap();
let schema = native_tbl.schema().await.unwrap();
let (_field_idx, field) = schema.column_with_name("i").unwrap();
let field_metadata = field.metadata();
assert_eq!(field_metadata.len(), 1);
let schema = native_tbl.manifest().await.unwrap().schema;
let field = schema.field("i").unwrap();
assert_eq!(field.metadata.len(), 1);
assert_eq!(
field_metadata.get("test_field_key1"),
field.metadata.get("test_field_key1"),
Some(&"test_field_val1".to_string())
);
}