Skip to content

[DOC-10857] Add a note to ARRAY_REMOVE() #334

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Apr 24, 2025
Merged

[DOC-10857] Add a note to ARRAY_REMOVE() #334

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0aa5831
add a note about removing null values
rakhi-prathap Mar 26, 2025
ad680fd
update example
rakhi-prathap Mar 26, 2025
75d9011
edits based on engg feedback
rakhi-prathap Apr 23, 2025
6a753af
fix indentation
rakhi-prathap Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions modules/n1ql/pages/n1ql-language-reference/arrayfun.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1157,10 +1157,26 @@ val1, val2, …:: [At least 1 is required] The input value or multiple values to

Output Values::
A new array with all occurrences of the specified [.var]`val` or multiple [.var]`val` fields removed from the array [.var]`expr`.

+
If any of the arguments are `MISSING`, then it returns `MISSING`.

+
If the first argument is not an array, then it returns `NULL`.
+
[NOTE]
====
This function cannot be used to remove NULL values from an array as it uses an equality predicate when evaluating the array elements to remove.
Since NULL does not equal NULL, such values are not matched and remain in the array.

To remove NULL values, use the xref:n1ql-language-reference/collectionops.adoc#array[Array Collection Operator] instead.
For example:

[source,sqlpp]
----
SELECT ARRAY name FOR name IN ["Ryan", NULL, "Corrine"]
WHEN name IS NOT NULL
END AS filtered_names;
----
====

=== Example
====
Expand Down