arrayRemoveAt

Description

Returns a new array with the element at the specified position removed.

• The element type must match the array type.
• Supported element types include string, bool, number, interval, timestamp, regexp, and enum.
• Positions are 0-indexed.

Syntax

Like many functions in DataPrime, arrayRemoveAt supports two notations, function and method. These interchangeable forms allow flexibility in how you structure expressions.

Function notation

arrayRemoveAt(array: array<T>, position: number): array<T>

Method notation

(array: array<T>).arrayRemoveAt(position: number): array<T>

Arguments

Name	Type	Required	Description
array	array<T>	true	The array to modify
position	number	true	The index of the element to remove (0-indexed)

Example

Use case: Remove an item from a queue by position

Suppose you have a list of jobs and want to remove the job at a specific position. Consider the following input:

{
    "values": ["Job 1", "Job 2", "Job 3", "Job 4"]
}

By removing the element at index 2, the array will no longer include "Job 3".

Example query

Function notation

replace values with arrayRemoveAt(values, 2)

Method notation

replace values with values.arrayRemoveAt(2)

Example output

The result will include the updated array without the element at that position:

{
    "values": ["Job 1", "Job 2", "Job 4"]
}