メインコンテンツへスキップ
メインコンテンツへスキップ

名前付きコレクション

Not supported in ClickHouse Cloud

名前付きコレクションは、外部ソースとの連携設定に使用されるキーと値のペアの集合を保存するための仕組みです。名前付きコレクションは、dictionaries、テーブル、table functions、オブジェクトストレージで使用できます。

名前付きコレクションは DDL または設定ファイルで定義でき、ClickHouse の起動時に適用されます。これにより、オブジェクトの作成が簡素化され、管理権限を持たないユーザーから認証情報を隠すことができます。

名前付きコレクション内のキーは、対応する関数、テーブルエンジン、データベースなどのパラメータ名と一致している必要があります。以下の例では、各タイプごとにパラメータリストへのリンクを示しています。

名前付きコレクションで設定されたパラメータは SQL で上書き可能であり、その例を以下で示しています。この機能は、[NOT] OVERRIDABLE キーワードや XML 属性、および/または設定オプション allow_named_collection_override_by_default を使用して制限できます。

注記

上書きが許可されている場合、管理権限を持たないユーザーが、非表示にしようとしている認証情報を割り出せてしまう可能性があります。 その目的で名前付きコレクションを使用している場合は、デフォルトで有効になっている allow_named_collection_override_by_default を無効化する必要があります。

system データベースに名前付きコレクションを保存する​

DDLの例​

CREATE NAMED COLLECTION name AS
key_1 = 'value' OVERRIDABLE,
key_2 = 'value2' NOT OVERRIDABLE,
url = 'https://connection.url/'

上記の例では次のようになります。

  • key_1 は常に上書きできます。
  • key_2 は上書きすることはできません。
  • url は、allow_named_collection_override_by_default の値に応じて上書きできる場合とできない場合があります。

DDL で名前付きコレクションを作成するための権限​

DDL で名前付きコレクションを管理するには、ユーザーは named_collection_control 権限を持っている必要があります。これは /etc/clickhouse-server/users.d/ にファイルを追加することで付与できます。次の例では、ユーザー default に access_management と named_collection_control の両方の権限を付与しています。

<clickhouse>
  <users>
    <default>
      <password_sha256_hex>65e84be33532fb784c48129675f9eff3a682b27168c0ea744b2cf58ee02337c5</password_sha256_hex replace=true>
      <access_management>1</access_management>
      <!-- highlight-start -->
      <named_collection_control>1</named_collection_control>
      <!-- highlight-end -->
    </default>
  </users>
</clickhouse>
ヒント

上記の例では、password_sha256_hex の値は、パスワードの SHA256 ハッシュを 16 進数で表現したものです。ユーザー default 向けのこの設定では、デフォルト設定で平文の password が設定されているため、属性 replace=true を指定しています。同一ユーザーに対して、平文パスワードと SHA256 の 16 進数パスワードを同時に設定することはできません。

名前付きコレクションのストレージ​

名前付きコレクションはローカルディスクまたは ZooKeeper/Keeper に保存できます。デフォルトではローカルストレージが使用されます。 また、ディスク暗号化 と同じアルゴリズムを使用して暗号化して保存することもでき、その際にはデフォルトで aes_128_ctr が使用されます。

名前付きコレクションのストレージを構成するには、type を指定する必要があります。これは local または keeper/zookeeper のいずれかです。暗号化ストレージの場合は、 local_encrypted または keeper_encrypted/zookeeper_encrypted を使用できます。

ZooKeeper/Keeper を使用するには、構成ファイルの named_collections_storage セクションに path（名前付きコレクションを保存する ZooKeeper/Keeper 上のパス）も設定する必要があります。次の例は、暗号化と ZooKeeper/Keeper を併用しています。

<clickhouse>
  <named_collections_storage>
    <type>zookeeper_encrypted</type>
    <key_hex>bebec0cabebec0cabebec0cabebec0ca</key_hex>
    <algorithm>aes_128_ctr</algorithm>
    <path>/named_collections_path/</path>
    <update_timeout_ms>1000</update_timeout_ms>
  </named_collections_storage>
</clickhouse>

オプションの設定パラメーター update_timeout_ms のデフォルト値は 5000 です。

設定ファイルに名前付きコレクションを保存する​

XML の例​

<clickhouse>
     <named_collections>
        <name>
            <key_1 overridable="true">value</key_1>
            <key_2 overridable="false">value_2</key_2>
            <url>https://connection.url/</url>
        </name>
     </named_collections>
</clickhouse>

上記の例では：

  • key_1 は常に上書きできます。
  • key_2 は上書きすることはできません。
  • url は、allow_named_collection_override_by_default の値に応じて、上書きできる場合とできない場合があります。

