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
- Returns a sorted array (implementation-dependent)
- Preserves relative order of remaining elements
- Returns empty array if all elements are removed
- Can be used to remove NULL values from arrays
Examples
FeatureQL
SELECT
f1 := ARRAY_REMOVE(ARRAY[1, 2, 2, 3, 2], 2), -- Remove all occurrences of 2
f2 := ARRAY_REMOVE(ARRAY['A', 'B', 'A', 'C'], 'A'), -- Remove all occurrences of 'A'
f3 := ARRAY_REMOVE(ARRAY[1, 2, 3], 4), -- Element not in array
f4 := ARRAY_REMOVE(ARRAY[5, 5, 5], 5), -- Remove all elements
f5 := ARRAY_REMOVE(ARRAY['apple', 'banana'], 'apple'), -- Remove specific string
f6 := ARRAY_REMOVE(ARRAY[]::BIGINT[], 1), -- Empty array
f7 := ARRAY_REMOVE(ARRAY[1, NULL::BIGINT, 2, NULL::BIGINT], NULL::BIGINT) -- Remove NULL values
;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