removeValue()

Remove all occurrences of a value from an array.

REMOVE_VALUE([1, 2, 3, 2, 4], 2)        // returns [1, 3, 4]
REMOVE_VALUE([1, 2, 3, 2, 4], 2, 1)     // returns [1, 3, 2, 4] (only first occurrence)
REMOVE_VALUE([1, 2, 3], 5)               // returns [1, 2, 3] (value not found)

Parameters

$anyArray : string

Array expression to remove value from.

$value : mixed

Value to remove from the array.

$limit : int|string|null = null

Optional limit for the number of removals. Non-numeric or non-positive values (and null) are ignored (no limit).

Tags

example

use function oihana\arango\db\functions\arrays\removeValue;

$expr = removeValue('doc.tags', 'deprecated');
// Produces: 'REMOVE_VALUE(doc.tags, "deprecated")'

$expr = removeValue('doc.tags', 'deprecated', 1);
// Produces: 'REMOVE_VALUE(doc.tags, "deprecated", 1)'

see

https://docs.arangodb.com/stable/aql/functions/array/#remove_value

removeValues()

For removing multiple values at once.

since

1.0.0

author

Marc Alcaraz