名前付きコレクションの変更​

DDL クエリで作成された名前付きコレクションは、DDL によって変更または削除できます。XML ファイルで作成された名前付きコレクションは、対応する XML を編集または削除することで管理できます。

DDL で作成された名前付きコレクションを変更する​

コレクション collection2 のキー key1 と key3 を変更または追加します （この操作では、それらのキーに対する overridable フラグの値は変更されません）:

ALTER NAMED COLLECTION collection2 SET key1=4, key3='value3'

キー key1 を変更または追加し、常に上書き可能にします。

ALTER NAMED COLLECTION collection2 SET key1=4 OVERRIDABLE

collection2 からキー key2 を削除します：

ALTER NAMED COLLECTION collection2 DELETE key2

コレクション collection2 のキー key1 を追加または変更し、キー key3 を削除します。

ALTER NAMED COLLECTION collection2 SET key1=4, DELETE key3

キーに対して overridable フラグのデフォルト設定を強制的に使用させるには、 そのキーを一度削除してから再度追加する必要があります。

ALTER NAMED COLLECTION collection2 DELETE key1;
ALTER NAMED COLLECTION collection2 SET key1=4;

DDL の名前付きコレクション collection2 を削除:​

DROP NAMED COLLECTION collection2

S3 にアクセスするための名前付きコレクション​

パラメータの説明については、s3 テーブル関数を参照してください。

DDL の例​

CREATE NAMED COLLECTION s3_mydata AS
access_key_id = 'AKIAIOSFODNN7EXAMPLE',
secret_access_key = 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
format = 'CSV',
url = 'https://s3.us-east-1.amazonaws.com/yourbucket/mydata/'

XML の例​

<clickhouse>
    <named_collections>
        <s3_mydata>
            <access_key_id>AKIAIOSFODNN7EXAMPLE</access_key_id>
            <secret_access_key>wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY</secret_access_key>
            <format>CSV</format>
            <url>https://s3.us-east-1.amazonaws.com/yourbucket/mydata/</url>
        </s3_mydata>
    </named_collections>
</clickhouse>

s3() 関数と S3 テーブルの名前付きコレクションの例​

次の 2 つの例では、同じ名前付きコレクション s3_mydata を使用します。

s3() 関数​

INSERT INTO FUNCTION s3(s3_mydata, filename = 'test_file.tsv.gz',
   format = 'TSV', structure = 'number UInt64', compression_method = 'gzip')
SELECT * FROM numbers(10000);
ヒント

上記の s3() 関数の最初の引数には、コレクション名 s3_mydata を指定しています。名前付きコレクションを使用しない場合は、s3() 関数を呼び出すたびにアクセスキー ID、シークレット、フォーマット、URL をすべて渡す必要があります。

S3 テーブル​

CREATE TABLE s3_engine_table (number Int64)
ENGINE=S3(s3_mydata, url='https://s3.us-east-1.amazonaws.com/yourbucket/mydata/test_file.tsv.gz', format = 'TSV')
SETTINGS input_format_with_names_use_header = 0;

SELECT * FROM s3_engine_table LIMIT 3;
┌─number─┐
│      0 │
│      1 │
│      2 │
└────────┘

MySQL データベースにアクセスするための名前付きコレクション​

パラメータの説明については、mysql を参照してください。

DDL の例​

CREATE NAMED COLLECTION mymysql AS
user = 'myuser',
password = 'mypass',
host = '127.0.0.1',
port = 3306,
database = 'test',
connection_pool_size = 8,
replace_query = 1

XML の例​

<clickhouse>
    <named_collections>
        <mymysql>
            <user>myuser</user>
            <password>mypass</password>
            <host>127.0.0.1</host>
            <port>3306</port>
            <database>test</database>
            <connection_pool_size>8</connection_pool_size>
            <replace_query>1</replace_query>
        </mymysql>
    </named_collections>
</clickhouse>

mysql() 関数、MySQL テーブル、MySQL データベース、および Dictionary 名前付きコレクションの例​

以下の 4 つの例では、同じ名前付きコレクション mymysql を使用します。

mysql() 関数​

SELECT count() FROM mysql(mymysql, table = 'test');

┌─count()─┐
│       3 │
└─────────┘
注記

この名前付きコレクションでは table パラメータが指定されていないため、関数呼び出し時に table = 'test' として指定します。

MySQL テーブル​

CREATE TABLE mytable(A Int64) ENGINE = MySQL(mymysql, table = 'test', connection_pool_size=3, replace_query=0);
SELECT count() FROM mytable;

