Skip to content

[branch-48] Add support for Arrow Dictionary type in Substrait (#16608) #34

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

Merged
merged 2 commits into from
Jul 28, 2025
Merged

[branch-48] Add support for Arrow Dictionary type in Substrait (#16608) #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e616f1
Add support for Arrow Dictionary type in Substrait (#16608)
jkosh44 Jul 7, 2025
e82ca66
Remove DataDog Specific Workaround
LiaCastaneda Jul 28, 2025
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
45 changes: 27 additions & 18 deletions datafusion/substrait/src/logical_plan/consumer/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ use super::SubstraitConsumer;
use crate::variation_const::{
DATE_32_TYPE_VARIATION_REF, DATE_64_TYPE_VARIATION_REF,
DECIMAL_128_TYPE_VARIATION_REF, DECIMAL_256_TYPE_VARIATION_REF,
DEFAULT_CONTAINER_TYPE_VARIATION_REF, DEFAULT_TYPE_VARIATION_REF,
DEFAULT_CONTAINER_TYPE_VARIATION_REF, DEFAULT_MAP_TYPE_VARIATION_REF,
DEFAULT_TYPE_VARIATION_REF, DICTIONARY_MAP_TYPE_VARIATION_REF,
INTERVAL_DAY_TIME_TYPE_REF, INTERVAL_MONTH_DAY_NANO_TYPE_NAME,
INTERVAL_MONTH_DAY_NANO_TYPE_REF, INTERVAL_YEAR_MONTH_TYPE_REF,
LARGE_CONTAINER_TYPE_VARIATION_REF, TIMESTAMP_MICRO_TYPE_VARIATION_REF,
Expand Down Expand Up @@ -180,24 +181,32 @@ pub fn from_substrait_type(
let value_type = map.value.as_ref().ok_or_else(|| {
substrait_datafusion_err!("Map type must have value type")
})?;
let key_field = Arc::new(Field::new(
"key",
from_substrait_type(consumer, key_type, dfs_names, name_idx)?,
false,
));
let value_field = Arc::new(Field::new(
"value",
from_substrait_type(consumer, value_type, dfs_names, name_idx)?,
true,
));
Ok(DataType::Map(
Arc::new(Field::new_struct(
"entries",
[key_field, value_field],
false, // The inner map field is always non-nullable (Arrow #1697),
let key_type =
from_substrait_type(consumer, key_type, dfs_names, name_idx)?;
let value_type =
from_substrait_type(consumer, value_type, dfs_names, name_idx)?;

match map.type_variation_reference {
DEFAULT_MAP_TYPE_VARIATION_REF => {
let key_field = Arc::new(Field::new("key", key_type, false));
let value_field = Arc::new(Field::new("value", value_type, true));
Ok(DataType::Map(
Arc::new(Field::new_struct(
"entries",
[key_field, value_field],
false, // The inner map field is always non-nullable (Arrow #1697),
)),
false, // whether keys are sorted
))
}
DICTIONARY_MAP_TYPE_VARIATION_REF => Ok(DataType::Dictionary(
Box::new(key_type),
Box::new(value_type),
)),
false, // whether keys are sorted
))
v => not_impl_err!(
"Unsupported Substrait type variation {v} of type {s_kind:?}"
),
}
}
r#type::Kind::Decimal(d) => match d.type_variation_reference {
DECIMAL_128_TYPE_VARIATION_REF => {
Expand Down
23 changes: 19 additions & 4 deletions datafusion/substrait/src/logical_plan/producer/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ use crate::variation_const::TIMESTAMP_NANO_TYPE_VARIATION_REF;
use crate::variation_const::{
DATE_32_TYPE_VARIATION_REF, DATE_64_TYPE_VARIATION_REF,
DECIMAL_128_TYPE_VARIATION_REF, DECIMAL_256_TYPE_VARIATION_REF,
DEFAULT_CONTAINER_TYPE_VARIATION_REF, DEFAULT_TYPE_VARIATION_REF,
DEFAULT_CONTAINER_TYPE_VARIATION_REF, DEFAULT_MAP_TYPE_VARIATION_REF,
DEFAULT_TYPE_VARIATION_REF, DICTIONARY_MAP_TYPE_VARIATION_REF,
LARGE_CONTAINER_TYPE_VARIATION_REF, UNSIGNED_INTEGER_TYPE_VARIATION_REF,
VIEW_CONTAINER_TYPE_VARIATION_REF,
};
Expand Down Expand Up @@ -235,13 +236,25 @@ pub(crate) fn to_substrait_type(
kind: Some(r#type::Kind::Map(Box::new(r#type::Map {
key: Some(Box::new(key_type)),
value: Some(Box::new(value_type)),
type_variation_reference: DEFAULT_CONTAINER_TYPE_VARIATION_REF,
type_variation_reference: DEFAULT_MAP_TYPE_VARIATION_REF,
nullability,
}))),
})
}
_ => plan_err!("Map fields must contain a Struct with exactly 2 fields"),
},
DataType::Dictionary(key_type, value_type) => {
let key_type = to_substrait_type(key_type, nullable)?;
let value_type = to_substrait_type(value_type, nullable)?;
Ok(substrait::proto::Type {
kind: Some(r#type::Kind::Map(Box::new(r#type::Map {
key: Some(Box::new(key_type)),
value: Some(Box::new(value_type)),
type_variation_reference: DICTIONARY_MAP_TYPE_VARIATION_REF,
nullability,
}))),
})
}
DataType::Struct(fields) => {
let field_types = fields
.iter()
Expand Down Expand Up @@ -271,8 +284,6 @@ pub(crate) fn to_substrait_type(
precision: *p as i32,
})),
}),
// TODO: DataDog-specific workaround, don't commit upstream
DataType::Dictionary(_, dt) => to_substrait_type(dt, nullable),
Copy link
Author

@LiaCastaneda LiaCastaneda Jul 28, 2025

Choose a reason for hiding this comment

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

Added here #28 , I don't think its necessary anymore as now we have proper handling

_ => not_impl_err!("Unsupported cast type: {dt:?}"),
}
}
Expand Down Expand Up @@ -365,6 +376,10 @@ mod tests {
.into(),
false,
))?;
round_trip_type(DataType::Dictionary(
Box::new(DataType::Utf8),
Box::new(DataType::Int32),
))?;

round_trip_type(DataType::Struct(
vec![
Expand Down
2 changes: 2 additions & 0 deletions datafusion/substrait/src/variation_const.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ pub const DATE_64_TYPE_VARIATION_REF: u32 = 1;
pub const DEFAULT_CONTAINER_TYPE_VARIATION_REF: u32 = 0;
pub const LARGE_CONTAINER_TYPE_VARIATION_REF: u32 = 1;
pub const VIEW_CONTAINER_TYPE_VARIATION_REF: u32 = 2;
pub const DEFAULT_MAP_TYPE_VARIATION_REF: u32 = 0;
pub const DICTIONARY_MAP_TYPE_VARIATION_REF: u32 = 1;
pub const DECIMAL_128_TYPE_VARIATION_REF: u32 = 0;
pub const DECIMAL_256_TYPE_VARIATION_REF: u32 = 1;

Expand Down
Loading