Skip to content

docs: update proto-models README for the datafusion-common dependency - #24279

Open
adriangb wants to merge 2 commits into
apache:mainfrom
pydantic:claude/datafusion-followup-pr-lxornm
Open

docs: update proto-models README for the datafusion-common dependency#24279
adriangb wants to merge 2 commits into
apache:mainfrom
pydantic:claude/datafusion-followup-pr-lxornm

Conversation

@adriangb

@adriangb adriangb commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

datafusion-proto-models now depends on datafusion-common and hosts the From / TryFrom conversions between the generated proto types and their datafusion-common counterparts, but the crate README still claimed it had no DataFusion dependencies beyond datafusion-proto-common and exposed only the generated structs.

Describe the conversions and why they live in this crate, and spell out the narrowness that still holds: datafusion-common and datafusion-proto-common are the only DataFusion dependencies.

`datafusion-proto-models` now depends on `datafusion-common` and hosts the
`From` / `TryFrom` conversions between the generated proto types and their
`datafusion-common` counterparts, but the crate README still claimed it had
no DataFusion dependencies beyond `datafusion-proto-common` and exposed only
the generated structs.

Describe the conversions and why they live in this crate, and spell out the
narrowness that still holds: `datafusion-common` and `datafusion-proto-common`
are the only DataFusion dependencies.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GoAdfGfHwhLreDPDQ9GoDK
@codecov-commenter

codecov-commenter commented Aug 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.29%. Comparing base (fc846dd) to head (3299add).
⚠️ Report is 75 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #24279      +/-   ##
==========================================
+ Coverage   81.05%   81.29%   +0.24%     
==========================================
  Files        1107     1110       +3     
  Lines      381574   385311    +3737     
  Branches   381574   385311    +3737     
==========================================
+ Hits       309281   313246    +3965     
+ Misses      54034    53580     -454     
- Partials    18259    18485     +226     

☔ 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.

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

Thanks @adriangb

Comment thread datafusion/proto-models/README.md Outdated
between those types and the [`datafusion-common`] types they mirror. The
conversions live here because their DataFusion side sits _below_ this crate in
the dependency graph and so cannot host the impls itself — the same arrangement
[`datafusion-proto-common`] uses for `ScalarValue` and `Statistics`.

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.

I recommend adding a link to the relevant context / definition for ScaalrValue / Statistics as well

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.

done!

@alamb alamb added the documentation Improvements or additions to documentation label Aug 12, 2026
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions github-actions Bot removed the documentation Improvements or additions to documentation label Aug 12, 2026
@adriangb
adriangb enabled auto-merge August 12, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants