Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document usage of SessionConfig #8770

Closed
wjones127 opened this issue Jan 6, 2024 · 0 comments · Fixed by #8771
Closed

Document usage of SessionConfig #8770

wjones127 opened this issue Jan 6, 2024 · 0 comments · Fixed by #8771
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@wjones127
Copy link
Member

Is your feature request related to a problem or challenge?

When I was trying to configure DataFusion, I encountered two roadblocks while reading the documentation:

  1. Once I've found a config option I want to set in one of the structs (in my case ParquetOptions.pushdown_filters), I couldn't figure out what method I should pass the configuration to.
  2. Once I realized I need to set it in SessionConfig, I couldn't figure out how I was supposed to access it. I needed to look into the source code to figure out that if I wanted to use SessionConfig.set() I needed to use the prefix datafusion.execution.parquet.

Describe the solution you'd like

The first issue could be fixed by linking back to SessionConfig from each of the *Options structs, so users know where to set these.

The second issue could be addressed by providing a few examples.

Describe alternatives you've considered

No response

Additional context

No response

@wjones127 wjones127 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 6, 2024
@wjones127 wjones127 self-assigned this Jan 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant