Skip to content

Conversation

@Jefffrey
Copy link
Contributor

Which issue does this PR close?

Rationale for this change

AggregateUDFImpl::is_ordered_set_aggregate is confusingly named as all it does currently is permit usage of WITHIN GROUP SQL syntax. I don't think it would have any functionality in the future beyond this. Also makes it easier if in future we decide to implement hypothetical-set aggregate functions too, since we wouldn't need a is_hypothetical_set_aggregate variation either.

What changes are included in this PR?

Rename AggregateUDFImpl::is_ordered_set_aggregate to AggregateUDFImpl::supports_within_group_clause.

Are these changes tested?

Existing tests.

Are there any user-facing changes?

Yes. Added section to upgrade guide.

@github-actions github-actions bot added documentation Improvements or additions to documentation sql SQL Planner logical-expr Logical plan and expressions functions Changes to functions implementation labels Oct 31, 2025
@Jefffrey Jefffrey added the api change Changes the API exposed to users of the crate label Oct 31, 2025
@Jefffrey Jefffrey marked this pull request as ready for review October 31, 2025 08:21
pub fn is_ordered_set_aggregate(&self) -> bool {
self.inner.is_ordered_set_aggregate()
/// See [`AggregateUDFImpl::supports_within_group_clause`] for more details.
pub fn supports_within_group_clause(&self) -> bool {
Copy link
Contributor

Choose a reason for hiding this comment

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

this is a breaking API change, as you have pointed out in the PR description and upgrade guide

@alamb
Copy link
Contributor

alamb commented Oct 31, 2025

Thank you @Jefffrey

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

Labels

api change Changes the API exposed to users of the crate documentation Improvements or additions to documentation functions Changes to functions implementation logical-expr Logical plan and expressions sql SQL Planner

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consider renaming AggregateUDFImpl::is_ordered_set_aggregate to AggregateUDFImpl::supports_within_group_clause

2 participants