Skip to content

bug: fix array_remove_* with NULLS#21013

Merged
comphead merged 1 commit intoapache:mainfrom
comphead:array_remove
Mar 17, 2026
Merged

bug: fix array_remove_* with NULLS#21013
comphead merged 1 commit intoapache:mainfrom
comphead:array_remove

Conversation

@comphead
Copy link
Copy Markdown
Contributor

@comphead comphead commented Mar 17, 2026

Which issue does this PR close?

Rationale for this change

Handle correctly array_remove_* functions if NULL is a value to delete

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions Bot added sqllogictest SQL Logic Tests (.slt) functions Changes to functions implementation labels Mar 17, 2026
buraksenn
buraksenn approved these changes Mar 17, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@buraksenn buraksenn left a comment

Choose a reason for hiding this comment

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

LGTM

mbutrovich
mbutrovich approved these changes Mar 17, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@mbutrovich mbutrovich left a comment

Choose a reason for hiding this comment

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

Thanks @comphead. This reminds me of our earlier discussion about arrays with NULL in them. Should we document at a high level somewhere what semantics we're adopting arrays with NULL in them?

@comphead
Copy link
Copy Markdown
Contributor Author

comphead commented Mar 17, 2026

Thanks @comphead. This reminds me of our earlier discussion about arrays with NULL in them. Should we document at a high level somewhere what semantics we're adopting arrays with NULL in them?

This case is more straightforward: so if NULL is the value to be removed, then we get always null as the result, no matter what are other params.
For array_contains there were more specific rules:
if the value to be matched is not found AND the base array has NULL then return NULL.

But you are right, we prob need to add NULL handling comments to description for arrays builtin functions

@comphead
Copy link
Copy Markdown
Contributor Author

comphead commented Mar 17, 2026

Thanks @mbutrovich and @buraksenn for the review

@comphead comphead added this pull request to the merge queue Mar 17, 2026
Merged via the queue into apache:main with commit 6ab16cc Mar 17, 2026
30 checks passed
@comphead comphead mentioned this pull request Mar 17, 2026
Closed
comphead added a commit to comphead/arrow-datafusion that referenced this pull request Mar 17, 2026
@comphead
bug: fix array_remove_* with NULLS (apache#21013)
b8cf4b6 
## 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 apache#21011 .

## Rationale for this change

Handle correctly `array_remove_*` functions if NULL is a value to delete

<!--
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.
-->

## 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.
-->

## 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)?
-->

## 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.
-->

(cherry picked from commit 6ab16cc)
comphead added a commit that referenced this pull request Mar 17, 2026
@comphead
[branch-53]: fix array_remove_* with NULLS (#21013) (#21016)
5746048 
## 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 #21011 .

## Rationale for this change

Handle correctly `array_remove_*` functions if NULL is a value to delete

<!--
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. -->

## 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.
-->

## 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)?
-->

## 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.
-->

(cherry picked from commit 6ab16cc)

## 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

<!--
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.
-->

## 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.
-->

## 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)?
-->

## 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.
-->
de-bgunter pushed a commit to de-bgunter/datafusion that referenced this pull request Mar 24, 2026
@comphead @de-bgunter
bug: fix array_remove_* with NULLS (apache#21013)
566611e 
## 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#21011 .

## Rationale for this change

Handle correctly `array_remove_*` functions if NULL is a value to delete


<!--
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.
-->

## 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.
-->

## 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)?
-->

## 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.
-->
@gabotechs
Copy link
Copy Markdown
Contributor

gabotechs commented Apr 21, 2026

I was able to track a regression in our system to this PR, this behavior change seems to silently change results of the array_remove() function but was not really mentioned in the upgrade guide here: https://github.com/apache/datafusion/blob/main/docs/source/library-user-guide/upgrading/53.0.0.md.

It seems like after this PR there is no alternative that allows removing NULL entries from arrays. Is there any guideline about what semantics are functions expected to follow? Or are function semantics are typically evaluated in a 1-by-1 case?

@gabotechs
Copy link
Copy Markdown
Contributor

gabotechs commented Apr 21, 2026

🤔 I see that feat: support array_compact builtin function is a good alternative, but did not make it to branch-53 unfortunately...

@comphead
Copy link
Copy Markdown
Contributor Author

comphead commented Apr 21, 2026

Thanks @gabotechs for pointing this out. so array_remove become in sync with other query engines. array_compact would serve better if you looking to remove NULLs from the array.

Let me add the description to Upgrade guide. For the fix, we can plan a 53.2.0 hotfix having array_compact in there, if its urgent. Alternatively is to use DF52 until DF54 released

@comphead comphead mentioned this pull request Apr 21, 2026
Merged
adriangb pushed a commit to pydantic/datafusion that referenced this pull request Apr 21, 2026
@comphead
chore: add array_remove_* NULL handling changes to Upgrade Guide (a…
cfafce4 
…pache#21769)

## 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 #.

## Rationale for this change

Initially posted by @gabotechs in
apache#21013 (comment)

<!--
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.
-->

## 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.
-->

## 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)?
-->

## 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.
-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mbutrovich mbutrovich mbutrovich approved these changes

+1 more reviewer

@buraksenn buraksenn buraksenn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

functions Changes to functions implementation sqllogictest SQL Logic Tests (.slt)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

array_remove_* returns wrong response for NULLs

4 participants

@comphead @gabotechs @mbutrovich @buraksenn