Перейти к основному содержимому
Версия: 5.0

Действия над индексами

Перемещение в ClickHouse

API для инициации перемещения указанного индекса: POST _ism/move_to_click/<index_name>.

Параметры в пути запроса

NameTypeDescription
index_namestringИмя индекса, который требуется перенести

Параметры в теле запроса

NameTypeDescription
connection_idstringИдентификатор соединения для подключения к ClickHouse, через которое будет производиться перемещение
index_name_patternstringШаблон в виде регулярного выражения для извлечения имени таблицы, обязательно содержащий именованную группу (?<name>)
fetch_sizeintegerРазмер пачки обрабатываемых документов. Рекомендуемое значение - от 10000 до 100000 в зависимости от размера документа
data_scheme_parametersobjectДополнительные настройки, влияющие на взаимодействие с таблицей в ClickHouse

Схема data_scheme_parameters

NameTypeDescription
ttl_intervalstringИнтервал времени жизни документов в таблице в формате interval <count> <time unit> Доступные интервалы (устанавливается на всю таблицу при создании)
ttl_columnstringИмя поля типа datetime, на основе которого будет высчитываться ttl
cluster_namestringИмя кластера ClickHouse (обязательное поле при replication = true или distributed = true)
replicationbooleanФлаг, отвечающий за создание реплицируемой таблицы при переливке (учитывается, если перемещение инициирует создание новой таблицы)
distributedbooleanФлаг, отвечающий за создание распределенной таблицы при переливки (учитывается, если перемещение инициирует создание новой таблицы)

Пример запроса

POST _ism/move_to_click/clickhouse_test-600006
{
"connection_id": "TestClick",
"index_name_pattern": "(?<name>.*?)-\\d+",
"fetch_size": 100000,
"data_scheme_parameters": {
"ttl_interval": "interval 30 day",
"cluster_name": "sm_cluster",
"replication": true,
"distributed": true
}
}