Атрибуты словаря

Совет

Если вы используете словари с ClickHouse Cloud, используйте DDL-запрос для их создания и создавайте словари от имени пользователя default. Также проверьте список поддерживаемых источников словарей в руководстве по совместимости с ClickHouse Cloud.

Секция structure описывает ключ словаря и поля, доступные для запросов.

Описание в формате XML:

<dictionary>
    <structure>
        <id>
            <name>Id</name>
        </id>

        <attribute>
            <!-- Attribute parameters -->
        </attribute>

        ...

    </structure>
</dictionary>

Атрибуты задаются в элементах:

<id> — ключевой столбец
<attribute> — столбец данных: атрибутов может быть несколько.

DDL-запрос:

CREATE DICTIONARY dict_name (
    Id UInt64,
    -- attributes
)
PRIMARY KEY Id
...

Атрибуты описываются в теле запроса:

PRIMARY KEY — ключевой столбец
AttrName AttrType — столбец данных. Атрибутов может быть несколько.

Ключ

ClickHouse поддерживает следующие типы ключей:

Числовой ключ. UInt64. Задаётся в теге <id> или с помощью ключевого слова PRIMARY KEY.
Составной ключ. Набор значений разных типов. Задаётся в теге <key> или с помощью ключевого слова PRIMARY KEY.

XML-структура может содержать либо <id>, либо <key>. DDL-запрос должен содержать ровно один PRIMARY KEY.

Примечание

Нельзя описывать ключ как атрибут.

Числовой ключ

Тип: UInt64.

Пример конфигурации:

<id>
    <name>Id</name>
</id>

Поля конфигурации:

name – имя столбца, содержащего ключи.

Для DDL-запроса:

CREATE DICTIONARY (
    Id UInt64,
    ...
)
PRIMARY KEY Id
...

PRIMARY KEY – Имя столбца, содержащего ключи.

Составной ключ

Ключ может быть tuple из полей любых типов. layout в этом случае должен быть complex_key_hashed или complex_key_cache.

Совет

Составной ключ может состоять из одного элемента. Например, это позволяет использовать строку в качестве ключа.

Структура ключа задаётся в элементе <key>. Поля ключа указываются в том же формате, что и атрибуты словаря. Пример:

<structure>
    <key>
        <attribute>
            <name>field1</name>
            <type>String</type>
        </attribute>
        <attribute>
            <name>field2</name>
            <type>UInt32</type>
        </attribute>
        ...
    </key>
...

или

CREATE DICTIONARY (
    field1 String,
    field2 UInt32
    ...
)
PRIMARY KEY field1, field2
...

В запросе к функции dictGet* в качестве ключа передается кортеж. Пример: dictGetString('dict_name', 'attr_name', tuple('string for field1', num_for_field2)).