mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-24 00:22:29 +00:00

DanRoscigno 726d3c0739 add slugs to all docs

2022-08-26 13:37:11 -04:00

18 KiB

Raw Blame History

slug	sidebar_position	sidebar_label
/ru/sql-reference/functions/ext-dict-functions	58	Функции для работы с внешними словарями

:::note "Внимание" Для словарей, созданных с помощью DDL-запросов, в параметре dict_name указывается полное имя словаря вместе с базой данных, например: <database>.<dict_name>. Если база данных не указана, используется текущая. :::

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

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

dictGet, dictGetOrDefault, dictGetOrNull

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

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

Аргументы

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

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

Значение атрибута, соответствующее ключу id_expr, если ClickHouse смог привести это значение к заданному типу данных.
Если ключа, соответствующего id_expr в словаре нет, то:
- dictGet возвращает содержимое элемента <null_value>, указанного для атрибута в конфигурации словаря.
- dictGetOrDefault возвращает атрибут default_value_expr.
- dictGetOrNull возвращает NULL в случае, если ключ не найден в словаре.

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

Пример с единственным атрибутом

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

1,1
2,2

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

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

<clickhouse>
    <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>
</clickhouse>

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

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 │
└─────┴────────┘

Пример с несколькими атрибутами

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

1,1,'1'
2,2,'2'
3,3,'3'

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

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

<clickhouse>
    <dictionary>
        <name>ext-dict-mult</name>
        <source>
            <file>
                <path>/path-to/ext-dict-mult.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>
            <attribute>
                <name>c2</name>
                <type>String</type>
                <null_value></null_value>
            </attribute>
        </structure>
        <lifetime>0</lifetime>
    </dictionary>
</clickhouse>

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

SELECT
    dictGet('ext-dict-mult', ('c1','c2'), number) AS val,
    toTypeName(val) AS type
FROM system.numbers
LIMIT 3;

┌─val─────┬─type──────────────────┐
│ (1,'1') │ Tuple(UInt8, String)  │
│ (2,'2') │ Tuple(UInt8, String)  │
│ (3,'3') │ Tuple(UInt8, String)  │
└─────────┴───────────────────────┘

Пример для словаря с диапазоном ключей

Создадим таблицу:

CREATE TABLE range_key_dictionary_source_table
(
    key UInt64,
    start_date Date,
    end_date Date,
    value String,
    value_nullable Nullable(String)
)
ENGINE = TinyLog();

INSERT INTO range_key_dictionary_source_table VALUES(1, toDate('2019-05-20'), toDate('2019-05-20'), 'First', 'First');
INSERT INTO range_key_dictionary_source_table VALUES(2, toDate('2019-05-20'), toDate('2019-05-20'), 'Second', NULL);
INSERT INTO range_key_dictionary_source_table VALUES(3, toDate('2019-05-20'), toDate('2019-05-20'), 'Third', 'Third');

Создадим внешний словарь:

CREATE DICTIONARY range_key_dictionary
(
    key UInt64,
    start_date Date,
    end_date Date,
    value String,
    value_nullable Nullable(String)
)
PRIMARY KEY key
SOURCE(CLICKHOUSE(HOST 'localhost' PORT tcpPort() TABLE 'range_key_dictionary_source_table'))
LIFETIME(MIN 1 MAX 1000)
LAYOUT(RANGE_HASHED())
RANGE(MIN start_date MAX end_date);

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

SELECT
    (number, toDate('2019-05-20')),
    dictHas('range_key_dictionary', number, toDate('2019-05-20')),
    dictGetOrNull('range_key_dictionary', 'value', number, toDate('2019-05-20')),
    dictGetOrNull('range_key_dictionary', 'value_nullable', number, toDate('2019-05-20')),
    dictGetOrNull('range_key_dictionary', ('value', 'value_nullable'), number, toDate('2019-05-20'))
FROM system.numbers LIMIT 5 FORMAT TabSeparated;

Результат:

(0,'2019-05-20')        0       \N      \N      (NULL,NULL)
(1,'2019-05-20')        1       First   First   ('First','First')
(2,'2019-05-20')        0       \N      \N      (NULL,NULL)
(3,'2019-05-20')        0       \N      \N      (NULL,NULL)
(4,'2019-05-20')        0       \N      \N      (NULL,NULL)

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

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

