Skip to content

More documentation on FileSource::table_schema and FileSource::projection#20242

Merged
alamb merged 2 commits intoapache:mainfrom
alamb:alamb/docs2223432
Feb 9, 2026
Merged

More documentation on FileSource::table_schema and FileSource::projection#20242
alamb merged 2 commits intoapache:mainfrom
alamb:alamb/docs2223432

Conversation

@alamb
Copy link
Copy Markdown
Contributor

@alamb alamb commented Feb 9, 2026

Which issue does this PR close?

Rationale for this change

@zhuqi-lucas and @adriangb had some good ideas on how to further improve the documentation on #20188, which I tried to implement in this PR

What changes are included in this PR?

Add more clarity about what TableSource and FileSource::projection are

Are these changes tested?

By CI

Are there any user-facing changes?

Additional documentation

@alamb alamb added the documentation Improvements or additions to documentation label Feb 9, 2026
@github-actions github-actions Bot added datasource Changes to the datasource crate and removed documentation Improvements or additions to documentation labels Feb 9, 2026
fn as_any(&self) -> &dyn Any;

/// Returns the table schema for this file source.
/// Returns the table schema for the overall table (including partition columns, if any)
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

///
/// The output schema of this `FileSource` is this TableSchema
/// with [`Self::projection`] applied.
///
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@alamb alamb marked this pull request as ready for review February 9, 2026 14:30
Copy link
Copy Markdown
Contributor

@AdamGS AdamGS left a comment

Choose a reason for hiding this comment

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

LGTM (non-binding)

@alamb
Copy link
Copy Markdown
Contributor Author

alamb commented Feb 9, 2026

Thanks everyone

@alamb alamb added the documentation Improvements or additions to documentation label Feb 9, 2026
@alamb alamb added this pull request to the merge queue Feb 9, 2026
@alamb
Copy link
Copy Markdown
Contributor Author

alamb commented Feb 9, 2026

I'll be happy to do a follow on PR with more docs too if there are othr suggestions

Merged via the queue into apache:main with commit 2e1fc5c Feb 9, 2026
28 checks passed
de-bgunter pushed a commit to de-bgunter/datafusion that referenced this pull request Mar 24, 2026
…jection` (apache#20242)

## Which issue does this PR close?

- Follow on to apache#20188

## Rationale for this change

@zhuqi-lucas and @adriangb had some good ideas on how to further improve
the documentation on apache#20188,
which I tried to implement in this PR

## What changes are included in this PR?

Add more clarity about what TableSource and FileSource::projection are

## Are these changes tested?

By CI
## Are there any user-facing changes?

Additional documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

datasource Changes to the datasource crate documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants