replace_element() function

The replace_element() function replaces an element in an array.

You can use an array index or the name of the element to access the element. This function has numerous forms, corresponding to the supported data types and the access type (name or index).

Syntax

The replace_element() function has the following syntax:

array = replace_element(array input, int index, varchar value)
array = replace_element(array input, varchar name, varchar value)
array = replace_element(array input, nvarchar name, varchar value)
array = replace_element(array input, int index, nvarchar value)
array = replace_element(array input, varchar name, nvarchar value)
array = replace_element(array input, nvarchar name, nvarchar value)
array = replace_element(array input, int index, int1 value)
array = replace_element(array input, varchar name, int1 value)
array = replace_element(array input, nvarchar name, int1 value)
array = replace_element(array input, int index, int2 value)
array = replace_element(array input, varchar name, int2 value)
array = replace_element(array input, nvarchar name, int2 value)
array = replace_element(array input, int index, int value)
array = replace_element(array input, varchar name, int value)
array = replace_element(array input, nvarchar name, int value)
array = replace_element(array input, int index, int8 value)
array = replace_element(array input, varchar name, int8 value)
array = replace_element(array input, nvarchar name, int8 value)
array = replace_element(array input, int index, double value)
array = replace_element(array input, varchar name, double value)
array = replace_element(array input, nvarchar name, double value)
array = replace_element(array input, int index, time value)
array = replace_element(array input, varchar name, time value)
array = replace_element(array input, nvarchar name, time value)
array = replace_element(array input, int index, timetz value)
array = replace_element(array input, varchar name, timetz value)
array = replace_element(array input, nvarchar name, timetz value)
array = replace_element(array input, int index, date value)
array = replace_element(array input, varchar name, date value)
array = replace_element(array input, nvarchar name, date value)
array = replace_element(array input, int index, timestamp value)
array = replace_element(array input, varchar name, timestamp value);
array = replace_element(array input, nvarchar name, timestamp value);

The input value specifies the array in which to replace the element.

The index value specifies the position in the array at which to replace the element.

The name value specifies the name of the array element to replace, in either varchar or nvarchar format.

The value value specifies the new value for the specified array element.

Returns

The function replaces the array element.

Example

In the following example, the value 12 in array_t is replaced with the value 15:

select replace_element(col2,1,15)from array_t;

This query returns the updated array:

 replace_element 
-----------------
 ARR
(1 row)

The following query displays the elements of array_t:

select array_combine(replace_element(col2,1,15),'|')from array_t;
 array_combine 
---------------
 15|23
(1 row)