array_remove function

Applies to: Databricks SQL Databricks Runtime

Removes all occurrences of element from array.

Syntax

array_remove(array, element)

Arguments

• array: An ARRAY.
• element: An expression of a type sharing a least common type with the elements of array.

Returns

The result type matched the type of the array.

If the element to be removed is NULL, the result is NULL.

Azure Databricks raises COLLECTION_SIZE_LIMIT_EXCEEDED if the result exceeds the array size limit.

Common error conditions

• COLLECTION_SIZE_LIMIT_EXCEEDED

Examples

> SELECT array_remove(array(1, 2, 3, NULL, 3, 2), 3);
 [1,2,NULL,2]
> SELECT array_remove(array(1, 2, 3, NULL, 3, 2), NULL);
 NULL

Related

• array_except function
• SQL data type rules