9.18. Функции и операторы для работы с массивами
В Таблице 9.47 показаны операторы, предназначенные для работы с массивами.
Таблица 9.47. Операторы для работы с массивами
| Оператор | Описание | Пример | Результат |
|---|---|---|---|
= | равно | ARRAY[1.1,2.1,3.1]::int[] = ARRAY[1,2,3] | t |
<> | не равно | ARRAY[1,2,3] <> ARRAY[1,2,4] | t |
< | меньше | ARRAY[1,2,3] < ARRAY[1,2,4] | t |
> | больше | ARRAY[1,4,3] > ARRAY[1,2,4] | t |
<= | меньше или равно | ARRAY[1,2,3] <= ARRAY[1,2,3] | t |
>= | больше или равно | ARRAY[1,4,3] >= ARRAY[1,4,3] | t |
@> | содержит | ARRAY[1,4,3] @> ARRAY[3,1,3] | t |
<@ | содержится в | ARRAY[2,2,7] <@ ARRAY[1,7,4,2,6] | t |
&& | пересечение (есть общие элементы) | ARRAY[1,4,3] && ARRAY[2,1] | t |
|| | соединение массива с массивом | ARRAY[1,2,3] || ARRAY[4,5,6] | {1,2,3,4,5,6} |
|| | соединение массива с массивом | ARRAY[1,2,3] || ARRAY[[4,5,6], [7,8,9]] | {{1,2,3},{4,5,6},{7,8,9}} |
|| | соединение элемента с массивом | 3 || ARRAY[4,5,6] | {3,4,5,6} |
|| | соединение массива с элементом | ARRAY[4,5,6] || 7 | {4,5,6,7} |
Операторы упорядочивания массивов (<, >= и т. д.) сравнивают содержимое массивов по элементам, используя при этом функцию сравнения для B-дерева, определённую для типа данного элемента по умолчанию, и сортируют их по первому различию. В многомерных массивах элементы просматриваются по строкам (индекс последней размерности меняется в первую очередь). Если содержимое двух массивов совпадает, а размерности различаются, результат их сравнения будет определяться первым отличием в размерностях. (В PostgreSQL до версии 8.2 поведение было другим: два массива с одинаковым содержимом считались одинаковыми, даже если число их размерностей и границы индексов различались.)
Операторы вложенности массивов (<@ и @>) считают один массив вложенным в другой, если каждый элемент первого встречается во втором. Повторяющиеся элементы рассматриваются на общих основаниях, поэтому массивы ARRAY[1] и ARRAY[1,1] считаются вложенным друг в друга.
Подробнее поведение операторов с массивами описано в Разделе 8.15. За дополнительными сведениями об операторах, поддерживающих индексы, обратитесь к Разделу 11.2.
В Таблице 9.48 перечислены функции, предназначенные для работы с массивами. Дополнительная информация о них и примеры использования приведены в Разделе 8.15.
Таблица 9.48. Функции для работы с массивами
| Функция | Тип результата | Описание | Пример | Результат |
|---|---|---|---|---|
| anyarray | добавляет элемент в конец массива | array_append(ARRAY[1,2], 3) | {1,2,3} |
| anyarray | соединяет два массива | array_cat(ARRAY[1,2,3], ARRAY[4,5]) | {1,2,3,4,5} |
| int | возвращает число размерностей массива | array_ndims(ARRAY[[1,2,3], [4,5,6]]) | 2 |
| text | возвращает текстовое представление размерностей массива | array_dims(ARRAY[[1,2,3], [4,5,6]]) | [1:2][1:3] |
| anyarray | возвращает массив, заполненный заданным значением и имеющий указанные размерности, в которых нижняя граница может быть отлична от 1 | array_fill(7, ARRAY[3], ARRAY[2]) | [2:4]={7,7,7} |
| int | возвращает длину указанной размерности массива | array_length(array[1,2,3], 1) | 3 |
| int | возвращает нижнюю границу указанной размерности массива | array_lower('[0:2]={1,2,3}'::int[], 1) | 0 |
| int | возвращает позицию первого вхождения второго аргумента в массиве, начиная с элемента, выбираемого третьим аргументом, либо с первого элемента (массив должен быть одномерным) | array_position(ARRAY['sun','mon','tue','wed','thu','fri','sat'], 'mon') | 2 |
| int[] | возвращает массив с позициями всех вхождений второго аргумента в массиве, задаваемым первым аргументом (массив должен быть одномерным) | array_positions(ARRAY['A','A','B','A'], 'A') | {1,2,4} |
| anyarray | вставляет элемент в начало массива | array_prepend(1, ARRAY[2,3]) | {1,2,3} |
| anyarray | удаляет из массива все элементы, равные заданному значению (массив должен быть одномерным) | array_remove(ARRAY[1,2,3,2], 2) | {1,3} |
| anyarray | заменяет в массиве все элементы, равные заданному значению, другим значением | array_replace(ARRAY[1,2,5,4], 5, 3) | {1,2,3,4} |
| text | выводит элементы массива через заданный разделитель и позволяет определить замену для значения NULL | array_to_string(ARRAY[1, 2, 3, NULL, 5], ',', '*') | 1,2,3,*,5 |
| int | возвращает верхнюю границу указанной размерности массива | array_upper(ARRAY[1,8,3,7], 1) | 4 |
| int | возвращает общее число элементов в массиве, либо 0, если массив пуст | cardinality(ARRAY[[1,2],[3,4]]) | 4 |
| text[] | разбивает строку на элементы массива, используя заданный разделитель и, возможно, замену для значений NULL | string_to_array('xx~^~yy~^~zz', '~^~', 'yy') | {xx,NULL,zz} |
| setof anyelement | разворачивает массив в набор строк | unnest(ARRAY[1,2]) | 1 2(2 строки) |
| setof anyelement, anyelement [, ...] | разворачивает массивы (возможно разных типов) в набор строк. Это допускается только в предложении FROM; см. Подраздел 7.2.1.4 | unnest(ARRAY[1,2],ARRAY['foo','bar','baz']) | 1 foo 2 bar NULL baz(3 строки) |
В функциях array_position и array_positions каждый элемент массива сравнивается с искомым значением по принципу IS NOT DISTINCT FROM.
Функция array_position возвращает NULL, если искомое значение не находится.
Функция array_positions возвращает NULL, только если в качестве массива передаётся NULL; если же в массиве не находится значение, она возвращает пустой массив.
Если для функции string_to_array в качестве разделителя задан NULL, каждый символ входной строки станет отдельным элементом в полученном массиве. Если разделитель пустая строка, строка будет возвращена целиком в массиве из одного элемента. В противном случае входная строка разбивается по вхождениям подстроки, указанной в качестве разделителя.
Если для функции string_to_array параметр замены значения NULL опущен или равен NULL, никакие подстроки во входных данных не будут заменяться на NULL. Если же параметр замены NULL опущен или равен NULL для функции array_to_string, все значения NULL просто пропускаются и никак не представляются в выходной строке.
Примечание
В поведении string_to_array по сравнению с PostgreSQL версий до 9.1 произошли два изменения. Во-первых, эта функция возвращает пустой массив (содержащий 0 элементов), а не NULL, когда входная строка имеет нулевую длину. Во-вторых, если в качестве разделителя задан NULL, эта функция разбивает строку по символам, а не просто возвращает NULL, как было раньше.
Вы также можете узнать об агрегатной функции, работающей с массивами, array_agg в Разделе 9.20.
9.18. Array Functions and Operators
Table 9.47 shows the operators available for array types.
Table 9.47. Array Operators
| Operator | Description | Example | Result |
|---|---|---|---|
= | equal | ARRAY[1.1,2.1,3.1]::int[] = ARRAY[1,2,3] | t |
<> | not equal | ARRAY[1,2,3] <> ARRAY[1,2,4] | t |
< | less than | ARRAY[1,2,3] < ARRAY[1,2,4] | t |
> | greater than | ARRAY[1,4,3] > ARRAY[1,2,4] | t |
<= | less than or equal | ARRAY[1,2,3] <= ARRAY[1,2,3] | t |
>= | greater than or equal | ARRAY[1,4,3] >= ARRAY[1,4,3] | t |
@> | contains | ARRAY[1,4,3] @> ARRAY[3,1,3] | t |
<@ | is contained by | ARRAY[2,2,7] <@ ARRAY[1,7,4,2,6] | t |
&& | overlap (have elements in common) | ARRAY[1,4,3] && ARRAY[2,1] | t |
|| | array-to-array concatenation | ARRAY[1,2,3] || ARRAY[4,5,6] | {1,2,3,4,5,6} |
|| | array-to-array concatenation | ARRAY[1,2,3] || ARRAY[[4,5,6],[7,8,9]] | {{1,2,3},{4,5,6},{7,8,9}} |
|| | element-to-array concatenation | 3 || ARRAY[4,5,6] | {3,4,5,6} |
|| | array-to-element concatenation | ARRAY[4,5,6] || 7 | {4,5,6,7} |
The array ordering operators (<, >=, etc) compare the array contents element-by-element, using the default B-tree comparison function for the element data type, and sort based on the first difference. In multidimensional arrays the elements are visited in row-major order (last subscript varies most rapidly). If the contents of two arrays are equal but the dimensionality is different, the first difference in the dimensionality information determines the sort order. (This is a change from versions of PostgreSQL prior to 8.2: older versions would claim that two arrays with the same contents were equal, even if the number of dimensions or subscript ranges were different.)
The array containment operators (<@ and @>) consider one array to be contained in another one if each of its elements appears in the other one. Duplicates are not treated specially, thus ARRAY[1] and ARRAY[1,1] are each considered to contain the other.
See Section 8.15 for more details about array operator behavior. See Section 11.2 for more details about which operators support indexed operations.
Table 9.48 shows the functions available for use with array types. See Section 8.15 for more information and examples of the use of these functions.
Table 9.48. Array Functions
| Function | Return Type | Description | Example | Result |
|---|---|---|---|---|
| anyarray | append an element to the end of an array | array_append(ARRAY[1,2], 3) | {1,2,3} |
| anyarray | concatenate two arrays | array_cat(ARRAY[1,2,3], ARRAY[4,5]) | {1,2,3,4,5} |
| int | returns the number of dimensions of the array | array_ndims(ARRAY[[1,2,3], [4,5,6]]) | 2 |
| text | returns a text representation of array's dimensions | array_dims(ARRAY[[1,2,3], [4,5,6]]) | [1:2][1:3] |
| anyarray | returns an array initialized with supplied value and dimensions, optionally with lower bounds other than 1 | array_fill(7, ARRAY[3], ARRAY[2]) | [2:4]={7,7,7} |
| int | returns the length of the requested array dimension | array_length(array[1,2,3], 1) | 3 |
| int | returns lower bound of the requested array dimension | array_lower('[0:2]={1,2,3}'::int[], 1) | 0 |
| int | returns the subscript of the first occurrence of the second argument in the array, starting at the element indicated by the third argument or at the first element (array must be one-dimensional) | array_position(ARRAY['sun','mon','tue','wed','thu','fri','sat'], 'mon') | 2 |
| int[] | returns an array of subscripts of all occurrences of the second argument in the array given as first argument (array must be one-dimensional) | array_positions(ARRAY['A','A','B','A'], 'A') | {1,2,4} |
| anyarray | append an element to the beginning of an array | array_prepend(1, ARRAY[2,3]) | {1,2,3} |
| anyarray | remove all elements equal to the given value from the array (array must be one-dimensional) | array_remove(ARRAY[1,2,3,2], 2) | {1,3} |
| anyarray | replace each array element equal to the given value with a new value | array_replace(ARRAY[1,2,5,4], 5, 3) | {1,2,3,4} |
| text | concatenates array elements using supplied delimiter and optional null string | array_to_string(ARRAY[1, 2, 3, NULL, 5], ',', '*') | 1,2,3,*,5 |
| int | returns upper bound of the requested array dimension | array_upper(ARRAY[1,8,3,7], 1) | 4 |
| int | returns the total number of elements in the array, or 0 if the array is empty | cardinality(ARRAY[[1,2],[3,4]]) | 4 |
| text[] | splits string into array elements using supplied delimiter and optional null string | string_to_array('xx~^~yy~^~zz', '~^~', 'yy') | {xx,NULL,zz} |
| setof anyelement | expand an array to a set of rows | unnest(ARRAY[1,2]) | 1 2(2 rows) |
| setof anyelement, anyelement [, ...] | expand multiple arrays (possibly of different types) to a set of rows. This is only allowed in the FROM clause; see Section 7.2.1.4 | unnest(ARRAY[1,2],ARRAY['foo','bar','baz']) | 1 foo 2 bar NULL baz(3 rows) |
In array_position and array_positions, each array element is compared to the searched value using IS NOT DISTINCT FROM semantics.
In array_position, NULL is returned if the value is not found.
In array_positions, NULL is returned only if the array is NULL; if the value is not found in the array, an empty array is returned instead.
In string_to_array, if the delimiter parameter is NULL, each character in the input string will become a separate element in the resulting array. If the delimiter is an empty string, then the entire input string is returned as a one-element array. Otherwise the input string is split at each occurrence of the delimiter string.
In string_to_array, if the null-string parameter is omitted or NULL, none of the substrings of the input will be replaced by NULL. In array_to_string, if the null-string parameter is omitted or NULL, any null elements in the array are simply skipped and not represented in the output string.
Note
There are two differences in the behavior of string_to_array from pre-9.1 versions of PostgreSQL. First, it will return an empty (zero-element) array rather than NULL when the input string is of zero length. Second, if the delimiter string is NULL, the function splits the input into individual characters, rather than returning NULL as before.
See also Section 9.20 about the aggregate function array_agg for use with arrays.
