Skip to content

Minor: Improve TableProvider document, and add ascii art - #7759

Merged
alamb merged 2 commits into
apache:mainfrom
alamb:alamb/provider_docs
Oct 7, 2023
Merged

Minor: Improve TableProvider document, and add ascii art#7759
alamb merged 2 commits into
apache:mainfrom
alamb:alamb/provider_docs

Conversation

@alamb

@alambalamb commented Oct 6, 2023

Copy link
Copy Markdown
Contributor

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?

  1. Updated docs for 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

/// 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

@compheadcomphead left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Comment threaddatafusion/core/src/datasource/provider.rs Outdated
@github-actionsgithub-actionsBot added the core Core DataFusion crate label Oct 7, 2023
@alamb

alamb commented Oct 7, 2023

Copy link
Copy Markdown
ContributorAuthor

Thank you @liukun4515 and @comphead

@alamb
alamb merged commit fb37105 into apache:mainOct 7, 2023
@alambalamb added documentation Improvements or additions to documentation devrel labels Oct 7, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

coreCore DataFusion cratedocumentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alamb@liukun4515@comphead