dictHas

Проверяет, присутствует ли запись с указанным ключом в словаре.

dictHas('dict_name', id)

Аргументы

dict_name — имя словаря. Строковый литерал.
id_expr — значение ключа словаря. Expression возвращает пару "ключ-значение" словаря или Tuple в зависимости от конфигурации словаря.

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

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

Тип: UInt8.

dictGetHierarchy

Создаёт массив, содержащий цепочку предков для заданного ключа в иерархическом словаре.

Синтаксис

dictGetHierarchy('dict_name', key)

Аргументы

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

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

Цепочка предков заданного ключа.

Type: 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.

dictGetChildren

Возвращает потомков первого уровня в виде массива индексов. Это обратное преобразование для dictGetHierarchy.

Синтаксис

dictGetChildren(dict_name, key)

Аргументы

dict_name — имя словаря. String literal.
key — значение ключа. Выражение, возвращающее значение типа UInt64.

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

Потомки первого уровня для ключа.

Тип: Array(UInt64).

Пример

Рассмотрим иерархический словарь:

┌─id─┬─parent_id─┐
│  1 │         0 │
│  2 │         1 │
│  3 │         1 │
│  4 │         2 │
└────┴───────────┘

Потомки первого уровня:

SELECT dictGetChildren('hierarchy_flat_dictionary', number) FROM system.numbers LIMIT 4;

┌─dictGetChildren('hierarchy_flat_dictionary', number)─┐
│ [1]                                                  │
│ [2,3]                                                │
│ [4]                                                  │
│ []                                                   │
└──────────────────────────────────────────────────────┘

dictGetDescendant

Возвращает всех потомков, как если бы функция dictGetChildren была выполнена level раз рекурсивно.

Синтаксис

dictGetDescendants(dict_name, key, level)

Аргументы

dict_name — имя словаря. String literal.
key — значение ключа. Выражение, возвращающее значение типа UInt64.
level — уровень иерархии. Если level = 0, возвращаются все потомки. UInt8.

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

Потомки для ключа.

Тип: Array(UInt64).

Пример

Рассмотрим иерархический словарь:

┌─id─┬─parent_id─┐
│  1 │         0 │
│  2 │         1 │
│  3 │         1 │
│  4 │         2 │
└────┴───────────┘

Все потомки:

SELECT dictGetDescendants('hierarchy_flat_dictionary', number) FROM system.numbers LIMIT 4;

┌─dictGetDescendants('hierarchy_flat_dictionary', number)─┐
│ [1,2,3,4]                                               │
│ [2,3,4]                                                 │
│ [4]                                                     │
│ []                                                      │
└─────────────────────────────────────────────────────────┘

Потомки первого уровня:

SELECT dictGetDescendants('hierarchy_flat_dictionary', number, 1) FROM system.numbers LIMIT 4;

┌─dictGetDescendants('hierarchy_flat_dictionary', number, 1)─┐
│ [1]                                                        │
│ [2,3]                                                      │
│ [4]                                                        │
│ []                                                         │
└────────────────────────────────────────────────────────────┘

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

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 или Tuple в зависимости от конфигурации словаря.
default_value_expr — значение, возвращаемое в том случае, когда словарь не содержит строки с заданным ключом id_expr. Выражение, возвращающее значение с типом данных, сконфигурированным для атрибута attr_name.

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

Если ClickHouse успешно обработал атрибут в соответствии с заданным типом данных, то функции возвращают значение атрибута, соответствующее ключу id_expr.
Если запрошенного id_expr нет в словаре, то:
- dictGet[Type] возвращает содержимое элемента <null_value>, указанного для атрибута в конфигурации словаря.
- dictGet[Type]OrDefault возвращает аргумент default_value_expr.

18 KiB Raw Blame History Unescape Escape

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

dictGet, dictGetOrDefault, dictGetOrNull

dictHas

dictGetHierarchy

dictIsIn

dictGetChildren

dictGetDescendant

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

18 KiB

Raw Blame History