Uh oh!
There was an error while loading. Please reload this page.
Explicitly declare spill codec dependency in physical-plan - #21917
Merged
Conversation
…ec contract - Cleaned up alphabetical ordering in Cargo.toml. - Added comments to clarify feature-only dependencies related to IPCStreamWriter in spill/mod.rs. - Documented codec contract requirement in IPCStreamWriter::new for better understanding of feature dependencies.
- Changed `ignored = "serde_json"` to `ignored = ["serde_json"]` to comply with TOML array requirements. - Fixed additional TOML parse errors. - Added `arrow-ipc` to the `cargo-machete` ignore list with a comment on its necessity for spill compression codec support.
kosiew added a commit
to kosiew/datafusion
that referenced
this pull request
Apr 29, 2026
- Clarified spill codec comments in Cargo.toml:50 and Cargo.toml:99 to explain that arrow-ipc is consumed only via the arrow::ipc re-export, addressing potential unused flags from cargo-machete. - Revised writer doc comment in mod.rs:295 to specify "build-visible during Cargo feature resolution" instead of "compiler-visible." - Replaced bare commit hash reference with PR apache#21917 for clarity. - Added brief notes to the opportunistic serde_json cargo-machete cleanup in Cargo.toml:85 and Cargo.toml:97 to indicate they are unrelated to the spill contract.
kosiew added a commit
to kosiew/datafusion
that referenced
this pull request
Apr 29, 2026
- Clarified spill codec comments in Cargo.toml:50 and Cargo.toml:99 to explain that arrow-ipc is consumed only via the arrow::ipc re-export, addressing potential unused flags from cargo-machete. - Revised writer doc comment in mod.rs:295 to specify "build-visible during Cargo feature resolution" instead of "compiler-visible." - Replaced bare commit hash reference with PR apache#21917 for clarity. - Added brief notes to the opportunistic serde_json cargo-machete cleanup in Cargo.toml:85 and Cargo.toml:97 to indicate they are unrelated to the spill contract.
arrow-ipc (lz4, zstd) and document contractkosiew
marked this pull request as ready for review
April 29, 2026 13:06
alamb
commented
Apr 29, 2026
Contributor
Can we please split the breaking_change refactor from the codec depedendcy work? They seem separtae and having two PRs would be easier to review |
kosiew
marked this pull request as draft
April 30, 2026 04:54
kosiew
commented
Apr 30, 2026
ContributorAuthor
split the breaking_change refactor into #21951 |
rluvaton
commented
Apr 30, 2026
Member
merged with main since the breaking change detector is now fixed |
rluvaton
commented
Apr 30, 2026
Member
can you update the title as well? |
kosiew
commented
Apr 30, 2026
ContributorAuthor
@rluvaton |
alamb
reviewed
May 3, 2026
| @@ -0,0 +1,29 @@ | |||
| { | |||
Uh oh!
There was an error while loading. Please reload this page.
| # `arrow-ipc` is used only through the `arrow::ipc` re-export, so cargo-machete | ||
| # reports it as unused even though this crate relies on its codec features. | ||
| [package.metadata.cargo-machete] |
Contributor
There was a problem hiding this comment.
See above for a suggestion on how to simplify his
physical-plan- Clarified spill codec comments in Cargo.toml:50 and Cargo.toml:99 to explain that arrow-ipc is consumed only via the arrow::ipc re-export, addressing potential unused flags from cargo-machete. - Revised writer doc comment in mod.rs:295 to specify "build-visible during Cargo feature resolution" instead of "compiler-visible." - Replaced bare commit hash reference with PR apache#21917 for clarity. - Added brief notes to the opportunistic serde_json cargo-machete cleanup in Cargo.toml:85 and Cargo.toml:97 to indicate they are unrelated to the spill contract.
… and codec features
kosiew
commented
May 5, 2026
ContributorAuthor
@alamb |
This file contains hidden or 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
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
The spill subsystem implicitly relied on workspace-level Cargo feature unification for codec support (e.g.,
arrow-ipc/zstd). This created a fragile setup where changes in unrelated dependencies or feature flags could silently break spill compression.This PR establishes an explicit, crate-local contract for codec availability, improving correctness, maintainability, and visibility of dependencies.
What changes are included in this PR?
Add an explicit
arrow-ipcdependency withlz4andzstdfeatures indatafusion-physical-planto ensure required codecs are always available.Document the codec contract directly in
IPCStreamWriter::new, clarifying expectations and failure modes.Update compression handling:
SpillCompressionintoOption<CompressionType>before passing totry_with_compression.Rename parameter
compression_type→spill_compressionfor clarity.Add
arrow-ipcas a dependency in the workspace lockfile.Minor cleanup:
cargo-macheteignored field to array format.serde_jsonusage.Are these changes tested?
No new tests are included in this PR.
The changes rely on existing spill-related tests. No modifications to tests were made in this diff.
Are there any user-facing changes?
No direct user-facing changes.
This PR improves internal reliability and makes spill compression behavior more robust against dependency or feature configuration changes.
LLM-generated code disclosure
This PR includes LLM-generated code and comments. All LLM-generated content has been manually reviewed and tested.