This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new c7b339e0b0 Consolidate proto examples (#18142) (#18861)
c7b339e0b0 is described below
commit c7b339e0b016ace1d3c337f756eb684ce4bc57b5
Author: Sergey Zhukov <[email protected]>
AuthorDate: Fri Nov 21 23:31:07 2025 +0300
Consolidate proto examples (#18142) (#18861)
## 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.
-->
- part of #https://github.com/apache/datafusion/issues/18142.
## Rationale for this change
This PR is for consolidating all the `proto` examples
(composed_extension_codec) into a single example binary. We are agreed
on the pattern and we can apply it to the remaining examples
<!--
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.
-->
## 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.
-->
## 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)?
-->
## 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.
-->
Co-authored-by: Sergey Zhukov <[email protected]>
---
datafusion-examples/README.md | 2 +-
.../{ => proto}/composed_extension_codec.rs | 16 ++--
datafusion-examples/examples/proto/main.rs | 89 ++++++++++++++++++++++
3 files changed, 99 insertions(+), 8 deletions(-)
diff --git a/datafusion-examples/README.md b/datafusion-examples/README.md
index 5453480165..03c382b7cf 100644
--- a/datafusion-examples/README.md
+++ b/datafusion-examples/README.md
@@ -54,7 +54,7 @@ cargo run --example dataframe
-
[`examples/query_planning/analyzer_rule.rs`](examples/query_planning/analyzer_rule.rs):
Use a custom AnalyzerRule to change a query's semantics (row level access
control)
- [`examples/data_io/catalog.rs`](examples/data_io/catalog.rs): Register the
table into a custom catalog
- [`examples/data_io/json_shredding.rs`](examples/data_io/json_shredding.rs):
Shows how to implement custom filter rewriting for JSON shredding
-- [`composed_extension_codec`](examples/composed_extension_codec.rs): Example
of using multiple extension codecs for serialization / deserialization
+-
[`examples/proto/composed_extension_codec`](examples/proto/composed_extension_codec.rs):
Example of using multiple extension codecs for serialization / deserialization
-
[`examples/custom_data_source/csv_sql_streaming.rs`](examples/custom_data_source/csv_sql_streaming.rs):
Build and run a streaming query plan from a SQL statement against a local CSV
file
-
[`examples/custom_data_source/csv_json_opener.rs`](examples/custom_data_source/csv_json_opener.rs):
Use low level `FileOpener` APIs to read CSV/JSON into Arrow `RecordBatch`es
-
[`examples/custom_data_source/custom_datasource.rs`](examples/custom_data_source/custom_datasource.rs):
Run queries against a custom datasource (TableProvider)
diff --git a/datafusion-examples/examples/composed_extension_codec.rs
b/datafusion-examples/examples/proto/composed_extension_codec.rs
similarity index 95%
rename from datafusion-examples/examples/composed_extension_codec.rs
rename to datafusion-examples/examples/proto/composed_extension_codec.rs
index 57f2c37041..043f548b3b 100644
--- a/datafusion-examples/examples/composed_extension_codec.rs
+++ b/datafusion-examples/examples/proto/composed_extension_codec.rs
@@ -15,6 +15,8 @@
// specific language governing permissions and limitations
// under the License.
+//! See `main.rs` for how to run it.
+//!
//! This example demonstrates how to compose multiple PhysicalExtensionCodecs
//!
//! This can be helpful when an Execution plan tree has different nodes from
different crates
@@ -44,8 +46,8 @@ use datafusion_proto::physical_plan::{
};
use datafusion_proto::protobuf;
-#[tokio::main]
-async fn main() {
+/// Example of using multiple extension codecs for serialization /
deserialization
+pub async fn composed_extension_codec() -> Result<()> {
// build execution plan that has both types of nodes
//
// Note each node requires a different `PhysicalExtensionCodec` to decode
@@ -66,16 +68,16 @@ async fn main() {
protobuf::PhysicalPlanNode::try_from_physical_plan(
exec_plan.clone(),
&composed_codec,
- )
- .expect("to proto");
+ )?;
// deserialize proto back to execution plan
- let result_exec_plan: Arc<dyn ExecutionPlan> = proto
- .try_into_physical_plan(&ctx.task_ctx(), &composed_codec)
- .expect("from proto");
+ let result_exec_plan: Arc<dyn ExecutionPlan> =
+ proto.try_into_physical_plan(&ctx.task_ctx(), &composed_codec)?;
// assert that the original and deserialized execution plans are equal
assert_eq!(format!("{exec_plan:?}"), format!("{result_exec_plan:?}"));
+
+ Ok(())
}
/// This example has two types of nodes: `ParentExec` and `ChildExec` which
can only
diff --git a/datafusion-examples/examples/proto/main.rs
b/datafusion-examples/examples/proto/main.rs
new file mode 100644
index 0000000000..e15ba329a4
--- /dev/null
+++ b/datafusion-examples/examples/proto/main.rs
@@ -0,0 +1,89 @@
+// 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.
+
+//! # Examples demonstrating DataFusion's plan serialization via the
`datafusion-proto` crate
+//!
+//! These examples show how to use multiple extension codecs for serialization
/ deserialization.
+//!
+//! ## Usage
+//! ```bash
+//! cargo run --example proto -- [composed_extension_codec]
+//! ```
+//!
+//! Each subcommand runs a corresponding example:
+//! - `composed_extension_codec` — example of using multiple extension codecs
for serialization / deserialization
+
+mod composed_extension_codec;
+
+use std::str::FromStr;
+
+use datafusion::error::{DataFusionError, Result};
+
+enum ExampleKind {
+ ComposedExtensionCodec,
+}
+
+impl AsRef<str> for ExampleKind {
+ fn as_ref(&self) -> &str {
+ match self {
+ Self::ComposedExtensionCodec => "composed_extension_codec",
+ }
+ }
+}
+
+impl FromStr for ExampleKind {
+ type Err = DataFusionError;
+
+ fn from_str(s: &str) -> Result<Self> {
+ match s {
+ "composed_extension_codec" => Ok(Self::ComposedExtensionCodec),
+ _ => Err(DataFusionError::Execution(format!("Unknown example:
{s}"))),
+ }
+ }
+}
+
+impl ExampleKind {
+ const ALL: [Self; 1] = [Self::ComposedExtensionCodec];
+
+ const EXAMPLE_NAME: &str = "proto";
+
+ fn variants() -> Vec<&'static str> {
+ Self::ALL.iter().map(|x| x.as_ref()).collect()
+ }
+}
+
+#[tokio::main]
+async fn main() -> Result<()> {
+ let usage = format!(
+ "Usage: cargo run --example {} -- [{}]",
+ ExampleKind::EXAMPLE_NAME,
+ ExampleKind::variants().join("|")
+ );
+
+ let arg = std::env::args().nth(1).ok_or_else(|| {
+ eprintln!("{usage}");
+ DataFusionError::Execution("Missing argument".to_string())
+ })?;
+
+ match arg.parse::<ExampleKind>()? {
+ ExampleKind::ComposedExtensionCodec => {
+ composed_extension_codec::composed_extension_codec().await?
+ }
+ }
+
+ Ok(())
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
