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

Provide better documentation for the various ways to run SQL and consume results #88

Open
jraymakers opened this issue Dec 29, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jraymakers
Copy link
Contributor

There are several options for running SQL and consuming results, with different tradeoffs:

  • Materializing versus streaming mode (i.e. stream vs run)
  • Manual versus automatic running of tasks (i.e. run or stream vs start or startStream)
  • Fetching chunks versus using the reader (i.e. fetchChunk versus the various read methods)
  • Value extraction versus conversion to arrays (i.e. DuckDBVector.getItem or DuckDBResultReader.valueversusgetRowsorgetColumns`)

What each of these choices mean, what the tradeoffs are, and how they are expressed in the API should be better documented. This likely involves both additional high-level documentation plus more class and method level documentation, both in doc comments and in some sort of API reference.

@jraymakers jraymakers added the documentation Improvements or additions to documentation label Dec 29, 2024
@jraymakers jraymakers self-assigned this Dec 29, 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
Projects
None yet
Development

No branches or pull requests

1 participant