Перейти к содержимому
Последнее обновление

ARRAY_ENUMERATE

array_enumerate​

SinceVersion 2.0.0

Описание​

Возвращает индекс позиции (начиная с 1) для каждого элемента массива. Функция формирует соответствующие номера позиций для каждого элемента массива.

Синтаксис​

array_enumerate(ARRAY<T> arr)

Параметры​

  • arr:массив типа ARRAY, для которого нужно сформировать индексы позиций. Поддерживаются имена столбцов или константные значения.

Поддерживаемые типы T:

  • Числовые типы: TINYINT, SMALLINT, INT, BIGINT, LARGEINT, FLOAT, DOUBLE, DECIMAL
  • Строковые типы: CHAR, VARCHAR, STRING
  • Типы даты и времени: DATE, DATETIME, DATEV2, DATETIMEV2, TIMESTAMP_NS
  • Логический тип: BOOLEAN
  • Типы IP: IPV4, IPV6
  • UUID: UUID
  • Сложные типы: ARRAY, MAP, STRUCT

Возвращаемое значение​

Тип возвращаемого значения: ARRAY

Описание возвращаемого значения:

  • Возвращает новый массив той же длины, что и входной массив, в котором каждая позиция содержит индекс позиции (начиная с 1) соответствующего элемента исходного массива
  • NULL: если входной массив равен NULL

Примечания по использованию:

  • Функция формирует индексы позиций для каждого элемента массива, начиная с 1 и последовательно увеличивая их
  • Для пустых массивов возвращаются пустые массивы, для массивов со значением NULL возвращается NULL
  • Значения null в элементах массива: для элементов со значением null также формируются соответствующие индексы позиций

Примеры​

Примеры запросов:

Формирование индексов позиций для массива:

SELECT array_enumerate([1, 2, 1, 4, 5]);
+----------------------------------+
| array_enumerate([1, 2, 1, 4, 5]) |
+----------------------------------+
| [1, 2, 3, 4, 5] |
+----------------------------------+

Для пустого массива возвращается пустой массив:

SELECT array_enumerate([]);
+----------------------+
| array_enumerate([]) |
+----------------------+
| [] |
+----------------------+

Массив, содержащий значения null: для элементов со значением null также формируются индексы позиций:

SELECT array_enumerate([1, null, 3, null, 5]);
+--------------------------------------------+
| array_enumerate([1, null, 3, null, 5]) |
+--------------------------------------------+
| [1, 2, 3, 4, 5] |
+--------------------------------------------+

Примеры со сложными типами:

Вложенные массивы:

SELECT array_enumerate([[1,2],[3,4],[5,6]]);
+----------------------------------------+
| array_enumerate([[1,2],[3,4],[5,6]]) |
+----------------------------------------+
| [1, 2, 3] |
+----------------------------------------+

Типы Map:

SELECT array_enumerate([{'k':1},{'k':2},{'k':3}]);
+----------------------------------------------+
| array_enumerate([{'k':1},{'k':2},{'k':3}]) |
+----------------------------------------------+
| [1, 2, 3] |
+----------------------------------------------+

Типы Struct:

SELECT array_enumerate(array(named_struct('name','Alice','age',20),named_struct('name','Bob','age',30)));
+----------------------------------------------------------------------------------------+
| array_enumerate(array(named_struct('name','Alice','age',20),named_struct('name','Bob','age',30))) |
+----------------------------------------------------------------------------------------+
| [1, 2] |
+----------------------------------------------------------------------------------------+

Ошибка при неверном количестве параметров:

SELECT array_enumerate([1,2,3], [4,5,6]);
ERROR 1105 (HY000): errCode = 2, detailMessage = Can not found function 'array_enumerate' which has 2 arity. Candidate functions are: [array_enumerate(Expression)]

Ошибка при передаче значения, не являющегося массивом:

SELECT array_enumerate('not_an_array');
ERROR 1105 (HY000): errCode = 2, detailMessage = Can not find the compatibility function signature: array_enumerate(VARCHAR(12))

Ключевые слова​

ARRAY, ENUMERATE, ARRAY_ENUMERATE