ClickHouse/docs/ru/query_language/functions/ext_dict_functions.md

Функции для работы с внешними словарями

Информацию о подключении и настройке внешних словарей смотрите в разделе Внешние словари.

dictGet

Извлекает значение из внешнего словаря.

dictGet('dict_name', 'attr_name', id_expr)
dictGetOrDefault('dict_name', 'attr_name', id_expr, default_value_expr)

Параметры

• dict_name — имя словаря. Строковый литерал.
• attr_name — имя столбца словаря. Строковый литерал.
• id_expr — значение ключа словаря. Выражение, возвращающее значение типа UInt64 или Tuple в зависимости от конфигурации словаря.
• default_value_expr — значение, возвращаемое в том случае, когда словарь не содержит строки с заданным ключем id_expr. Выражение возвращающее значение с типом данных, сконфигурированным для атрибута attr_name.

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

• Значение атрибута, соответствующее ключу id_expr, если ClickHouse смог привести это значение к заданному типу данных.

• Если ключа, соответствущего id_expr в словаре нет, то:

  • dictGet возвращает содержимое элемента <null_value>, указанного для атрибута в конфигурации словаря.
  • dictGetOrDefault возвращает атрибут default_value_expr.

Если значение атрибута не удалось обработать или оно не соответствует типу данных атрибута, то ClickHouse генерирует исключение.

Пример

Создадим текстовый файл ext-dict-text.csv со следующим содержимым:

1,1
2,2

Первый столбец — id, второй столбец — c1.

Настройка внешнего словаря:

<yandex>
    <dictionary>
        <name>ext-dict-test</name>
        <source>
            <file>
                <path>/path-to/ext-dict-test.csv</path>
                <format>CSV</format>
            </file>
        </source>
        <layout>
            <flat />
        </layout>
        <structure>
            <id>
                <name>id</name>
            </id>
            <attribute>
                <name>c1</name>
                <type>UInt32</type>
                <null_value></null_value>
            </attribute>
        </structure>
        <lifetime>0</lifetime>
    </dictionary>
</yandex>

Выполним запрос:

SELECT
    dictGetOrDefault('ext-dict-test', 'c1', number + 1, toUInt32(number * 10)) AS val,
    toTypeName(val) AS type
FROM system.numbers
LIMIT 3

┌─val─┬─type───┐
│   1 │ UInt32 │
│   2 │ UInt32 │
│  20 │ UInt32 │
└─────┴────────┘

Смотрите также

• Внешние словари

dictHas

Проверяет, присутствует ли ключ в словаре.

dictHas('dict_name', id)

Параметры

• dict_name — имя словаря. Строковый литерал.
• id_expr — значение ключа словаря. Выражение, возвращающее значение типа UInt64.

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

• 0, если ключа нет.
• 1, если ключ есть.

Тип — UInt8.

dictGetHierarchy

Для иерархического словаря возвращает массив ключей словаря, начиная с переданного id_expr и продолжая цепочкой родительских элементов.

dictGetHierarchy('dict_name', id)

Параметры

• dict_name — имя словаря. Строковый литерал.
• id_expr — значение ключа словаря. Выражение, возвращающее значение типа UInt64.

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

Иерархия ключей словаря.

Тип — Array(UInt64).

dictIsIn

Проверяет предка ключа в иерархическом словаре.

dictIsIn ('dict_name', child_id_expr, ancestor_id_expr)

Параметры

• dict_name — имя словаря. Строковый литерал.
• child_id_expr — ключ для проверки. Выражение, возвращающее значение типа UInt64.
• ancestor_id_expr — предполагаемый предок ключа child_id_expr. выражение, возвращающее значение типа UInt64.

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

• 0, если child_id_expr — не дочерний элемент ancestor_id_expr.
• 1, если child_id_expr — дочерний элемент ancestor_id_expr или если child_id_expr и есть ancestor_id_expr.

Тип — UInt8.

Прочие функции

ClickHouse поддерживает специализированные функции, которые приводят значения атрибутов справочника к определенному типу данных независимо от конфигурации справочника.

Функции:

• dictGetInt8, dictGetInt16, dictGetInt32, dictGetInt64
• dictGetUInt8, dictGetUInt16, dictGetUInt32, dictGetUInt64
• dictGetFloat32, dictGetFloat64
• dictGetDate
• dictGetDateTime
• dictGetUUID
• dictGetString

Все эти функции можно использовать с модификатором OrDefault. Например, dictGetDateOrDefault.

Синтаксис:

dictGet[Type]('dict_name', 'attr_name', id_expr)
dictGet[Type]OrDefault('dict_name', 'attr_name', id_expr, default_value_expr)

Параметры

• dict_name — имя словаря. Строковый литерал.
• attr_name — имя столбца словаря. Строковый литерал.
• id_expr — значение ключа словаря. Выражение, возвращающее значение типа UInt64.
• default_value_expr — значение, возвращаемое в том случае, когда словарь не содержит строки с заданным ключем id_expr. Выражение возвращающее значение с типом данных, сконфигурированным для атрибута attr_name.

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

• Если ClickHouse успешно обработал атрибут в соответствии с заданным типом данных, то функции возвращают значение атрибута, соответствующее ключу id_expr.

• Если запрошенного id_expr нет в словаре, то:

  • dictGet[Type] возвращает содержимое элемента <null_value>, указанного для атрибута в конфигурации словаря.
  • dictGet[Type]OrDefault возвращает аргумент default_value_expr.

Если значение атрибута не удалось обработать или оно не соответствует типу данных атрибута, то ClickHouse генерирует исключение.

Оригинальная статья