┌─count()─┐
│       3 │
└─────────┘
注記

この DDL ステートメントは、connection_pool_size に対する名前付きコレクションの設定を上書きします。

MySQL データベース​

CREATE DATABASE mydatabase ENGINE = MySQL(mymysql);

SHOW TABLES FROM mydatabase;

┌─name───┐
│ source │
│ test   │
└────────┘

MySQL 辞書​

CREATE DICTIONARY dict (A Int64, B String)
PRIMARY KEY A
SOURCE(MYSQL(NAME mymysql TABLE 'source'))
LIFETIME(MIN 1 MAX 2)
LAYOUT(HASHED());

SELECT dictGet('dict', 'B', 2);

┌─dictGet('dict', 'B', 2)─┐
│ two                     │
└─────────────────────────┘

PostgreSQL データベースへのアクセス用名前付きコレクション​

パラメータの説明については postgresql を参照してください。さらに、次のエイリアスがあります：

  • user のエイリアス: username
  • database のエイリアス: db

パラメータ addresses_expr は、コレクション内で host:port の代わりに使用されます。host、hostname、port といった他のパラメータが任意指定であるため、このパラメータも必須ではありません。以下の擬似コードは、その優先順位を説明しています：

CASE
    WHEN collection['addresses_expr'] != '' THEN collection['addresses_expr']
    WHEN collection['host'] != ''           THEN collection['host'] || ':' || if(collection['port'] != '', collection['port'], '5432')
    WHEN collection['hostname'] != ''       THEN collection['hostname'] || ':' || if(collection['port'] != '', collection['port'], '5432')
END

作成例：

CREATE NAMED COLLECTION mypg AS
user = 'pguser',
password = 'jw8s0F4',
host = '127.0.0.1',
port = 5432,
database = 'test',
schema = 'test_schema'

設定例：

<clickhouse>
    <named_collections>
        <mypg>
            <user>pguser</user>
            <password>jw8s0F4</password>
            <host>127.0.0.1</host>
            <port>5432</port>
            <database>test</database>
            <schema>test_schema</schema>
        </mypg>
    </named_collections>
</clickhouse>

PostgreSQL 関数で名前付きコレクションを使用する例​

SELECT * FROM postgresql(mypg, table = 'test');

┌─a─┬─b───┐
│ 2 │ two │
│ 1 │ one │
└───┴─────┘
SELECT * FROM postgresql(mypg, table = 'test', schema = 'public');

┌─a─┐
│ 1 │
│ 2 │
│ 3 │
└───┘

PostgreSQL エンジンを使用するデータベースで名前付きコレクションを利用する例​

CREATE TABLE mypgtable (a Int64) ENGINE = PostgreSQL(mypg, table = 'test', schema = 'public');

SELECT * FROM mypgtable;

┌─a─┐
│ 1 │
│ 2 │
│ 3 │
└───┘
注記

PostgreSQL は、テーブル作成時に名前付きコレクションからデータをコピーします。コレクションが変更されても、既存のテーブルには影響しません。

PostgreSQL エンジンを使用するデータベースで名前付きコレクションを使用する例​

CREATE DATABASE mydatabase ENGINE = PostgreSQL(mypg);

SHOW TABLES FROM mydatabase

┌─name─┐
│ test │
└──────┘

ソースに POSTGRESQL を使用する辞書での名前付きコレクションの使用例​

CREATE DICTIONARY dict (a Int64, b String)
PRIMARY KEY a
SOURCE(POSTGRESQL(NAME mypg TABLE test))
LIFETIME(MIN 1 MAX 2)
LAYOUT(HASHED());

SELECT dictGet('dict', 'b', 2);

┌─dictGet('dict', 'b', 2)─┐
│ two                     │
└─────────────────────────┘

リモート ClickHouse データベースにアクセスするための名前付きコレクション​

パラメータの説明については、remote を参照してください。

設定例：

CREATE NAMED COLLECTION remote1 AS
host = 'remote_host',
port = 9000,
database = 'system',
user = 'foo',
password = 'secret',
secure = 1

<clickhouse>
    <named_collections>
        <remote1>
            <host>remote_host</host>
            <port>9000</port>
            <database>system</database>
            <user>foo</user>
            <password>secret</password>
            <secure>1</secure>
        </remote1>
    </named_collections>
</clickhouse>

接続では remoteSecure を使用するため secure は不要ですが、ディクショナリには使用できます。

remote / remoteSecure 関数で名前付きコレクションを使用する例​

SELECT * FROM remote(remote1, table = one);
┌─dummy─┐
│     0 │
└───────┘

