This is an automated email from the ASF dual-hosted git repository.
milenkovicm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-ballista.git
The following commit(s) were added to refs/heads/main by this push:
new 2b514813d doc: add more details for protobuf extension (#1393)
2b514813d is described below
commit 2b514813db9fe8eb780aa043d72b65d5a1963571
Author: Louis Burke <[email protected]>
AuthorDate: Wed Jan 21 19:15:21 2026 +0000
doc: add more details for protobuf extension (#1393)
* Rewords the introduction.
* Rewords the cargo install section.
* Rewords the docker section and updates builder Dockerfile.
* Rewords the docker compose, kubernetes, and scheduler sections.
* Rewords the docker compose, kubernetes, and scheduler sections.
* Adds a link to the docker section for the docker compose section.
* Adds a full stop
* Adds full stop
* Prettifies the docs.
* Rolls back change to builder Dockerfile.
* Cleans up sphinx warnings and adds protocol buffer definition instead of
link
* Pretty the extention example file
* Prettie the extention example file and addresses comments
* add additional comment
* fix add additional comment
* fix add additional comment
---------
Co-authored-by: Marko Milenković <[email protected]>
---
docs/source/contributors-guide/development.md | 2 +-
docs/source/index.rst | 1 -
docs/source/user-guide/extensions-example.md | 47 +++++++++++++++++++++++++++
3 files changed, 48 insertions(+), 2 deletions(-)
diff --git a/docs/source/contributors-guide/development.md
b/docs/source/contributors-guide/development.md
index feefc8a68..27b358509 100644
--- a/docs/source/contributors-guide/development.md
+++ b/docs/source/contributors-guide/development.md
@@ -68,7 +68,7 @@ cargo run --example standalone_sql
--features=ballista/standalone
## Benchmarking
-For performance testing and benchmarking with TPC-H and other datasets, see
the [benchmarks README](../../../benchmarks/README.md).
+For performance testing and benchmarking with TPC-H and other datasets, see
the [benchmarks
README](https://github.com/apache/datafusion-ballista/blob/main/benchmarks/README.md).
This includes instructions for:
diff --git a/docs/source/index.rst b/docs/source/index.rst
index d4c607500..625496198 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -44,7 +44,6 @@ Table of content
Python <user-guide/python>
Rust <user-guide/rust>
- Flight SQL JDBC <user-guide/flightsql>
SQL CLI <user-guide/cli>
.. toctree::
diff --git a/docs/source/user-guide/extensions-example.md
b/docs/source/user-guide/extensions-example.md
index b7c94d9ed..4d41da323 100644
--- a/docs/source/user-guide/extensions-example.md
+++ b/docs/source/user-guide/extensions-example.md
@@ -214,16 +214,63 @@ scheduler.
The logical extension codec typically consists of two components: Google
Protocol Buffer definitions:
```proto
+syntax = "proto3";
+
+package extension.ballista;
+
+// used in building the codecs and compiled to Rust at build time.
+import "datafusion_common.proto";
+//
+// message naming convention
+//
+// prefix L means logical
+// prefix P means physical
+//
+
+
+//
+// Logical Plan Extensions
+//
+
+
+// this is the root message that captures all possible
+// logical plan messages which can be sent across
message LMessage {
oneof Extension {
LSample sample = 1;
}
}
+
message LSample {
float fraction = 1;
optional int64 seed = 2;
}
+
+//
+// Physical Plan Extensions
+//
+
+
+message PMessage {
+ oneof Extension {
+ // opaque message means that extension codec does not handle
+ // those values hence encoding/decoding is delegated to some other
codec
+ // (in this case default datafusion codec).
+ bytes opaque = 1;
+ PSample sample = 2;
+
+ }
+}
+
+message PSample {
+ float fraction = 1;
+ optional int64 seed = 2;
+}
+```
+
+```
+
```
`LogicalExtensionCodec` extends `BallistaLogicalExtensionCodec` handling newly
defined operator messages:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
