Skip to content
New issue

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

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

Already on GitHub? # to your account

Library Guide: Add SQL level user guide: #7302

Open
alamb opened this issue Aug 16, 2023 · 0 comments
Open

Library Guide: Add SQL level user guide: #7302

alamb opened this issue Aug 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@alamb
Copy link
Contributor

alamb commented Aug 16, 2023

Is your feature request related to a problem or challenge?

Part of #7014

If we want to have DataFusion used as the core of many new systems, we need it to be as easy as possible for someone to get their idea working on top of DataFusion.

Thanks to @tshauck we now have a basic Library Users Guide ❤️ and this ticket describes expanding it out

Describe the solution you'd like

Fill in the content of https://arrow.apache.org/datafusion/library-user-guide/using-the-sql-api.html

Example outline

  1. Generating LogicalPlans from sql
  2. Example / guide of how to extend SQL (both links to user defined functions and custom nodes, but also maybe some links to the datafusion sql variant parser
  3. Example of how to run SQL read only and how to run it with catalog modifications (Misleading/invalid documentation on SessionContext::sql and SessionConfig::create_logical_plan #7272)

The examples directory holds a bunch of examples: https://github.com/apache/arrow-datafusion/tree/main/datafusion-examples

Describe alternatives you've considered

No response

Additional context

No response

@alamb alamb added enhancement New feature or request documentation Improvements or additions to documentation devrel labels Aug 16, 2023
@andygrove andygrove self-assigned this Oct 26, 2023
@andygrove andygrove removed their assignment May 23, 2024
@alamb alamb removed the devrel label Oct 21, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants