Skip to content

Commit e0c182d

Browse files
adriangbclaude
andcommitted
Extract datafusion-proto-models crate
Mirror the existing datafusion-proto-common split for the physical/logical plan schemas. The new crate contains only the .proto file and the prost- generated Rust types, with no datafusion deps beyond datafusion-proto-common. datafusion-proto re-exports the proto types via its existing protobuf module, so downstream consumers (datafusion-ffi, datafusion-examples, benchmarks) continue to work without Cargo.toml changes. Because the prost-generated types are now foreign to datafusion-proto, the orphan rule forbids: - inherent impl blocks on protobuf::PhysicalPlanNode - From/TryFrom impls between proto types and types from datafusion-common, datafusion-expr, datafusion-datasource (foreign + foreign) To work around this: - Inherent impls on protobuf::PhysicalPlanNode are converted to a new PhysicalPlanNodeExt trait (callers must `use` it to call the methods). - Foreign-foreign From/TryFrom impls are converted to FromProto/TryFromProto traits defined in a new datafusion_proto::convert module. This is groundwork for a follow-up that adds PhysicalExpr::to_proto so expressions can serialize private state without exposing pub-for-proto scaffolding (issue apache#21835). Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
1 parent b17847d commit e0c182d

31 files changed

Lines changed: 823 additions & 270 deletions

‎Cargo.lock‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,10 @@ members = [
4747
"datafusion/pruning",
4848
"datafusion/physical-plan",
4949
"datafusion/proto",
50-
"datafusion/proto/gen",
5150
"datafusion/proto-common",
5251
"datafusion/proto-common/gen",
52+
"datafusion/proto-models",
53+
"datafusion/proto-models/gen",
5354
"datafusion/session",
5455
"datafusion/spark",
5556
"datafusion/sql",
@@ -152,6 +153,7 @@ datafusion-physical-optimizer = { path = "datafusion/physical-optimizer", versio
152153
datafusion-physical-plan = { path = "datafusion/physical-plan", version = "53.1.0" }
153154
datafusion-proto = { path = "datafusion/proto", version = "53.1.0" }
154155
datafusion-proto-common = { path = "datafusion/proto-common", version = "53.1.0" }
156+
datafusion-proto-models = { path = "datafusion/proto-models", version = "53.1.0" }
155157
datafusion-pruning = { path = "datafusion/pruning", version = "53.1.0" }
156158
datafusion-session = { path = "datafusion/session", version = "53.1.0" }
157159
datafusion-spark = { path = "datafusion/spark", version = "53.1.0" }

‎datafusion-examples/examples/custom_data_source/adapter_serialization.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ use datafusion_proto::bytes::{
6262
use datafusion_proto::physical_plan::from_proto::parse_physical_expr_with_converter;
6363
use datafusion_proto::physical_plan::to_proto::serialize_physical_expr_with_converter;
6464
use datafusion_proto::physical_plan::{
65-
PhysicalExtensionCodec, PhysicalPlanDecodeContext, PhysicalProtoConverterExtension,
65+
PhysicalExtensionCodec, PhysicalPlanDecodeContext, PhysicalPlanNodeExt,
66+
PhysicalProtoConverterExtension,
6667
};
6768
use datafusion_proto::protobuf::physical_plan_node::PhysicalPlanType;
6869
use datafusion_proto::protobuf::{

‎datafusion-examples/examples/proto/expression_deduplication.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ use datafusion_proto::physical_plan::from_proto::parse_physical_expr_with_conver
5252
use datafusion_proto::physical_plan::to_proto::serialize_physical_expr_with_converter;
5353
use datafusion_proto::physical_plan::{
5454
DefaultPhysicalExtensionCodec, PhysicalExtensionCodec, PhysicalPlanDecodeContext,
55-
PhysicalProtoConverterExtension,
55+
PhysicalPlanNodeExt, PhysicalProtoConverterExtension,
5656
};
5757
use datafusion_proto::protobuf::{PhysicalExprNode, PhysicalPlanNode};
5858
use prost::Message;

‎datafusion/proto-models/Cargo.toml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
[package]
19+
name = "datafusion-proto-models"
20+
description = "Protobuf-generated model types for DataFusion logical and physical plans"
21+
keywords = ["arrow", "query", "sql"]
22+
readme = "README.md"
23+
version = { workspace = true }
24+
edition = { workspace = true }
25+
homepage = { workspace = true }
26+
repository = { workspace = true }
27+
license = { workspace = true }
28+
authors = { workspace = true }
29+
rust-version = { workspace = true }
30+
31+
[package.metadata.docs.rs]
32+
all-features = true
33+
34+
[lib]
35+
name = "datafusion_proto_models"
36+
37+
[features]
38+
default = []
39+
json = ["serde", "serde_json", "pbjson", "datafusion-proto-common/json"]
40+
41+
[dependencies]
42+
datafusion-proto-common = { workspace = true }
43+
pbjson = { workspace = true, optional = true }
44+
prost = { workspace = true }
45+
serde = { version = "1.0", optional = true }
46+
serde_json = { workspace = true, optional = true }
Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
203+
204+
205+
This project includes code from Apache Aurora.
206+
207+
* dev/release/{release,changelog,release-candidate} are based on the scripts from
208+
Apache Aurora
209+
210+
Copyright: 2016 The Apache Software Foundation.
211+
Home page: https://aurora.apache.org/
212+
License: http://www.apache.org/licenses/LICENSE-2.0

‎datafusion/proto-models/NOTICE.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Apache DataFusion
2+
Copyright 2019-2026 The Apache Software Foundation
3+
4+
This product includes software developed at
5+
The Apache Software Foundation (http://www.apache.org/).

‎datafusion/proto-models/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!---
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Apache DataFusion Protobuf Models
21+
22+
[Apache DataFusion] is an extensible query execution framework, written in Rust, that uses [Apache Arrow] as its in-memory format.
23+
24+
This crate contains the [prost]-generated Rust types for DataFusion's logical
25+
and physical plan protobuf schemas. It is intentionally kept narrow: it has no
26+
DataFusion dependencies beyond [`datafusion-proto-common`] and exposes only the
27+
generated structs (and optional [pbjson]/[serde] support).
28+
29+
This crate is consumed by [`datafusion-proto`] and may also be depended on
30+
directly by other DataFusion crates that need to refer to the proto schema
31+
types without pulling in the full [`datafusion-proto`] surface.
32+
33+
Most projects should use the [`datafusion-proto`] crate directly, which
34+
re-exports this module. If you are already using the [`datafusion-proto`]
35+
crate, there is no reason to use this crate directly in your project as well.
36+
37+
[apache arrow]: https://arrow.apache.org/
38+
[apache datafusion]: https://datafusion.apache.org/
39+
[prost]: https://docs.rs/prost/latest/prost/
40+
[pbjson]: https://docs.rs/pbjson/latest/pbjson/
41+
[serde]: https://serde.rs/
42+
[`datafusion-proto`]: https://crates.io/crates/datafusion-proto
43+
[`datafusion-proto-common`]: https://crates.io/crates/datafusion-proto-common
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
use std::path::Path;
1919

2020
fn main() -> Result<(), String> {
21-
let proto_dir = Path::new("datafusion/proto");
22-
let proto_path = Path::new("datafusion/proto/proto/datafusion.proto");
23-
let out_dir = Path::new("datafusion/proto/src");
21+
let proto_dir = Path::new("datafusion/proto-models");
22+
let proto_path = Path::new("datafusion/proto-models/proto/datafusion.proto");
23+
let out_dir = Path::new("datafusion/proto-models/src");
2424

2525
// proto definitions has to be there
2626
let descriptor_path = proto_dir.join("proto/proto_descriptor.bin");

0 commit comments

Comments
 (0)