ClickHouse/docs/ru/dicts/external_dicts_dict_structure.md

123 lines
4.4 KiB
Markdown
Raw Normal View History

<a name="dicts-external_dicts_dict_structure"></a>
# Ключ и поля словаря
Секция `<structure>` описывает ключ словаря и поля, доступные для запросов.
Общий вид структуры:
```xml
<dictionary>
<structure>
<id>
<name>Id</name>
</id>
<attribute>
<!-- Attribute parameters -->
</attribute>
...
</structure>
</dictionary>
```
В структуре описываются столбцы:
- `<id>` -[ключевой столбец](external_dicts_dict_structure.md#dicts-external_dicts_dict_structure-key).
- `<attribute>` -[столбец данных](external_dicts_dict_structure.md#dicts-external_dicts_dict_structure-attributes). Столбцов может быть много.
<a name="dicts-external_dicts_dict_structure-key"></a>
## Ключ
ClickHouse поддерживает следующие виды ключей:
- Числовой ключ. Формат UInt64. Описывается в теге `<id>`.
- Составной ключ. Набор значений разного типа. Описывается в теге `<key>`.
Структура может содержать либо `<id>` либо `<key>`.
<div class="admonition attention">
Ключ не надо дополнительно описывать в атрибутах.
</div>
### Числовой ключ
Формат: `UInt64`.
Пример конфигурации:
```xml
<id>
<name>Id</name>
</id>
```
Поля конфигурации:
- name - имя столбца с ключами.
### Составной ключ
Ключем может быть кортеж (`tuple`) из полей произвольных типов. [layout](external_dicts_dict_layout.md#dicts-external_dicts_dict_layout) в этом случае должен быть `complex_key_hashed` или `complex_key_cache`.
<div class="admonition tip">
Cоставной ключ может состоять и из одного элемента, что даёт возможность использовать в качестве ключа, например, строку.
</div>
Структура ключа задаётся в элементе `<key>`. Поля ключа задаются в том же формате, что и [атрибуты](external_dicts_dict_structure.md#dicts-external_dicts_dict_structure-attributes) словаря. Пример:
```xml
<structure>
<key>
<attribute>
<name>field1</name>
<type>String</type>
</attribute>
<attribute>
<name>field2</name>
<type>UInt32</type>
</attribute>
...
</key>
...
```
При запросе в функции `dictGet*` в качестве ключа передаётся кортеж. Пример: `dictGetString('dict_name', 'attr_name', tuple('string for field1', num_for_field2))`.
<a name="dicts-external_dicts_dict_structure-attributes"></a>
## Атрибуты
Пример конфигурации:
```xml
<structure>
...
<attribute>
<name>Name</name>
<type>Type</type>
<null_value></null_value>
<expression>rand64()</expression>
<hierarchical>true</hierarchical>
<injective>true</injective>
</attribute>
</structure>
```
Поля конфигурации:
- `name` - Имя столбца.
- `type` - Тип столбца. Задает способ интерпретации данных в источнике. Например, в случае MySQL, в таблице-источнике поле может быть `TEXT`, `VARCHAR`, `BLOB`, но загружено может быть как `String`.
- `null_value` - Значение по умолчанию для несуществующего элемента. В примере - пустая строка.
- `expression` - Атрибут может быть выражением. Тег не обязательный.
- `hierarchical` - Поддержка иерархии. Отображение в идентификатор родителя. По умолчанию, `false`.
- `injective` - Признак инъективности отображения `id -> attribute`. Если `true`, то можно оптимизировать `GROUP BY`. По умолчанию, `false`.