2020-04-03 13:23:32 +00:00
---
2022-08-28 14:53:34 +00:00
slug: /en/sql-reference/dictionaries/external-dictionaries/external-dicts-dict
2022-04-09 13:29:05 +00:00
sidebar_position: 40
2022-11-02 19:47:11 +00:00
sidebar_label: Configuring a Dictionary
2020-04-03 13:23:32 +00:00
---
2022-11-15 17:44:54 +00:00
import CloudDetails from '@site/docs/en/sql-reference/dictionaries/external-dictionaries/_snippet_dictionary_in_cloud.md';
2020-04-03 13:23:32 +00:00
2022-11-02 19:47:11 +00:00
# Configuring a Dictionary
2017-12-28 15:13:23 +00:00
2022-11-15 17:44:54 +00:00
< CloudDetails / >
2022-11-02 21:40:55 +00:00
2020-02-20 06:31:06 +00:00
If dictionary is configured using xml file, than dictionary configuration has the following structure:
2017-12-28 15:13:23 +00:00
2020-03-20 10:10:48 +00:00
``` xml
2017-12-28 15:13:23 +00:00
< dictionary >
< name > dict_name< / name >
2019-11-13 15:50:09 +00:00
< structure >
<!-- Complex key configuration -->
< / structure >
2017-12-28 15:13:23 +00:00
< source >
<!-- Source configuration -->
< / source >
< layout >
<!-- Memory layout configuration -->
< / layout >
< lifetime >
<!-- Lifetime of dictionary in memory -->
< / lifetime >
< / dictionary >
```
2020-07-09 15:10:35 +00:00
Corresponding [DDL-query ](../../../sql-reference/statements/create/dictionary.md ) has the following structure:
2019-11-13 15:50:09 +00:00
2020-03-20 10:10:48 +00:00
``` sql
2019-11-13 15:50:09 +00:00
CREATE DICTIONARY dict_name
(
... -- attributes
)
PRIMARY KEY ... -- complex or single key configuration
SOURCE(...) -- Source configuration
LAYOUT(...) -- Memory layout configuration
LIFETIME(...) -- Lifetime of dictionary in memory
```
2020-03-21 04:11:51 +00:00
- `name` – The identifier that can be used to access the dictionary. Use the characters `[a-zA-Z0-9_\-]` .
2020-06-18 08:24:31 +00:00
- [source ](../../../sql-reference/dictionaries/external-dictionaries/external-dicts-dict-sources.md ) — Source of the dictionary.
- [layout ](../../../sql-reference/dictionaries/external-dictionaries/external-dicts-dict-layout.md ) — Dictionary layout in memory.
- [structure ](../../../sql-reference/dictionaries/external-dictionaries/external-dicts-dict-structure.md ) — Structure of the dictionary . A key and attributes that can be retrieved by this key.
- [lifetime ](../../../sql-reference/dictionaries/external-dictionaries/external-dicts-dict-lifetime.md ) — Frequency of dictionary updates.
2018-10-16 10:47:17 +00:00
2022-12-14 15:01:15 +00:00
## Related Content
- [Using dictionaries to accelerate queries ](https://clickhouse.com/blog/faster-queries-dictionaries-clickhouse )