SELECT * FROM remote(remote1, database = merge(system, '^one'));
┌─dummy─┐
│     0 │
└───────┘

INSERT INTO FUNCTION remote(remote1, database = default, table = test) VALUES (1,'a');

SELECT * FROM remote(remote1, database = default, table = test);
┌─a─┬─b─┐
│ 1 │ a │
└───┴───┘

ClickHouse をソースとする辞書での名前付きコレクションの使用例​

CREATE DICTIONARY dict(a Int64, b String)
PRIMARY KEY a
SOURCE(CLICKHOUSE(NAME remote1 TABLE test DB default))
LIFETIME(MIN 1 MAX 2)
LAYOUT(HASHED());

SELECT dictGet('dict', 'b', 1);
┌─dictGet('dict', 'b', 1)─┐
│ a                       │
└─────────────────────────┘

Kafka へのアクセスに使用する名前付きコレクション​

パラメータの説明については Kafka を参照してください。

DDL の例​

CREATE NAMED COLLECTION my_kafka_cluster AS
kafka_broker_list = 'localhost:9092',
kafka_topic_list = 'kafka_topic',
kafka_group_name = 'consumer_group',
kafka_format = 'JSONEachRow',
kafka_max_block_size = '1048576';

XML の例​

<clickhouse>
    <named_collections>
        <my_kafka_cluster>
            <kafka_broker_list>localhost:9092</kafka_broker_list>
            <kafka_topic_list>kafka_topic</kafka_topic_list>
            <kafka_group_name>consumer_group</kafka_group_name>
            <kafka_format>JSONEachRow</kafka_format>
            <kafka_max_block_size>1048576</kafka_max_block_size>
        </my_kafka_cluster>
    </named_collections>
</clickhouse>

Kafka テーブルで名前付きコレクションを使用する例​

次の 2 つの例では、いずれも同じ名前付きコレクション my_kafka_cluster を使用します。

CREATE TABLE queue
(
    timestamp UInt64,
    level String,
    message String
)
ENGINE = Kafka(my_kafka_cluster)

CREATE TABLE queue
(
    timestamp UInt64,
    level String,
    message String
)
ENGINE = Kafka(my_kafka_cluster)
SETTINGS kafka_num_consumers = 4,
         kafka_thread_per_consumer = 1;

バックアップ用の名前付きコレクション​

パラメータの説明についてはバックアップとリストアを参照してください。

DDL の例​

BACKUP TABLE default.test to S3(named_collection_s3_backups, 'directory')

XML の例​

<clickhouse>
    <named_collections>
        <named_collection_s3_backups>
            <url>https://my-s3-bucket.s3.amazonaws.com/backup-S3/</url>
            <access_key_id>ABC123</access_key_id>
            <secret_access_key>Abc+123</secret_access_key>
        </named_collection_s3_backups>
    </named_collections>
</clickhouse>

MongoDB テーブルおよび辞書にアクセスするための名前付きコレクション​

パラメータの説明については mongodb を参照してください。

DDL の例​

CREATE NAMED COLLECTION mymongo AS
user = '',
password = '',
host = '127.0.0.1',
port = 27017,
database = 'test',
collection = 'my_collection',
options = 'connectTimeoutMS=10000'

XML の例​

<clickhouse>
    <named_collections>
        <mymongo>
            <user></user>
            <password></password>
            <host>127.0.0.1</host>
            <port>27017</port>
            <database>test</database>
            <collection>my_collection</collection>
            <options>connectTimeoutMS=10000</options>
        </mymongo>
    </named_collections>
</clickhouse>

MongoDB テーブル​

CREATE TABLE mytable(log_type VARCHAR, host VARCHAR, command VARCHAR) ENGINE = MongoDB(mymongo, options='connectTimeoutMS=10000&compressors=zstd')
SELECT count() FROM mytable;

┌─count()─┐
│       2 │
└─────────┘
注記

DDL は、オプションで指定した名前付きコレクションの設定を上書きします。

MongoDB 辞書​

CREATE DICTIONARY dict
(
    `a` Int64,
    `b` String
)
PRIMARY KEY a
SOURCE(MONGODB(NAME mymongo COLLECTION my_dict))
LIFETIME(MIN 1 MAX 2)
LAYOUT(HASHED())

SELECT dictGet('dict', 'b', 2);

┌─dictGet('dict', 'b', 2)─┐
│ two                     │
└─────────────────────────┘
注記

名前付きコレクションでは、コレクション名として my_collection を指定しています。関数呼び出しでは、別のコレクションを選択するために collection = 'my_dict' を指定してこれを上書きします。