Перейти к основному содержимому
Перейти к основному содержимому

Именованные коллекции

Not supported in ClickHouse Cloud

Именованные коллекции предоставляют возможность хранения коллекций пар ключ-значение, которые можно использовать для настройки интеграций с внешними источниками. Вы можете использовать именованные коллекции с словарями, таблицами, табличными функциями и объектным хранилищем.

Именованные коллекции могут быть настроены с помощью DDL или в файлах конфигурации и применяются при запуске ClickHouse. Они упрощают создание объектов и скрытие учетных данных от пользователей без административного доступа.

Ключи в именованной коллекции должны соответствовать именам параметров соответствующей функции, движка таблицы, базы данных и т. д. В примерах ниже список параметров связан с каждым типом.

Параметры, заданные в именованной коллекции, могут быть переопределены в SQL, это показано в примерах ниже. Эта возможность может быть ограничена с помощью ключевых слов [NOT] OVERRIDABLE и XML-атрибутов и/или параметра конфигурации allow_named_collection_override_by_default.

предупреждение

Если переопределение разрешено, пользователи без административного доступа могут выяснить учетные данные, которые вы пытаетесь скрыть. Если вы используете именованные коллекции с этой целью, вы должны отключить allow_named_collection_override_by_default (по умолчанию включен).

Хранение именованных коллекций в системной базе данных​

Пример 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 хеша пароля. Эта конфигурация для пользователя default имеет атрибут replace=true, так как в конфигурации по умолчанию установлен открытый текст password, и невозможно установить одновременно открытый текст и sha256 hex пароли для пользователя.

Хранение именованных коллекций​

Именованные коллекции могут храниться либо на локальном диске, либо в ZooKeeper/Keeper. По умолчанию используется локальное хранилище. Они также могут храниться с использованием шифрования теми же алгоритмами, что и шифрование диска, где по умолчанию используется aes_128_ctr.

Чтобы настроить хранилище именованных коллекций, необходимо указать type. Это может быть либо local, либо keeper/zookeeper. Для зашифрованного хранилища можно использовать local_encrypted или keeper_encrypted/zookeeper_encrypted.

Для использования ZooKeeper/Keeper также необходимо настроить path (путь в ZooKeeper/Keeper, где именованные коллекции будут храниться) в разделе named_collections_storage файла конфигурации. Следующий пример использует шифрование и 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​

Измените или добавьте ключи key1 и key3 коллекции collection2 (это не изменит значение флага overridable для этих ключей):

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

Измените или добавьте ключ key1 и разрешите его всегда переопределять:

ALTER NAMED COLLECTION collection2 SET key1=4 OVERRIDABLE

Удалите ключ key2 из collection2:

ALTER NAMED COLLECTION collection2 DELETE key2

Измените или добавьте ключ key1 и удалите ключ key3 коллекции collection2:

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 Table Function.

Пример 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 Table​

Оба следующих примера используют одну и ту же именованную коллекцию 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. Без именованных коллекций идентификатор ключа доступа, секрет, формат и URL передавались бы в каждом вызове функции s3().

Таблица 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​

Четыре следующих примера используют одну и ту же именованную коллекцию 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. Кроме того, есть псевдонимы:

  • username для user
  • db для database.

Параметр 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>

secure не нужен для подключения из-за remoteSecure, но его можно использовать для словарей.

Пример использования именованных коллекций с функциями 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​

Оба следующих примера используют одну и ту же именованную коллекцию 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 переопределяет настройку именованной коллекции для options.

Словарь 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', чтобы выбрать другую коллекцию.