Clarify documentation for read only queries #7327
Closed
+93
−11
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
alamb
commented
Aug 18, 2023
| /// let df = df.filter(col("a").lt_eq(col("b")))? | ||
| /// .aggregate(vec![col("a")], vec![min(col("b"))])? | ||
| /// .limit(0, Some(100))?; | ||
| /// let results = df.collect(); |
Contributor
Author
There was a problem hiding this comment.
since the results were not used it turns out the example was missing an await
| /// | ||
| /// If this is not desirable, consider using [`SessionState::create_logical_plan()`] which | ||
| /// does not mutate the state based on such statements. | ||
| /// For read only SQL, use [`SessionState::create_logical_plan()`] to create a |
Contributor
Author
There was a problem hiding this comment.
Here is the core explanation
Contributor
Author
|
After coding #7333 up, I think improving the API is the way to go so closing this PR for now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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?
Closes #7272
Rationale for this change
As @UlfarErl notes in #7272, it is somewhat unclear how to use DataFusion to run SQL that can not modify the catalog.
What changes are included in this PR?
As I was working on these examples, it became clear that the current API is confusing as well as there is no way to avoid
DML(aka Insert / COPY). I filed #7328 to track thisAre these changes tested?
Yes, doc tests
Are there any user-facing changes?
Docs