ClickHouse/docs/en/operations/table_engines/dictionary.md

109 lines
3.0 KiB
Markdown
Raw Normal View History

2018-03-25 02:04:22 +00:00
<a name="table_engines-dictionary"></a>
# Dictionary
The `Dictionary` engine displays the dictionary data as a ClickHouse table.
As an example, consider a dictionary of `products` with the following configuration:
```xml
<dictionaries>
<dictionary>
<name>products</name>
<source>
<odbc>
<table>products</table>
<connection_string>DSN=some-db-server</connection_string>
</odbc>
</source>
<lifetime>
<min>300</min>
<max>360</max>
</lifetime>
<layout>
<flat/>
</layout>
<structure>
<id>
<name>product_id</name>
</id>
<attribute>
<name>title</name>
<type>String</type>
<null_value></null_value>
</attribute>
</structure>
</dictionary>
</dictionaries>
```
Query the dictionary data:
```sql
select name, type, key, attribute.names, attribute.types, bytes_allocated, element_count,source from system.dictionaries where name = 'products';
2018-05-08 11:50:38 +00:00
SELECT
name,
type,
key,
attribute.names,
attribute.types,
bytes_allocated,
element_count,
2018-03-25 02:04:22 +00:00
source
2018-05-08 11:50:38 +00:00
FROM system.dictionaries
2018-03-25 02:04:22 +00:00
WHERE name = 'products'
```
2018-04-23 06:20:21 +00:00
2018-03-25 02:04:22 +00:00
```
┌─name─────┬─type─┬─key────┬─attribute.names─┬─attribute.types─┬─bytes_allocated─┬─element_count─┬─source──────────┐
│ products │ Flat │ UInt64 │ ['title'] │ ['String'] │ 23065376 │ 175032 │ ODBC: .products │
└──────────┴──────┴────────┴─────────────────┴─────────────────┴─────────────────┴───────────────┴─────────────────┘
```
You can use the [dictGet*](../../query_language/functions/ext_dict_functions.md#ext_dict_functions) function to get the dictionary data in this format.
2018-03-25 02:04:22 +00:00
This view isn't helpful when you need to get raw data, or when performing a `JOIN` operation. For these cases, you can use the `Dictionary` engine, which displays the dictionary data in a table.
Syntax:
```
CREATE TABLE %table_name% (%fields%) engine = Dictionary(%dictionary_name%)`
```
Usage example:
```sql
create table products (product_id UInt64, title String) Engine = Dictionary(products);
CREATE TABLE products
(
2018-05-08 11:50:38 +00:00
product_id UInt64,
title String,
2018-03-25 02:04:22 +00:00
)
ENGINE = Dictionary(products)
```
```
Ok.
0 rows in set. Elapsed: 0.004 sec.
```
Take a look at what's in the table.
```sql
select * from products limit 1;
SELECT *
2018-05-08 11:50:38 +00:00
FROM products
2018-03-25 02:04:22 +00:00
LIMIT 1
```
2018-05-08 11:50:38 +00:00
2018-03-25 02:04:22 +00:00
```
┌────product_id─┬─title───────────┐
2018-05-08 11:50:38 +00:00
│ 152689 │ Some item │
2018-03-25 02:04:22 +00:00
└───────────────┴─────────────────┘
2018-05-08 11:50:38 +00:00
1 rows in set. Elapsed: 0.006 sec.
2018-03-25 02:04:22 +00:00
```