2010YOUY01 opened a new pull request, #25257:
URL: https://github.com/apache/datafusion/pull/25257
## 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 #123`
indicates that this PR will close issue #123.
-->
- Closes #.
## Rationale for this change
`AggregateExec::{with_new_limit_options, with_limit_options, limit_options}`
set a limit hint on an aggregation. This is part of the public API for
`AggregateExec`
It's nearly impossible to use it correctly if we see it as a public
`ExecutionPlan` API, however it requires `pub` because physical optimizer
requires it.
```
// physical optimizer
if tricky_pre_conditions() {
agg_exec.with_limit_options(k)
}
```
This PR does:
- Deprecate those API, but it can't get deleted since optimizer requires it.
This approach can warn downstreams that this API is unsafe and should not be
used directly
- Mark `#[doc(hidden)]`. That is the usual Rust convention for "public for
technical reasons, not for external user": the item is dropped from generated
docs (docs.rs)
## What changes are included in this PR?
## What is the testing strategy for this PR?
<!--
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
Briefly describe how this PR is tested, and point to the specific tests you
added. For example: 'This new feature is covered by the `sqllogictest` cases
added in `foo.slt`'.
If this PR does not add tests, explain why. For example, if the change is
already covered by existing tests, please mention it.
You should also check the `codecov` bot reply on this PR to confirm the
changed code is exercised.
-->
## 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. It's like a soft-deprecation, downstream can still use it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
