You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2026/08/06 13:37:49 UTC
(datafusion) 01/01: Proto: add DataSink serialization hook (#23752)
This is an automated email from the ASF dual-hosted git repository.
github-merge-queue[bot] pushed a commit to branch gh-readonly-queue/main/pr-23752-e6b4221a4f3ddc6424f63f5373a175cf1dfb91ca
in repository https://gitbox.apache.org/repos/asf/datafusion.git
commit 0e0cbd5daa5700fa0f74b1d400e4d52b960a182e
Author: Phoenix <Ph...@163.com>
AuthorDate: Thu Aug 6 21:37:27 2026 +0800
Proto: add DataSink serialization hook (#23752)
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes #123` indicates that this PR will close issue #123.
-->
- Closes #23498.
## Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
-->
`DataSinkExec` serialization currently depends on central downcasting in
`datafusion-proto`. This prevents individual `DataSink` implementations
from
owning their protobuf serialization logic.
Additionally, `FileSinkConfig` is owned by `datafusion-datasource`,
while its
protobuf conversion was implemented in `datafusion-proto`. Moving the
conversion alongside the type allows file sink implementations to reuse
it
without depending on the central proto crate.
This provides the foundation for migrating CSV, JSON, and Parquet sink
serialization in follow-up work.
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->
- Add a feature-gated `DataSink::try_to_proto` hook with a default
implementation returning `None`.
- Make `DataSinkExec::try_to_proto` encode its input and required
ordering
before delegating to the underlying sink.
- Retain the existing central serializer as a compatibility fallback for
sinks that have not implemented the hook.
- Move `FileSinkConfig` protobuf encoding and decoding into
`datafusion-datasource`.
- Keep the existing `TryFromProto` implementations as compatibility
delegates.
- Add a helper for decoding a sink's required output ordering.
- Preserve the existing protobuf wire representation.
## Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->
Yes.
- Added a custom `DataSink` test verifying that `DataSinkExec` delegates
serialization with the encoded input and required ordering.
- Added coverage verifying that the direct `FileSinkConfig` conversion
and
compatibility APIs produce the same protobuf data.
- Existing file sink round-trip tests continue to pass.
- Ran `cargo fmt --all`.
- Ran Clippy for all targets and features with warnings denied.
- Ran the required extended workspace test suite.
- Ran all 210 `datafusion-proto` integration tests.
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->
No. This is an internal serialization refactor. Existing protobuf data
and
the compatibility serialization path remain supported.
---------
Signed-off-by: Jiawei Zhao <Ph...@163.com>
---
datafusion/datasource/Cargo.toml | 10 +-
datafusion/datasource/src/file_sink_config.rs | 3 +
.../datasource/src/file_sink_config/proto.rs | 239 +++++++++++++++++++++
datafusion/datasource/src/sink.rs | 58 +++++
datafusion/proto/src/physical_plan/from_proto.rs | 51 +----
datafusion/proto/src/physical_plan/mod.rs | 28 +--
datafusion/proto/src/physical_plan/to_proto.rs | 43 +---
.../proto/tests/cases/roundtrip_physical_plan.rs | 148 ++++++++++++-
8 files changed, 461 insertions(+), 119 deletions(-)
diff --git a/datafusion/datasource/Cargo.toml b/datafusion/datasource/Cargo.toml
index 459ca436f3..b78ac616de 100644
--- a/datafusion/datasource/Cargo.toml
+++ b/datafusion/datasource/Cargo.toml
@@ -34,10 +34,12 @@ all-features = true
backtrace = ["datafusion-common/backtrace"]
compression = ["async-compression", "liblzma", "bzip2", "flate2", "zstd", "tokio-util"]
default = ["compression"]
-# Enables the protobuf conversions for the file-scan leaf types owned by this
-# crate (`FileRange`, `PartitionedFile`, `FileGroup`). Off by default so
-# consumers that never serialize plans pay nothing.
-proto = ["dep:datafusion-proto-models"]
+# Enables protobuf conversions for datasource types and serialization hooks.
+# Off by default so consumers that never serialize plans pay nothing.
+proto = [
+ "dep:datafusion-proto-models",
+ "datafusion-physical-plan/proto",
+]
[dependencies]
arrow = { workspace = true }
diff --git a/datafusion/datasource/src/file_sink_config.rs b/datafusion/datasource/src/file_sink_config.rs
index 1abce86a35..48dce9a0cd 100644
--- a/datafusion/datasource/src/file_sink_config.rs
+++ b/datafusion/datasource/src/file_sink_config.rs
@@ -32,6 +32,9 @@ use datafusion_expr::dml::InsertOp;
use async_trait::async_trait;
use object_store::ObjectStore;
+#[cfg(feature = "proto")]
+mod proto;
+
/// Determines how `FileSink` output paths are interpreted.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum FileOutputMode {
diff --git a/datafusion/datasource/src/file_sink_config/proto.rs b/datafusion/datasource/src/file_sink_config/proto.rs
new file mode 100644
index 0000000000..ed4b5c48bd
--- /dev/null
+++ b/datafusion/datasource/src/file_sink_config/proto.rs
@@ -0,0 +1,239 @@
+// 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.
+
+//! Protobuf conversion for the format-independent [`FileSinkConfig`].
+
+use std::sync::Arc;
+
+use datafusion_common::{DataFusionError, Result, internal_datafusion_err};
+use datafusion_execution::object_store::ObjectStoreUrl;
+use datafusion_expr::dml::InsertOp;
+use datafusion_proto_models::protobuf;
+
+use crate::ListingTableUrl;
+use crate::file_groups::FileGroup;
+use crate::file_sink_config::{FileOutputMode, FileSinkConfig};
+
+impl TryFrom<&FileSinkConfig> for protobuf::FileSinkConfig {
+ type Error = DataFusionError;
+
+ /// Serialize this shared file-sink configuration without format-specific
+ /// writer options.
+ fn try_from(config: &FileSinkConfig) -> Result<Self> {
+ let file_groups = config
+ .file_group
+ .iter()
+ .map(TryInto::try_into)
+ .collect::<Result<Vec<_>>>()?;
+ let table_paths = config
+ .table_paths
+ .iter()
+ .map(ToString::to_string)
+ .collect::<Vec<_>>();
+ let table_partition_cols = config
+ .table_partition_cols
+ .iter()
+ .map(|(name, data_type)| {
+ Ok(protobuf::PartitionColumn {
+ name: name.to_owned(),
+ arrow_type: Some(data_type.try_into()?),
+ })
+ })
+ .collect::<Result<Vec<_>>>()?;
+ let insert_op = match config.insert_op {
+ InsertOp::Append => protobuf::InsertOp::Append,
+ InsertOp::Overwrite => protobuf::InsertOp::Overwrite,
+ InsertOp::Replace => protobuf::InsertOp::Replace,
+ };
+ let file_output_mode = match config.file_output_mode {
+ FileOutputMode::Automatic => protobuf::FileOutputMode::Automatic,
+ FileOutputMode::SingleFile => protobuf::FileOutputMode::SingleFile,
+ FileOutputMode::Directory => protobuf::FileOutputMode::Directory,
+ };
+
+ Ok(protobuf::FileSinkConfig {
+ object_store_url: config.object_store_url.to_string(),
+ file_groups,
+ table_paths,
+ output_schema: Some(config.output_schema.as_ref().try_into()?),
+ table_partition_cols,
+ keep_partition_by_columns: config.keep_partition_by_columns,
+ insert_op: insert_op.into(),
+ file_extension: config.file_extension.clone(),
+ file_output_mode: file_output_mode.into(),
+ })
+ }
+}
+
+impl TryFrom<&protobuf::FileSinkConfig> for FileSinkConfig {
+ type Error = DataFusionError;
+
+ /// Reconstruct a shared file-sink configuration from protobuf.
+ fn try_from(conf: &protobuf::FileSinkConfig) -> Result<Self> {
+ let file_group = FileGroup::new(
+ conf.file_groups
+ .iter()
+ .map(TryInto::try_into)
+ .collect::<Result<Vec<_>>>()?,
+ );
+ let table_paths = conf
+ .table_paths
+ .iter()
+ .map(ListingTableUrl::parse)
+ .collect::<Result<Vec<_>>>()?;
+ let table_partition_cols = conf
+ .table_partition_cols
+ .iter()
+ .map(|protobuf::PartitionColumn { name, arrow_type }| {
+ let data_type = arrow_type
+ .as_ref()
+ .ok_or_else(|| {
+ internal_datafusion_err!(
+ "PartitionColumn is missing required field 'arrow_type'"
+ )
+ })?
+ .try_into()?;
+ Ok((name.clone(), data_type))
+ })
+ .collect::<Result<Vec<_>>>()?;
+ let insert_op = protobuf::InsertOp::try_from(conf.insert_op).map_err(|_| {
+ internal_datafusion_err!(
+ "Received a FileSinkConfig message with unknown InsertOp {}",
+ conf.insert_op
+ )
+ })?;
+ let insert_op = match insert_op {
+ protobuf::InsertOp::Append => InsertOp::Append,
+ protobuf::InsertOp::Overwrite => InsertOp::Overwrite,
+ protobuf::InsertOp::Replace => InsertOp::Replace,
+ };
+ let file_output_mode = protobuf::FileOutputMode::try_from(conf.file_output_mode)
+ .map_err(|_| {
+ internal_datafusion_err!(
+ "Received a FileSinkConfig message with unknown FileOutputMode {}",
+ conf.file_output_mode
+ )
+ })?;
+ let file_output_mode = match file_output_mode {
+ protobuf::FileOutputMode::Automatic => FileOutputMode::Automatic,
+ protobuf::FileOutputMode::SingleFile => FileOutputMode::SingleFile,
+ protobuf::FileOutputMode::Directory => FileOutputMode::Directory,
+ };
+ let output_schema = conf.output_schema.as_ref().ok_or_else(|| {
+ internal_datafusion_err!(
+ "FileSinkConfig is missing required field 'output_schema'"
+ )
+ })?;
+
+ Ok(Self {
+ original_url: String::default(),
+ object_store_url: ObjectStoreUrl::parse(&conf.object_store_url)?,
+ file_group,
+ table_paths,
+ output_schema: Arc::new(output_schema.try_into()?),
+ table_partition_cols,
+ insert_op,
+ keep_partition_by_columns: conf.keep_partition_by_columns,
+ file_extension: conf.file_extension.clone(),
+ file_output_mode,
+ })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use arrow::datatypes::Schema;
+
+ use super::*;
+
+ fn valid_file_sink_config() -> protobuf::FileSinkConfig {
+ protobuf::FileSinkConfig {
+ object_store_url: ObjectStoreUrl::local_filesystem().to_string(),
+ output_schema: Some(
+ (&Schema::empty())
+ .try_into()
+ .expect("empty schema should serialize"),
+ ),
+ insert_op: protobuf::InsertOp::Append.into(),
+ file_output_mode: protobuf::FileOutputMode::Automatic.into(),
+ ..Default::default()
+ }
+ }
+
+ fn assert_decode_error(
+ mutate: impl FnOnce(&mut protobuf::FileSinkConfig),
+ expected: impl AsRef<str>,
+ ) {
+ let mut conf = valid_file_sink_config();
+ mutate(&mut conf);
+
+ let error =
+ FileSinkConfig::try_from(&conf).expect_err("invalid config should fail");
+ match error {
+ DataFusionError::Internal(message) => {
+ let message = message
+ .split_once(DataFusionError::BACK_TRACE_SEP)
+ .map_or(message.as_str(), |(message, _)| message);
+ assert_eq!(message, expected.as_ref());
+ }
+ error => panic!("expected internal error, got {error}"),
+ }
+ }
+
+ #[test]
+ fn rejects_unknown_insert_op() {
+ assert_decode_error(
+ |conf| conf.insert_op = i32::MAX,
+ format!(
+ "Received a FileSinkConfig message with unknown InsertOp {}",
+ i32::MAX
+ ),
+ );
+ }
+
+ #[test]
+ fn rejects_unknown_file_output_mode() {
+ assert_decode_error(
+ |conf| conf.file_output_mode = i32::MAX,
+ format!(
+ "Received a FileSinkConfig message with unknown FileOutputMode {}",
+ i32::MAX
+ ),
+ );
+ }
+
+ #[test]
+ fn rejects_missing_output_schema() {
+ assert_decode_error(
+ |conf| conf.output_schema = None,
+ "FileSinkConfig is missing required field 'output_schema'",
+ );
+ }
+
+ #[test]
+ fn rejects_partition_column_without_arrow_type() {
+ assert_decode_error(
+ |conf| {
+ conf.table_partition_cols.push(protobuf::PartitionColumn {
+ name: "partition".to_string(),
+ arrow_type: None,
+ });
+ },
+ "PartitionColumn is missing required field 'arrow_type'",
+ );
+ }
+}
diff --git a/datafusion/datasource/src/sink.rs b/datafusion/datasource/src/sink.rs
index 18ebe80773..89a39c2ed4 100644
--- a/datafusion/datasource/src/sink.rs
+++ b/datafusion/datasource/src/sink.rs
@@ -71,6 +71,22 @@ pub trait DataSink: Any + DisplayAs + Debug + Send + Sync {
data: SendableRecordBatchStream,
context: &Arc<TaskContext>,
) -> Result<u64>;
+
+ /// Serialize this sink into a full protobuf plan node, if it knows how.
+ ///
+ /// Implementations can use `ctx` to encode the input plan, sink-specific
+ /// expressions, and [`DataSinkExec::encode_sort_order`].
+ ///
+ /// Returning `Ok(None)` preserves the legacy central serialization fallback
+ /// without eagerly encoding any child plans or expressions.
+ #[cfg(feature = "proto")]
+ fn try_to_proto(
+ &self,
+ _exec: &DataSinkExec,
+ _ctx: &datafusion_physical_plan::proto::ExecutionPlanEncodeCtx<'_>,
+ ) -> Result<Option<datafusion_proto_models::protobuf::PhysicalPlanNode>> {
+ Ok(None)
+ }
}
impl dyn DataSink {
@@ -145,6 +161,39 @@ impl DataSinkExec {
&self.sort_order
}
+ /// Encode the optional sink ordering for a protobuf plan node.
+ #[cfg(feature = "proto")]
+ pub fn encode_sort_order(
+ &self,
+ ctx: &datafusion_physical_plan::proto::ExecutionPlanEncodeCtx<'_>,
+ ) -> Result<Option<datafusion_proto_models::protobuf::PhysicalSortExprNodeCollection>>
+ {
+ use datafusion_physical_expr::PhysicalSortExpr;
+ use datafusion_proto_models::protobuf;
+
+ self.sort_order
+ .as_ref()
+ .map(|requirements| {
+ requirements
+ .iter()
+ .map(|requirement| {
+ let expr: PhysicalSortExpr = requirement.to_owned().into();
+ Ok(protobuf::PhysicalSortExprNode {
+ expr: Some(Box::new(ctx.encode_expr(&expr.expr)?)),
+ asc: !expr.options.descending,
+ nulls_first: expr.options.nulls_first,
+ })
+ })
+ .collect::<Result<Vec<_>>>()
+ .map(|physical_sort_expr_nodes| {
+ protobuf::PhysicalSortExprNodeCollection {
+ physical_sort_expr_nodes,
+ }
+ })
+ })
+ .transpose()
+ }
+
fn create_schema(
input: &Arc<dyn ExecutionPlan>,
schema: SchemaRef,
@@ -268,6 +317,15 @@ impl ExecutionPlan for DataSinkExec {
fn metrics(&self) -> Option<MetricsSet> {
self.sink.metrics()
}
+
+ /// Delegates protobuf serialization to the underlying sink.
+ #[cfg(feature = "proto")]
+ fn try_to_proto(
+ &self,
+ ctx: &datafusion_physical_plan::proto::ExecutionPlanEncodeCtx<'_>,
+ ) -> Result<Option<datafusion_proto_models::protobuf::PhysicalPlanNode>> {
+ self.sink().try_to_proto(self, ctx)
+ }
}
/// Create a output record batch with a count
diff --git a/datafusion/proto/src/physical_plan/from_proto.rs b/datafusion/proto/src/physical_plan/from_proto.rs
index 60647bd7aa..7c9b372348 100644
--- a/datafusion/proto/src/physical_plan/from_proto.rs
+++ b/datafusion/proto/src/physical_plan/from_proto.rs
@@ -28,7 +28,7 @@ use datafusion_datasource::file::FileSource;
use datafusion_datasource::file_groups::FileGroup;
use datafusion_datasource::file_scan_config::{FileScanConfig, FileScanConfigBuilder};
use datafusion_datasource::file_sink_config::FileSinkConfig;
-use datafusion_datasource::{FileRange, ListingTableUrl, PartitionedFile, TableSchema};
+use datafusion_datasource::{FileRange, PartitionedFile, TableSchema};
use datafusion_datasource_csv::file_format::CsvSink;
use datafusion_datasource_json::file_format::JsonSink;
#[cfg(feature = "parquet")]
@@ -36,7 +36,6 @@ use datafusion_datasource_parquet::file_format::ParquetSink;
use datafusion_execution::object_store::ObjectStoreUrl;
use datafusion_execution::{FunctionRegistry, TaskContext};
use datafusion_expr::WindowFunctionDefinition;
-use datafusion_expr::dml::InsertOp;
use datafusion_physical_expr::expressions::{LambdaExpr, LambdaVariable};
use datafusion_physical_expr::projection::{ProjectionExpr, ProjectionExprs};
use datafusion_physical_expr::scalar_subquery::ScalarSubqueryExpr;
@@ -621,53 +620,7 @@ impl TryFromProto<&protobuf::FileSinkConfig> for FileSinkConfig {
type Error = DataFusionError;
fn try_from_proto(conf: &protobuf::FileSinkConfig) -> Result<Self, Self::Error> {
- let file_group = FileGroup::new(
- conf.file_groups
- .iter()
- .map(TryInto::try_into)
- .collect::<Result<Vec<_>>>()?,
- );
- let table_paths = conf
- .table_paths
- .iter()
- .map(ListingTableUrl::parse)
- .collect::<Result<Vec<_>>>()?;
- let table_partition_cols = conf
- .table_partition_cols
- .iter()
- .map(|protobuf::PartitionColumn { name, arrow_type }| {
- let data_type = convert_required!(arrow_type)?;
- Ok((name.clone(), data_type))
- })
- .collect::<Result<Vec<_>>>()?;
- let insert_op = match conf.insert_op() {
- protobuf::InsertOp::Append => InsertOp::Append,
- protobuf::InsertOp::Overwrite => InsertOp::Overwrite,
- protobuf::InsertOp::Replace => InsertOp::Replace,
- };
- let file_output_mode = match conf.file_output_mode() {
- protobuf::FileOutputMode::Automatic => {
- datafusion_datasource::file_sink_config::FileOutputMode::Automatic
- }
- protobuf::FileOutputMode::SingleFile => {
- datafusion_datasource::file_sink_config::FileOutputMode::SingleFile
- }
- protobuf::FileOutputMode::Directory => {
- datafusion_datasource::file_sink_config::FileOutputMode::Directory
- }
- };
- Ok(Self {
- original_url: String::default(),
- object_store_url: ObjectStoreUrl::parse(&conf.object_store_url)?,
- file_group,
- table_paths,
- output_schema: Arc::new(convert_required!(conf.output_schema)?),
- table_partition_cols,
- insert_op,
- keep_partition_by_columns: conf.keep_partition_by_columns,
- file_extension: conf.file_extension.clone(),
- file_output_mode,
- })
+ conf.try_into()
}
}
diff --git a/datafusion/proto/src/physical_plan/mod.rs b/datafusion/proto/src/physical_plan/mod.rs
index c7d5bc9c4f..3524106ee1 100644
--- a/datafusion/proto/src/physical_plan/mod.rs
+++ b/datafusion/proto/src/physical_plan/mod.rs
@@ -70,7 +70,6 @@ use datafusion_physical_plan::coalesce_partitions::CoalescePartitionsExec;
use datafusion_physical_plan::coop::CooperativeExec;
use datafusion_physical_plan::empty::EmptyExec;
use datafusion_physical_plan::explain::ExplainExec;
-use datafusion_physical_plan::expressions::PhysicalSortExpr;
use datafusion_physical_plan::filter::FilterExec;
use datafusion_physical_plan::joins::{
CrossJoinExec, HashJoinExec, NestedLoopJoinExec, SortMergeJoinExec,
@@ -2580,29 +2579,12 @@ pub trait PhysicalPlanNodeExt: Sized {
codec,
proto_converter,
)?;
- let sort_order = match exec.sort_order() {
- Some(requirements) => {
- let expr = requirements
- .iter()
- .map(|requirement| {
- let expr: PhysicalSortExpr = requirement.to_owned().into();
- let sort_expr = protobuf::PhysicalSortExprNode {
- expr: Some(Box::new(
- proto_converter
- .physical_expr_to_proto(&expr.expr, codec)?,
- )),
- asc: !expr.options.descending,
- nulls_first: expr.options.nulls_first,
- };
- Ok(sort_expr)
- })
- .collect::<Result<Vec<_>>>()?;
- Some(protobuf::PhysicalSortExprNodeCollection {
- physical_sort_expr_nodes: expr,
- })
- }
- None => None,
+ let encoder = ConverterPlanEncoder {
+ codec,
+ proto_converter,
};
+ let encode_ctx = ExecutionPlanEncodeCtx::new(&encoder);
+ let sort_order = exec.encode_sort_order(&encode_ctx)?;
if let Some(sink) = exec.sink().downcast_ref::<JsonSink>() {
return Ok(Some(protobuf::PhysicalPlanNode {
diff --git a/datafusion/proto/src/physical_plan/to_proto.rs b/datafusion/proto/src/physical_plan/to_proto.rs
index bab7af2ab4..236ae654c3 100644
--- a/datafusion/proto/src/physical_plan/to_proto.rs
+++ b/datafusion/proto/src/physical_plan/to_proto.rs
@@ -552,47 +552,6 @@ impl TryFromProto<&FileSinkConfig> for protobuf::FileSinkConfig {
type Error = DataFusionError;
fn try_from_proto(conf: &FileSinkConfig) -> Result<Self, Self::Error> {
- let file_groups = conf
- .file_group
- .iter()
- .map(protobuf::PartitionedFile::try_from_proto)
- .collect::<Result<Vec<_>>>()?;
- let table_paths = conf
- .table_paths
- .iter()
- .map(ToString::to_string)
- .collect::<Vec<_>>();
- let table_partition_cols = conf
- .table_partition_cols
- .iter()
- .map(|(name, data_type)| {
- Ok(protobuf::PartitionColumn {
- name: name.to_owned(),
- arrow_type: Some(data_type.try_into()?),
- })
- })
- .collect::<Result<Vec<_>>>()?;
- let file_output_mode = match conf.file_output_mode {
- datafusion_datasource::file_sink_config::FileOutputMode::Automatic => {
- protobuf::FileOutputMode::Automatic
- }
- datafusion_datasource::file_sink_config::FileOutputMode::SingleFile => {
- protobuf::FileOutputMode::SingleFile
- }
- datafusion_datasource::file_sink_config::FileOutputMode::Directory => {
- protobuf::FileOutputMode::Directory
- }
- };
- Ok(Self {
- object_store_url: conf.object_store_url.to_string(),
- file_groups,
- table_paths,
- output_schema: Some(conf.output_schema.as_ref().try_into()?),
- table_partition_cols,
- keep_partition_by_columns: conf.keep_partition_by_columns,
- insert_op: conf.insert_op as i32,
- file_extension: conf.file_extension.to_string(),
- file_output_mode: file_output_mode.into(),
- })
+ conf.try_into()
}
}
diff --git a/datafusion/proto/tests/cases/roundtrip_physical_plan.rs b/datafusion/proto/tests/cases/roundtrip_physical_plan.rs
index cbc50a96e9..e7bcffea13 100644
--- a/datafusion/proto/tests/cases/roundtrip_physical_plan.rs
+++ b/datafusion/proto/tests/cases/roundtrip_physical_plan.rs
@@ -23,6 +23,7 @@ use std::vec;
use arrow::array::RecordBatch;
use arrow::csv::WriterBuilder;
use arrow::datatypes::{Fields, TimeUnit};
+use async_trait::async_trait;
use datafusion::arrow::array::ArrayRef;
use datafusion::arrow::compute::kernels::sort::SortOptions;
use datafusion::arrow::datatypes::{DataType, Field, IntervalUnit, Schema, SchemaRef};
@@ -39,7 +40,7 @@ use datafusion::datasource::physical_plan::{
FileSinkConfig, ParquetSource, wrap_partition_type_in_dict,
wrap_partition_value_in_dict,
};
-use datafusion::datasource::sink::DataSinkExec;
+use datafusion::datasource::sink::{DataSink, DataSinkExec};
use datafusion::datasource::source::DataSourceExec;
use datafusion::execution::TaskContext;
use datafusion::functions_aggregate::count::count_udaf;
@@ -81,6 +82,7 @@ use datafusion::physical_plan::limit::{GlobalLimitExec, LocalLimitExec};
use datafusion::physical_plan::metrics::MetricCategory;
use datafusion::physical_plan::placeholder_row::PlaceholderRowExec;
use datafusion::physical_plan::projection::{ProjectionExec, ProjectionExpr};
+use datafusion::physical_plan::proto::ExecutionPlanEncodeCtx;
use datafusion::physical_plan::repartition::RepartitionExec;
use datafusion::physical_plan::scalar_subquery::{
ScalarSubqueryExec, ScalarSubqueryLink,
@@ -2054,6 +2056,150 @@ fn roundtrip_explain() -> Result<()> {
Ok(())
}
+#[derive(Debug)]
+struct ProtoHookSink {
+ schema: SchemaRef,
+}
+
+impl DisplayAs for ProtoHookSink {
+ fn fmt_as(&self, _t: DisplayFormatType, f: &mut Formatter) -> std::fmt::Result {
+ write!(f, "ProtoHookSink")
+ }
+}
+
+#[async_trait]
+impl DataSink for ProtoHookSink {
+ fn schema(&self) -> &SchemaRef {
+ &self.schema
+ }
+
+ async fn write_all(
+ &self,
+ _data: SendableRecordBatchStream,
+ _context: &Arc<TaskContext>,
+ ) -> Result<u64> {
+ unreachable!("serialization test does not execute the sink")
+ }
+
+ fn try_to_proto(
+ &self,
+ exec: &DataSinkExec,
+ ctx: &ExecutionPlanEncodeCtx<'_>,
+ ) -> Result<Option<PhysicalPlanNode>> {
+ let input = ctx.encode_child(exec.input())?;
+ let sort_order = exec.encode_sort_order(ctx)?;
+ assert!(matches!(
+ input.physical_plan_type,
+ Some(protobuf::physical_plan_node::PhysicalPlanType::PlaceholderRow(_))
+ ));
+ assert_eq!(
+ sort_order
+ .as_ref()
+ .map(|ordering| ordering.physical_sort_expr_nodes.len()),
+ Some(1)
+ );
+ assert_eq!(exec.schema().fields().len(), 1);
+
+ Ok(Some(PhysicalPlanNode {
+ physical_plan_type: Some(
+ protobuf::physical_plan_node::PhysicalPlanType::Empty(
+ protobuf::EmptyExecNode {
+ schema: Some(exec.schema().as_ref().try_into()?),
+ partitions: 1,
+ },
+ ),
+ ),
+ }))
+ }
+}
+
+#[test]
+fn data_sink_exec_delegates_to_sink_proto_hook() -> Result<()> {
+ let input_schema = Arc::new(Schema::new(vec![Field::new(
+ "value",
+ DataType::Int64,
+ false,
+ )]));
+ let input = Arc::new(PlaceholderRowExec::new(Arc::clone(&input_schema)));
+ let sink = Arc::new(ProtoHookSink {
+ schema: Arc::clone(&input_schema),
+ });
+ let sort_order = [PhysicalSortRequirement::new(
+ Arc::new(Column::new("value", 0)),
+ Some(SortOptions::default()),
+ )]
+ .into();
+ let plan = Arc::new(DataSinkExec::new(input, sink, Some(sort_order)));
+
+ let node = PhysicalPlanNode::try_from_physical_plan(
+ plan,
+ &DefaultPhysicalExtensionCodec {},
+ )?;
+
+ assert!(matches!(
+ node.physical_plan_type,
+ Some(protobuf::physical_plan_node::PhysicalPlanType::Empty(_))
+ ));
+ Ok(())
+}
+
+#[test]
+fn file_sink_config_roundtrip_preserves_fields() -> Result<()> {
+ let schema = Arc::new(Schema::new(vec![Field::new(
+ "partition",
+ DataType::Utf8,
+ false,
+ )]));
+ let config = FileSinkConfig {
+ original_url: "file:///tmp/output".to_string(),
+ object_store_url: ObjectStoreUrl::local_filesystem(),
+ file_group: FileGroup::new(vec![PartitionedFile::new("/tmp/output", 1)]),
+ table_paths: vec![ListingTableUrl::parse("file:///tmp/output")?],
+ output_schema: schema,
+ table_partition_cols: vec![("partition".to_string(), DataType::Utf8)],
+ insert_op: InsertOp::Overwrite,
+ keep_partition_by_columns: true,
+ file_extension: "parquet".to_string(),
+ file_output_mode: FileOutputMode::Directory,
+ };
+
+ let encoded = protobuf::FileSinkConfig::try_from(&config)?;
+ assert_eq!(encoded.insert_op(), protobuf::InsertOp::Overwrite);
+ assert_eq!(
+ encoded.file_output_mode(),
+ protobuf::FileOutputMode::Directory
+ );
+
+ let decoded = FileSinkConfig::try_from(&encoded)?;
+ assert_eq!(decoded.object_store_url, config.object_store_url);
+ assert_eq!(decoded.table_paths, config.table_paths);
+ assert_eq!(
+ decoded.output_schema.as_ref(),
+ config.output_schema.as_ref()
+ );
+ assert_eq!(decoded.table_partition_cols, config.table_partition_cols);
+ assert_eq!(decoded.insert_op, config.insert_op);
+ assert_eq!(
+ decoded.keep_partition_by_columns,
+ config.keep_partition_by_columns
+ );
+ assert_eq!(decoded.file_extension, config.file_extension);
+ assert_eq!(decoded.file_output_mode, config.file_output_mode);
+
+ let [decoded_file] = decoded.file_group.files() else {
+ panic!("expected one decoded output file");
+ };
+ let [config_file] = config.file_group.files() else {
+ panic!("expected one configured output file");
+ };
+ assert_eq!(
+ decoded_file.object_meta.location,
+ config_file.object_meta.location
+ );
+ assert_eq!(decoded_file.object_meta.size, config_file.object_meta.size);
+ Ok(())
+}
+
#[tokio::test]
async fn roundtrip_json_source() -> Result<()> {
let ctx = SessionContext::new();
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org