ClickHouse/docs/ru/sql-reference/dictionaries/external-dictionaries/external-dicts-dict-structure.md

toc_priority	toc_title
44	Ключ и поля словаря

Ключ и поля словаря

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

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

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

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

        ...

    </structure>
</dictionary>

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

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

Создание словаря запросом:

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

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

• PRIMARY KEY — столбец с ключом
• AttrName AttrType — столбец данных. Можно задать несколько столбцов.

Ключ

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

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

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

!!! warning "Обратите внимание" Ключ не надо дополнительно описывать в атрибутах.

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

Тип: 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.

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

Структура ключа задаётся в элементе <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 String
    ...
)
PRIMARY KEY field1, field2
...

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

Атрибуты

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

<structure>
    ...
    <attribute>
        <name>Name</name>
        <type>ClickHouseDataType</type>
        <null_value></null_value>
        <expression>rand64()</expression>
        <hierarchical>true</hierarchical>
        <injective>true</injective>
        <is_object_id>true</is_object_id>
    </attribute>
</structure>

или

CREATE DICTIONARY somename (
    Name ClickHouseDataType DEFAULT '' EXPRESSION rand64() HIERARCHICAL INJECTIVE IS_OBJECT_ID
)

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

Тег	Описание	Обязательный
name	Имя столбца.	Да
type	Тип данных ClickHouse. ClickHouse пытается привести значение из словаря к заданному типу данных. Например, в случае MySQL, в таблице-источнике поле может быть TEXT, VARCHAR, BLOB, но загружено может быть как String. Nullable не поддерживается.	Да
null_value	Значение по умолчанию для несуществующего элемента. В примере это пустая строка. Нельзя указать значение NULL.	Да
expression	Выражение, которое ClickHouse выполняет со значением. Выражением может быть имя столбца в удаленной SQL базе. Таким образом, вы можете использовать его для создания псевдонима удаленного столбца. Значение по умолчанию: нет выражения.	Нет
hierarchical	Если true, то атрибут содержит ключ предка для текущего элемента. Смотрите Иерархические словари. Default value: false.	No
is_object_id	Признак того, что запрос выполняется к документу MongoDB по ObjectID. Значение по умолчанию: false.	Нет

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

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

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