docs: introduce the DataFrame API in the README - #243
Merged
nielspardon merged 1 commit intoJul 29, 2026
Conversation
Add a "Building plans with the DataFrame API" section leading with the ergonomic `substrait.dataframe` API, and reframe the existing raw `substrait.proto`/`substrait.builders` examples as the low-level API. Extracted from substrait-io#214 so it can land while the full user guide is finalized; the guide-link paragraph is intentionally omitted until those docs exist.
andrew-coleman
approved these changes
Jul 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a Building plans with the DataFrame API section to the README, leading
with the ergonomic
substrait.dataframeAPI (introduced in #204), and reframesthe existing raw
substrait.proto/substrait.buildersexamples as thelow-level API.
Previously the README led straight into verbose raw-
protoplan construction,with no mention of the DataFrame API that already ships on
main.Why a separate PR
These README changes are extracted from the user guide PR (#214) so they can
land independently while that larger guide is being finalized. Everything here
is self-contained against
main:end to end (it produces a
substrait.proto.Plan).extensionsextra referenced for function resolution exists inpyproject.toml.The guide-link paragraph from #214 (pointing at
docs/index.mdandpixi run docs-serve) is intentionally omitted here, since those docs andtasks only exist in #214 — including it now would leave a broken link on
main.#214 re-adds that pointer when the guide lands.
Verification
Ran the new README example against the current API:
🤖 Generated with AI