Skip to content

fix(proto): preserve AnalyzeExec metric types across serialization #24669

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
haohuaijin wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(proto): preserve AnalyzeExec metric types across serialization #24669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
506326a
fix(proto): preserve AnalyzeExec metric types across serialization
haohuaijin Aug 25, 2026
858933f
update
haohuaijin Aug 25, 2026
3644720
fix coverage
haohuaijin Aug 26, 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
61 changes: 48 additions & 13 deletions datafusion/physical-plan/src/analyze.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,7 @@ impl ExecutionPlan for AnalyzeExec {
let Self {
verbose,
show_statistics,
// TODO: not on the wire. `AnalyzeExecBuilder` always resets this to
// `[Summary, Dev]`, so a non-default selection is lost on
// round-trip. Fixing it needs a new proto field.
metric_types: _,
metric_types,
metric_categories,
format,
input,
Expand All @@ -365,6 +362,13 @@ impl ExecutionPlan for AnalyzeExec {
ExplainFormat::PostgresJSON => protobuf::ExplainFormat::Pgjson,
ExplainFormat::Graphviz => protobuf::ExplainFormat::Graphviz,
} as i32;
let metric_types = metric_types
.iter()
.map(|metric_type| match metric_type {
MetricType::Summary => protobuf::MetricType::Summary,
MetricType::Dev => protobuf::MetricType::Dev,
} as i32)
.collect();
Ok(Some(protobuf::PhysicalPlanNode {
physical_plan_type: Some(
protobuf::physical_plan_node::PhysicalPlanType::Analyze(Box::new(
Expand All @@ -376,6 +380,8 @@ impl ExecutionPlan for AnalyzeExec {
has_metric_categories,
metric_categories,
format,
has_metric_types: true,
metric_types,
},
)),
),
Expand Down Expand Up @@ -407,10 +413,33 @@ impl AnalyzeExec {
has_metric_categories,
metric_categories,
format,
has_metric_types,
metric_types,
} = analyze.as_ref();

let input =
ctx.decode_required_child(input.as_deref(), "AnalyzeExec", "input")?;
let metric_types = if *has_metric_types {
Some(
metric_types
.iter()
.map(|metric_type| {
let metric_type = protobuf::MetricType::try_from(*metric_type)
.map_err(|_| {
datafusion_common::internal_datafusion_err!(
"Received an AnalyzeExecNode message with unknown MetricType {metric_type}"
)
})?;
Ok(match metric_type {
protobuf::MetricType::Summary => MetricType::Summary,
protobuf::MetricType::Dev => MetricType::Dev,
})
})
.collect::<Result<Vec<_>>>()?,
)
} else {
None
};
let metric_categories = if *has_metric_categories {
Some(
metric_categories
Expand All @@ -437,16 +466,22 @@ impl AnalyzeExec {
"AnalyzeExec is missing required field 'schema'"
)
})?;
let mut builder = AnalyzeExec::builder(
*verbose,
*show_statistics,
input,
Arc::new(arrow::datatypes::Schema::try_from(schema)?),
);
// Retain the builder default for plans written before `metric_types`
// and its presence bit were added.
if let Some(metric_types) = metric_types {
builder = builder.with_metric_types(metric_types);
}
Ok(Arc::new(
AnalyzeExec::builder(
*verbose,
*show_statistics,
input,
Arc::new(arrow::datatypes::Schema::try_from(schema)?),
)
.with_metric_categories(metric_categories)
.with_format(format)
.build(),
builder
.with_metric_categories(metric_categories)
.with_format(format)
.build(),
))
}
}
Expand Down
4 changes: 4 additions & 0 deletions datafusion/proto-models/proto/datafusion.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1397,6 +1397,10 @@ message AnalyzeExecNode {
bool has_metric_categories = 5;
repeated string metric_categories = 6;
datafusion_common.ExplainFormat format = 7;
// Whether metric_types is present. False means use SUMMARY and DEV.
bool has_metric_types = 8;
// Types of metrics to display.
repeated datafusion_common.MetricType metric_types = 9;
}

message CrossJoinExecNode {
Expand Down
1 change: 1 addition & 0 deletions datafusion/proto-models/src/generated/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
// This code is generated so we don't want to fix any lint violations manually
#[allow(clippy::allow_attributes)]
#[allow(clippy::all)]
#[allow(clippy::uninlined_format_args)]
#[allow(unused_qualifications)]
#[rustfmt::skip]
pub mod datafusion {
Expand Down
40 changes: 40 additions & 0 deletions datafusion/proto-models/src/generated/pbjson.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,6 +1019,12 @@ impl serde::Serialize for AnalyzeExecNode {
if self.format != 0 {
len += 1;
}
if self.has_metric_types {
len += 1;
}
if !self.metric_types.is_empty() {
len += 1;
}
let mut struct_ser = serializer.serialize_struct("datafusion.AnalyzeExecNode", len)?;
if self.verbose {
struct_ser.serialize_field("verbose", &self.verbose)?;
Expand All @@ -1043,6 +1049,16 @@ impl serde::Serialize for AnalyzeExecNode {
.map_err(|_| serde::ser::Error::custom(format!("Invalid variant {}", self.format)))?;
struct_ser.serialize_field("format", &v)?;
}
if self.has_metric_types {
struct_ser.serialize_field("hasMetricTypes", &self.has_metric_types)?;
}
if !self.metric_types.is_empty() {
let v = self.metric_types.iter().cloned().map(|v| {
super::datafusion_common::MetricType::try_from(v)
.map_err(|_| serde::ser::Error::custom(format!("Invalid variant {}", v)))
}).collect::<std::result::Result<Vec<_>, _>>()?;
struct_ser.serialize_field("metricTypes", &v)?;
}
struct_ser.end()
}
}
Expand All @@ -1063,6 +1079,10 @@ impl<'de> serde::Deserialize<'de> for AnalyzeExecNode {
"metric_categories",
"metricCategories",
"format",
"has_metric_types",
"hasMetricTypes",
"metric_types",
"metricTypes",
];

#[allow(clippy::enum_variant_names)]
Expand All @@ -1074,6 +1094,8 @@ impl<'de> serde::Deserialize<'de> for AnalyzeExecNode {
HasMetricCategories,
MetricCategories,
Format,
HasMetricTypes,
MetricTypes,
}
impl<'de> serde::Deserialize<'de> for GeneratedField {
fn deserialize<D>(deserializer: D) -> std::result::Result<GeneratedField, D::Error>
Expand Down Expand Up @@ -1102,6 +1124,8 @@ impl<'de> serde::Deserialize<'de> for AnalyzeExecNode {
"hasMetricCategories" | "has_metric_categories" => Ok(GeneratedField::HasMetricCategories),
"metricCategories" | "metric_categories" => Ok(GeneratedField::MetricCategories),
"format" => Ok(GeneratedField::Format),
"hasMetricTypes" | "has_metric_types" => Ok(GeneratedField::HasMetricTypes),
"metricTypes" | "metric_types" => Ok(GeneratedField::MetricTypes),
_ => Err(serde::de::Error::unknown_field(value, FIELDS)),
}
}
Expand All @@ -1128,6 +1152,8 @@ impl<'de> serde::Deserialize<'de> for AnalyzeExecNode {
let mut has_metric_categories__ = None;
let mut metric_categories__ = None;
let mut format__ = None;
let mut has_metric_types__ = None;
let mut metric_types__ = None;
while let Some(k) = map_.next_key()? {
match k {
GeneratedField::Verbose => {
Expand Down Expand Up @@ -1172,6 +1198,18 @@ impl<'de> serde::Deserialize<'de> for AnalyzeExecNode {
}
format__ = Some(map_.next_value::<super::datafusion_common::ExplainFormat>()? as i32);
}
GeneratedField::HasMetricTypes => {
if has_metric_types__.is_some() {
return Err(serde::de::Error::duplicate_field("hasMetricTypes"));
}
has_metric_types__ = Some(map_.next_value()?);
}
GeneratedField::MetricTypes => {
if metric_types__.is_some() {
return Err(serde::de::Error::duplicate_field("metricTypes"));
}
metric_types__ = Some(map_.next_value::<Vec<super::datafusion_common::MetricType>>()?.into_iter().map(|x| x as i32).collect());
}
}
}
Ok(AnalyzeExecNode {
Expand All @@ -1182,6 +1220,8 @@ impl<'de> serde::Deserialize<'de> for AnalyzeExecNode {
has_metric_categories: has_metric_categories__.unwrap_or_default(),
metric_categories: metric_categories__.unwrap_or_default(),
format: format__.unwrap_or_default(),
has_metric_types: has_metric_types__.unwrap_or_default(),
metric_types: metric_types__.unwrap_or_default(),
})
}
}
Expand Down
6 changes: 6 additions & 0 deletions datafusion/proto-models/src/generated/prost.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2119,6 +2119,12 @@ pub struct AnalyzeExecNode {
pub metric_categories: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
#[prost(enumeration = "super::datafusion_common::ExplainFormat", tag = "7")]
pub format: i32,
/// Whether metric_types is present. False means use SUMMARY and DEV.
#[prost(bool, tag = "8")]
pub has_metric_types: bool,
/// Types of metrics to display.
#[prost(enumeration = "super::datafusion_common::MetricType", repeated, tag = "9")]
pub metric_types: ::prost::alloc::vec::Vec<i32>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CrossJoinExecNode {
Expand Down
Loading