Apache DataFusion SQL Query Engine
docs: update proto-models README for the datafusion-common dependency (#24279)
Adrian Garcia Badaracco773ef226c681
diff --git a/datafusion/proto-models/README.md b/datafusion/proto-models/README.mdindex 34adae9c1a..6b3b4ba9a2 100644--- a/datafusion/proto-models/README.md+++ b/datafusion/proto-models/README.md@@ -22,9 +22,17 @@[Apache DataFusion] is an extensible query execution framework, written in Rust, that uses [Apache Arrow] as its in-memory format.This crate contains the [prost]-generated Rust types for DataFusion's logical-and physical plan protobuf schemas. It is intentionally kept narrow: it has no-DataFusion dependencies beyond [`datafusion-proto-common`] and exposes only the-generated structs (and optional [pbjson]/[serde] support).+and physical plan protobuf schemas, plus the `From` / `TryFrom` conversions+between those types and the [`datafusion-common`] types they mirror. The+conversions live here because their DataFusion side sits _below_ this crate in+the dependency graph and so cannot host the impls itself — the same arrangement+[`datafusion-proto-common`] uses for [`ScalarValue`] and [`Statistics`].++It is otherwise intentionally kept narrow: its only DataFusion dependencies are+[`datafusion-common`] and [`datafusion-proto-common`], and apart from those+conversions it exposes only the generated structs (and optional+[pbjson]/[serde] support). In particular it does not depend on+`datafusion-expr` or on any of the execution crates.This crate is consumed by [`datafusion-proto`] and may also be depended ondirectly by other DataFusion crates that need to refer to the proto schema@@ -39,5 +47,8 @@ crate, there is no reason to use this crate directly in your project as well.[prost]: https://docs.rs/prost/latest/prost/[pbjson]: https://docs.rs/pbjson/latest/pbjson/[serde]: https://serde.rs/+[`datafusion-common`]: https://crates.io/crates/datafusion-common[`datafusion-proto`]: https://crates.io/crates/datafusion-proto[`datafusion-proto-common`]: https://crates.io/crates/datafusion-proto-common+[`scalarvalue`]: https://docs.rs/datafusion-common/latest/datafusion_common/scalar/enum.ScalarValue.html+[`statistics`]: https://docs.rs/datafusion-common/latest/datafusion_common/stats/struct.Statistics.html