Minor: Improve TableProvider document, and add ascii art #7759
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
comphead
reviewed
Oct 6, 2023
| /// The table provider will be usually responsible of grouping | ||
| /// the source data into partitions that can be efficiently | ||
| /// parallelized or distributed. | ||
| /// Create an [`ExecutionPlan`] for scanning the table with optionally |
alamb
commented
Oct 7, 2023
liukun4515
approved these changes
Oct 7, 2023
|
Thank you @liukun4515 and @comphead |
# for free
to join this conversation on GitHub.
Already have an account?
# 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?
N/A
Rationale for this change
@comphead liked the ASCII art (#7747 (comment)) :) -- but seriously I would like to make it easier for DataFusion to be used -- both the specifics of how DataFusion works as well as more general database principles.
What changes are included in this PR?
TableProvider::scan, including details about filter, projection and limit pushdown (with a diagram!)Are these changes tested?
doc tests
Are there any user-facing changes?
Docs only