add_element() function

The add_element() function appends an array element to the end of an array and assigns the element a value.

Syntax

The syntax of the add_element() function has the following forms, one for each data type:

array = add_element(array input, varchar value [, varchar name])
array = add_element(array input, varchar value [, nvarchar name])
array = add_element(array input, nvarchar value [, varchar name])
array = add_element(array input, nvarchar value [, nvarchar name])
array = add_element(array input, int1 value [, varchar name])
array = add_element(array input, int1 value [, nvarchar name])
array = add_element(array input, int2 value [, varchar name])
array = add_element(array input, int2 value [, nvarchar name])
array = add_element(array input, int4 value [, varchar name])
array = add_element(array input, int4 value [, nvarchar name])
array = add_element(array input, int8 value [, varchar name])
array = add_element(array input, int8 value [, nvarchar name])
array = add_element(array input, date value [, varchar name])
array = add_element(array input, date value [, nvarchar name])
array = add_element(array input, double value [, varchar name])
array = add_element(array input, double value [, nvarchar name])
array = add_element(array input, time value [, varchar name])
array = add_element(array input, time value [, nvarchar name])
array = add_element(array input, timetz value [, varchar name])
array = add_element(array input, timetz value [, nvarchar name])
array = add_element(array input, timestamp value [, varchar name]);
array = add_element(array input, timestamp value [, nvarchar name]);

The input value specifies the array to which to append the element.

The value value specifies the value to store in the new array element.

The optional name value specifies the name of the array element to append.

Returns

The function appends a new element with a value.

Example

The following function appends an element to the end of the my_array array and stores the value 45 in that element:

add_element(my_array, 45)