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

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

Описание XML:

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

        <attribute>
            <!-- Параметры атрибута -->
        </attribute>

        ...

    </structure>
</dictionary>

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

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

DDL-запрос:

CREATE DICTIONARY dict_name (
    Id UInt64,
    -- атрибуты
)
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 из полей любых типов. Структура в этом случае должна быть 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>
...

or

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

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

Когда составной ключ состоит из одного атрибута, значение ключа можно передать напрямую, без обёртки в tuple. Например, допустимы оба варианта: dictGetString('dict_name', 'attr_name', 'key') и dictGetString('dict_name', 'attr_name', tuple('key')).

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

<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
)

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