Skip to content

feat: Implement state conversion for remaining group accumulators - #23275

Merged
alamb merged 3 commits into
apache:mainfrom
lyne7-sc:feat/accumulator_convert_state
Jul 11, 2026
Merged

feat: Implement state conversion for remaining group accumulators#23275
alamb merged 3 commits into
apache:mainfrom
lyne7-sc:feat/accumulator_convert_state

Conversation

@lyne7-sc

@lyne7-sc lyne7-sc commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Rationale for this change

#23081 proposes making GroupsAccumulator::convert_to_state mandatory and removing supports_convert_to_state.

Before that API cleanup can happen, all existing GroupsAccumulator implementations need a correct convert_to_state implementation.

This PR is the first step toward that cleanup: it fills in missing convert_to_state implementations for the remaining group accumulators that currently participate in grouped aggregation.

What changes are included in this PR?

This PR adds convert_to_state support for:

  • PrimitiveDistinctCountGroupsAccumulator
  • HllGroupsAccumulator for approx_distinct
  • VarianceGroupsAccumulator
  • StddevGroupsAccumulator
  • CorrelationGroupsAccumulator
  • GeometricMeanGroupsAccumulator in the advanced UDAF example

Are these changes tested?

Yes. This PR adds unit tests for the new convert_to_state implementations.

Are there any user-facing changes?

No. This PR does not remove supports_convert_to_state yet and does not change the public GroupsAccumulator API.

@github-actions github-actions Bot added core Core DataFusion crate functions Changes to functions implementation labels Jul 1, 2026

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

@lyne7-sc
Thanks for the fix.
The accumulator-level roundtrip tests cover the core state conversion logic nicely.
I left one small follow-up suggestion for broader wiring coverage.

}

#[test]
fn convert_to_state_roundtrips_through_merge() -> Result<()> {

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.

Nice, these new unit tests directly cover convert_to_state -> merge_batch, which is great to see.

One small follow-up idea: it may be worth adding a SQLLogicTest case in aggregate_skip_partial.slt for the newly enabled public skip-partial path for variance, stddev, and corr. Including a FILTER or NULL row would help catch wiring regressions outside the accumulator unit tests. COUNT(DISTINCT) could be included too if it is practical.

This is non-blocking since the accumulator-level roundtrip tests already exercise the core state conversion logic.

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.

Thanks @kosiew, I added SLT coverage in aggregate_skip_partial.slt for the skip-partial sql path. The new cases cover variance/stddev, corr, and count distinct with nullable inputs and FILTER.

I also compared the same queries against the non-skip path locally and confirmed the results match.

@alamb alamb added the performance Make DataFusion faster label Jul 9, 2026
@github-actions github-actions Bot added the sqllogictest SQL Logic Tests (.slt) label Jul 10, 2026
@alamb
alamb added this pull request to the merge queue Jul 11, 2026
@alamb

alamb commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Thank you @lyne7-sc and @kosiew

Merged via the queue into apache:main with commit 3e058f0 Jul 11, 2026
36 checks passed
@lyne7-sc
lyne7-sc deleted the feat/accumulator_convert_state branch July 11, 2026 06:00
lyne7-sc added a commit to lyne7-sc/datafusion that referenced this pull request Jul 24, 2026
…nvert_to_state` (apache#23489)

## Which issue does this PR close?

<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes apache#123` indicates that this PR will close issue apache#123.
-->

- Closes apache#23081.

## Rationale for this change

<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
-->

Following apache#23275, all `GroupsAccumulator` implementations now provide
`convert_to_state`.

The `supports_convert_to_state` capability flag is therefore no longer
needed.

## What changes are included in this PR?

<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->

- Make `GroupsAccumulator::convert_to_state` a required trait method.
- Remove `GroupsAccumulator::supports_convert_to_state` and its
implementations.
- Remove the corresponding capability checks from hash aggregation.
- Simplify skip-partial aggregation to use the required
`convert_to_state` implementation directly.
- Add a regression test covering the partial hash aggregation skip path.
- Document the breaking trait change in the 55.0.0 upgrading guide.

- Remove `FFI_GroupsAccumulator::supports_convert_to_state`. This
changes the FFI ABI layout, so providers and consumers must be rebuilt
against DataFusion 55.

## Are these changes tested?

<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->

Yes. Added a regression test verifying that skip-partial aggregation
uses the required `convert_to_state` implementation without a capability
flag.

Existing physical-plan and FFI tests continue to pass.

## Are there any user-facing changes?

<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->

<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->

Yes. This is a breaking Rust API change for external `GroupsAccumulator`
implementations:

- `convert_to_state` must now be implemented.
- `supports_convert_to_state` should be removed.

The migration is documented in the 55.0.0 upgrading guide.

The `FFI_GroupsAccumulator` layout has changed. FFI providers and
consumers must be rebuilt against DataFusion 55 and must not exchange
this struct with older major versions.
kosiew pushed a commit to kosiew/datafusion that referenced this pull request Aug 12, 2026
…nvert_to_state` (apache#23489)

## Which issue does this PR close?

<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes apache#123` indicates that this PR will close issue apache#123.
-->

- Closes apache#23081.

## Rationale for this change

<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
-->

Following apache#23275, all `GroupsAccumulator` implementations now provide
`convert_to_state`.

The `supports_convert_to_state` capability flag is therefore no longer
needed.

## What changes are included in this PR?

<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->

- Make `GroupsAccumulator::convert_to_state` a required trait method.
- Remove `GroupsAccumulator::supports_convert_to_state` and its
implementations.
- Remove the corresponding capability checks from hash aggregation.
- Simplify skip-partial aggregation to use the required
`convert_to_state` implementation directly.
- Add a regression test covering the partial hash aggregation skip path.
- Document the breaking trait change in the 55.0.0 upgrading guide.

- Remove `FFI_GroupsAccumulator::supports_convert_to_state`. This
changes the FFI ABI layout, so providers and consumers must be rebuilt
against DataFusion 55.

## Are these changes tested?

<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->

Yes. Added a regression test verifying that skip-partial aggregation
uses the required `convert_to_state` implementation without a capability
flag.

Existing physical-plan and FFI tests continue to pass.

## Are there any user-facing changes?

<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->

<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->

Yes. This is a breaking Rust API change for external `GroupsAccumulator`
implementations:

- `convert_to_state` must now be implemented.
- `supports_convert_to_state` should be removed.

The migration is documented in the 55.0.0 upgrading guide.

The `FFI_GroupsAccumulator` layout has changed. FFI providers and
consumers must be rebuilt against DataFusion 55 and must not exchange
this struct with older major versions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Core DataFusion crate functions Changes to functions implementation performance Make DataFusion faster sqllogictest SQL Logic Tests (.slt)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants