ARRAY_REMOVE()
All functions > ARRAY > ARRAY_REMOVE()
Returns an array with all occurrences of the specified element removed.
Signatures
Returns: A new array with all occurrences of the specified element removed
ARRAY_REMOVE(array: ARRAY<T>, element: T) → ARRAY<T> sql
| Parameter | Type | Required | Description |
|---|---|---|---|
array | ARRAY<T> | Yes | The input array from which to remove elements |
element | T | Yes | The element to remove from the array |
Notes
- Removes ALL occurrences of the specified element
- Result element order is normalized (often sorted) so behavior is stable across backends
- Returns empty array if all elements are removed
- Can be used to remove NULL values from arrays
- Supports
ARRAY<ROW>andARRAY<ARRAY<T>>: element equality usesIS DISTINCT FROM(exact structural match)
See also
Examples
FeatureQL
SELECT
-- Remove all occurrences of 2
f1 := ARRAY_REMOVE(ARRAY(1, 2, 2, 3, 2), 2),
-- Remove all occurrences of 'A'
f2 := ARRAY_REMOVE(ARRAY('A', 'B', 'A', 'C'), 'A'),
-- Element not in array
f3 := ARRAY_REMOVE(ARRAY(1, 2, 3), 4),
-- Remove all elements
f4 := ARRAY_REMOVE(ARRAY(5, 5, 5), 5),
-- Remove specific string
f5 := ARRAY_REMOVE(ARRAY('apple', 'banana'), 'apple'),
-- Empty array
f6 := ARRAY_REMOVE(ARRAY()::BIGINT[], 1),
-- Remove NULL values
f7 := ARRAY_REMOVE(ARRAY(1, NULL::BIGINT, 2, NULL::BIGINT), NULL::BIGINT)
;Result
| f1 ARRAY | f2 ARRAY | f3 ARRAY | f4 ARRAY | f5 ARRAY | f6 ARRAY | f7 ARRAY |
|---|---|---|---|---|---|---|
| [1, 3] | [B, C] | [1, 2, 3] | [] | [banana] | [] | [1, 2] |
On this page