メインコンテンツまでスキップ
メインコンテンツまでスキップ

CREATE DICTIONARY

Creates a new dictionary with given structure, source, layout and lifetime.

Syntax​

CREATE [OR REPLACE] DICTIONARY [IF NOT EXISTS] [db.]dictionary_name [ON CLUSTER cluster]
(
    key1 type1  [DEFAULT|EXPRESSION expr1] [IS_OBJECT_ID],
    key2 type2  [DEFAULT|EXPRESSION expr2],
    attr1 type2 [DEFAULT|EXPRESSION expr3] [HIERARCHICAL|INJECTIVE],
    attr2 type2 [DEFAULT|EXPRESSION expr4] [HIERARCHICAL|INJECTIVE]
)
PRIMARY KEY key1, key2
SOURCE(SOURCE_NAME([param1 value1 ... paramN valueN]))
LAYOUT(LAYOUT_NAME([param_name param_value]))
LIFETIME({MIN min_val MAX max_val | max_val})
SETTINGS(setting_name = setting_value, setting_name = setting_value, ...)
COMMENT 'Comment'

辞書の構造は属性で構成されます。辞書属性はテーブルカラムと同様に指定されます。必須の属性プロパティはその型のみで、他のプロパティはデフォルト値を持つことができます。

ON CLUSTER 句を使用すると、クラスター上で辞書を作成できます。詳細は Distributed DDL を参照してください。

辞書の layout に応じて、一つまたは複数の属性を辞書キーとして指定することができます。

SOURCE​

辞書のソースには以下が含まれます：

  • 現在の ClickHouse サービス内のテーブル
  • リモート ClickHouse サービス内のテーブル
  • HTTP(S) 経由で利用可能なファイル
  • 別のデータベース

Create a dictionary from a table in the current ClickHouse service​

入力テーブル source_table：

┌─id─┬─value──┐
│  1 │ First  │
│  2 │ Second │
└────┴────────┘

辞書を作成します：

CREATE DICTIONARY id_value_dictionary
(
    id UInt64,
    value String
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(TABLE 'source_table'))
LAYOUT(FLAT())
LIFETIME(MIN 0 MAX 1000)

辞書を出力します：

SHOW CREATE DICTIONARY id_value_dictionary;

CREATE DICTIONARY default.id_value_dictionary
(
    `id` UInt64,
    `value` String
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(TABLE 'source_table'))
LIFETIME(MIN 0 MAX 1000)
LAYOUT(FLAT())
注記

ClickHouse Cloud の SQL コンソールを使用する際には、辞書を作成する時にユーザー（default または default_role のロールを持つ他のユーザー）とパスワードを指定する必要があります。

CREATE USER IF NOT EXISTS clickhouse_admin
IDENTIFIED WITH sha256_password BY 'passworD43$x';

GRANT default_role TO clickhouse_admin;

CREATE DATABASE foo_db;

CREATE TABLE foo_db.source_table (
    id UInt64,
    value String
) ENGINE = MergeTree
PRIMARY KEY id;

CREATE DICTIONARY foo_db.id_value_dictionary
(
    id UInt64,
    value String
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(TABLE 'source_table' USER 'clickhouse_admin' PASSWORD 'passworD43$x' DB 'foo_db' ))
LAYOUT(FLAT())
LIFETIME(MIN 0 MAX 1000);

Create a dictionary from a table in a remote ClickHouse service​

入力テーブル（リモート ClickHouse サービス内） source_table：

┌─id─┬─value──┐
│  1 │ First  │
│  2 │ Second │
└────┴────────┘

辞書を作成します：

CREATE DICTIONARY id_value_dictionary
(
    id UInt64,
    value String
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(HOST 'HOSTNAME' PORT 9000 USER 'default' PASSWORD 'PASSWORD' TABLE 'source_table' DB 'default'))
LAYOUT(FLAT())
LIFETIME(MIN 0 MAX 1000)

Create a dictionary from a file available by HTTP(S)​

CREATE DICTIONARY default.taxi_zone_dictionary
(
    `LocationID` UInt16 DEFAULT 0,
    `Borough` String,
    `Zone` String,
    `service_zone` String
)
PRIMARY KEY LocationID
SOURCE(HTTP(URL 'https://datasets-documentation.s3.eu-west-3.amazonaws.com/nyc-taxi/taxi_zone_lookup.csv' FORMAT 'CSVWithNames'))
LIFETIME(MIN 0 MAX 0)
LAYOUT(HASHED())

Create a dictionary from another database​

詳細は Dictionary sources を参照してください。

See Also