Improve documentation for TableProvider #13724
Merged
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
alamb
commented
Dec 10, 2024
| /// Source table | ||
| /// A named table which can be queried. | ||
| /// | ||
| /// Please see [`CatalogProvider`] for details of implementing a custom catalog. |
There was a problem hiding this comment.
I think this link is important as this page provides the overall catalog API docs: https://docs.rs/datafusion/latest/datafusion/catalog/trait.CatalogProvider.html
findepi
approved these changes
Dec 11, 2024
zhuliquan
pushed a commit
to zhuliquan/datafusion
that referenced
this pull request
Dec 11, 2024
zhuliquan
pushed a commit
to zhuliquan/datafusion
that referenced
this pull request
Dec 15, 2024
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?
Rationale for this change
TableProvider, one of the key DataFusion traits, was quite sparseWhat changes are included in this PR?
Add docs and links to
TableProviderAre these changes tested?
Are there any user-facing changes?
Docs only, no functional change