Docs: Add Examples to Config Options page #17039
Merged
Conversation
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
github-actions
bot
added
documentation
alamb
commented
Aug 4, 2025
| /// | ||
| /// For example, setting `DATAFUSION_EXECUTION_BATCH_SIZE` will | ||
| /// control `datafusion.execution.batch_size`. | ||
| /// For example, to configure `datafusion.execution.batch_size` |
There was a problem hiding this comment.
This information was previously in the user guide but it feels like code level details so I moved it
|
|
||
| For applications which do not expose `SessionConfig`, like `datafusion-cli`, these options may also be set via environment variables. |
There was a problem hiding this comment.
this content is moved into ConfigOptions docs
|
https://github.com/apache/datafusion/actions/runs/16731686985/job/47361169534?pr=17039 is a CI / network error |
xudong963
approved these changes
Aug 5, 2025
|
Let's go |
hknlof
pushed a commit
to hknlof/datafusion
that referenced
this pull request
Aug 20, 2025
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.
Which issue does this PR close?
Rationale for this change
I again got nerd sniped on my way to adding a configuration tuning guide -- I found the intro text for configuration settings quite hard to understand and obscured some of the relevant detail
What changes are included in this PR?
Are these changes tested?
By CI
Are there any user-facing changes?