Minor: add ExecutionPlan.execute() snippet for sync methods
#8010
Conversation
This file contains 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
tustvold
reviewed
Oct 31, 2023
datafusion/physical-plan/src/lib.rs
Outdated
| /// | ||
| /// fn print_plan_exec() -> Result<(), DataFusionError> { | ||
| /// let stream = node.execute(0, task_ctx)?; | ||
| /// futures::stream::once(async move { |
There was a problem hiding this comment.
This stream gets immediately dropped and therefore will never run?
There was a problem hiding this comment.
okay, I'll include another use case with amending stream and returning it back to the user. Like in https://github.com/apache/arrow-datafusion/blob/main/datafusion/physical-plan/src/sorts/sort.rs#L895
@tustvold I believe you mean exactly that?
There was a problem hiding this comment.
I mean as written this example doesn't do anything and is therefore just misleading.
Yes, that is I think a good example of the pattern
|
I tried to encode what I was expecting in #8013 PTAL |
|
Closed in favor of #8013 |
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?
Closes #.
Rationale for this change
Very often the question arises on debugging or using record stream in sync context. Adding a code snippet for
ExecutionPlan.execute()What changes are included in this PR?
A code snippet
Are these changes tested?
Are there any user-facing changes?