Skip to content

Docs: document manual catalog impls and how compilation got faster - #24362

Merged
Dandandan merged 1 commit into
apache:mainfrom
alamb:alamb/compilation_time_comment
Aug 14, 2026
Merged

Dandandan merged 1 commit into
apache:mainfrom
alamb:alamb/compilation_time_comment

Conversation

@alamb

@alamb alamb commented Aug 14, 2026 •

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Rationale for this change

@Dandandan came up with a very clever way to improve compile time, see #13814 (comment)

However, the workaround (to make a special future and implement the async trait manually) is not obvious (at least to me) and I worry it might get removed in the future by accident, as we don't have any checks to prevent the regression

Thus I think some comments explaining the pattern and how it would work will help avoid such a problem

What changes are included in this PR?

Add comments explaining why the code is done this way

Are these changes tested?

Comments only

Are there any user-facing changes?

No

@github-actions github-actions Bot added core Core DataFusion crate catalog Related to the catalog crate labels Aug 14, 2026
@alamb alamb changed the title Docs: document how compilation got faster Docs: document manual catalog impls and how compilation got faster Aug 14, 2026
@alamb
alamb requested a review from Dandandan August 14, 2026 11:31
@alamb
alamb marked this pull request as ready for review August 14, 2026 11:31
@alamb alamb added the documentation Improvements or additions to documentation label Aug 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.17%. Comparing base (1f0615a) to head (ee6db62).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #24362      +/-   ##
==========================================
- Coverage   81.17%   81.17%   -0.01%     
==========================================
  Files        1109     1109              
  Lines      388117   388164      +47     
  Branches   388117   388164      +47     
==========================================
+ Hits       315071   315108      +37     
- Misses      54504    54509       +5     
- Partials    18542    18547       +5     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Dandandan Dandandan 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.

Very nice

@alamb

alamb commented Aug 14, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the quick review @Dandandan

@Dandandan
Dandandan added this pull request to the merge queue Aug 14, 2026
Merged via the queue into apache:main with commit 1b67f2e Aug 14, 2026
39 checks passed
imtherealnaska pushed a commit to imtherealnaska/datafusion that referenced this pull request Aug 16, 2026
…pache#24362)

## Which issue does this PR close?

- Follow on to apache#24325
- Follow on to apache#24326
- Follow on to apache#24329
- Follow on to apache#24330


## Rationale for this change

@Dandandan came up with a very clever way to improve compile time, see
apache#13814 (comment)

However, the workaround (to make a special future and implement the
async trait manually) is not obvious (at least to me) and I worry it
might get removed in the future by accident, as we don't have any checks
to prevent the regression

Thus I think some comments explaining the pattern and how it would work
will help avoid such a problem

## What changes are included in this PR?

Add comments explaining why the code is done this way

## Are these changes tested?

Comments only

## Are there any user-facing changes?

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

Labels

catalog Related to the catalog crate core Core DataFusion crate documentation Improvements or additions to documentation v56.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants