Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate ScalarUDFImpl::invoke_batch and move everything to ScalarUDFImpl::invoke_with_args #13515

Closed
alamb opened this issue Nov 21, 2024 · 1 comment · Fixed by #15049
Closed
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@alamb
Copy link
Contributor

alamb commented Nov 21, 2024

Is your feature request related to a problem or challenge?

The current state of the invoke signature for ScalarUDFImpl is somewhat confusing. After

We will have 4 functions

Ideally, we probably should not have added invoke_batch but unfortunately we released it in

With a deprecation message telling users to migrate from invoke / invoke_no_args to invoke_batch

Ideally we want to move everyone to invoke_with_args, but if we did so at this time, it would force downstream crates to migrate twice in quick succession, which is non ideal.

Describe the solution you'd like

Rather than immediately deprecate invoke_batch and force another confusing upgrade, I propose we leave invoke_batch and invoke_with_args for several releases to allow downstream crates to update.

Describe alternatives you've considered

Then in a few months (maybe DataFusion 46, or 47) we can deprecate invoke_batch and move everything to invoke_with_args

Additional context

No response

@alamb alamb added the enhancement New feature or request label Nov 21, 2024
@findepi findepi changed the title (Eventually) Deprecate ScalarUDFImpl::invoke_batch and move everything to ScalarUDFImpl::invoke_with_args Deprecate ScalarUDFImpl::invoke_batch and move everything to ScalarUDFImpl::invoke_with_args Feb 13, 2025
@findepi findepi added the help wanted Extra attention is needed label Feb 13, 2025
@findepi
Copy link
Member

findepi commented Feb 13, 2025

I removed "eventually" from the issue title. The API cleanup is due.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants