Настройки ClickHouse®
Для кластера Managed Service for ClickHouse® можно задать настройки, которые относятся к ClickHouse®:
- Настройки на уровне сервера — задаются на уровне шарда или кластера. В пользовательской инсталляции ClickHouse® эти настройки меняются только через конфигурационные файлы, а в кластерах Managed Service for ClickHouse® — только через интерфейсы Yandex Cloud.
- Настройки на уровне запроса — задаются на уровне пользователя, сессии или запроса.
- Настройки квот — задаются на уровне пользователя.
Примечание
В ClickHouse® доступно больше настроек, чем поддержано в интерфейсах Yandex Cloud. С помощью SQL-запросов можно изменить произвольные настройки ClickHouse®, в том числе установить настройки ClickHouse® на уровне запроса или изменить настройки таблиц MergeTree.
Метки рядом с названием настройки позволяют определить, с помощью какого интерфейса задается значение этой настройки: консоль управления, CLI, API, SQL или Terraform. Метка Все интерфейсы
указывает, что поддерживаются все перечисленные интерфейсы.
В зависимости от выбранного интерфейса, одна и та же настройка будет представлена по-разному, например:
- Geobase uri в консоли управления соответствует:
geobase_uri
в gRPC API, Terraform;geobaseUri
в REST API;
- Allow DDL в консоли управления соответствует:
allow_ddl
в CLI, gRPC API, SQL;allowDdl
в REST API.
Настройки на уровне сервера
Доступны следующие настройки:
-
Asynchronous insert log enabled
Консоль управления
CLI
API
Определяет, будет ли логироваться информация об асинхронных вставках. Логи сохраняются в таблицу
system.asynchronous_insert_log
.По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Asynchronous insert log retention size
Консоль управления
CLI
API
Размер таблицы
system.asynchronous_insert_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
0
(старые записи при росте размера таблицы не удаляются). -
Asynchronous insert log retention time
Консоль управления
CLI
API
Время (в миллисекундах) от внесения записи в таблицу
system.asynchronous_insert_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Asynchronous metric log enabled
Консоль управления
CLI
API
Определяет, будут ли логироваться исторические значения метрик из таблицы
system.asynchronous_metrics
в таблицуsystem.asynchronous_metric_log
.По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Asynchronous metric log retention size
Консоль управления
CLI
API
Размер таблицы
system.asynchronous_metric_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
0
(старые записи при росте размера таблицы не удаляются). -
Asynchronous metric log retention time
Консоль управления
CLI
API
Время (в миллисекундах) от внесения записи в таблицу
system.asynchronous_metric_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Background buffer flush schedule pool size
Консоль управления
Количество потоков для выполнения фонового сброса данных в таблицах семейства Buffer
.Минимальное значение —
1
, по умолчанию —16
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background common pool size
Консоль управления
API
Количество потоков для выполнения фоновых неспециализированных операций, например, очистки файловой системы, в таблицах семейства MergeTree
.Минимальное значение —
1
, по умолчанию —8
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background distributed schedule pool size
Консоль управления
Количество потоков для выполнения фоновых операций в таблицах семейства Distributed
.Минимальное значение —
1
, по умолчанию —16
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background fetches pool size
Консоль управления
API
Количество потоков для выполнения фоновых задач копирования данных с реплики в таблицах семейства ReplicatedMergeTree
.Минимальное значение —
1
, по умолчанию —8
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background merges mutations concurrency ratio
Консоль управления
CLI
API
Количество фоновых слияний и мутаций, которые могут выполняться одновременно каждым потоком.
По умолчанию выбрано значение
2
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background message broker schedule pool size
Консоль управления
Количество потоков для выполнения фоновых трансляций сообщений. Новое значение настройки устанавливается при перезапуске сервера ClickHouse®.
Минимальное значение —
1
, по умолчанию —16
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background move pool size
Консоль управления
Количество потоков для фонового перемещения кусков данных в таблицах семейства MergeTree
.Минимальное значение —
1
, по умолчанию —8
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background pool size
Консоль управления
API
Terraform
Количество потоков для выполнения фоновых слияний и мутаций
в таблицах семейства MergeTree .Минимальное значение —
1
, по умолчанию —16
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Background schedule pool size
Консоль управления
API
Terraform
Количество потоков для выполнения фоновых задач. Применяется для реплицируемых таблиц, стримов в Apache Kafka® и обновления IP-адресов записей во внутреннем DNS-кеше.
Минимальное значение —
1
, по умолчанию —128
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Compression
Консоль управления
API
Terraform
Правила сжатия данных для таблиц семейства MergeTree
. Для каждого правила указываются:- Level — уровень сжатия. Доступен только для метода сжатия zstd
. Минимальное значение —1
, максимальное —12
, по умолчанию —9
. - Method — метод сжатия. Доступно два метода: LZ4
и zstd . - Min part size — минимальный размер куска данных
(в байтах). - Min part size ratio — отношение размера наименьшего куска таблицы к полному размеру таблицы. ClickHouse® будет применять правило только к тем таблицам, у которых это отношение не превышает значение Min part size ratio.
Вы можете добавить несколько правил сжатия. ClickHouse® проверит условия Min part size и Min part size ratio и применит правила к тем таблицам, для которых выполнены оба условия. Если к одной таблице подходит несколько правил, ClickHouse® применит первое из них. Если ни одно из правил не подходит, ClickHouse® применит метод сжатия LZ4
.Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
Подробнее см. в документации ClickHouse®
. - Level — уровень сжатия. Доступен только для метода сжатия zstd
-
Default database
Консоль управления
API
База данных по умолчанию. Инструкцию о получении списка баз данных в кластере см. в разделе Управление базами данных.
Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
-
Dictionaries lazy load
Консоль управления
CLI
Terraform
API
SQL
Если настройка включена, каждый словарь загружается при его первом использовании. Если загрузить не получилось, функция, использующая словарь, возвращает исключение.
Если настройка выключена, словари загружаются при запуске сервера. Сервер ожидает, пока загрузятся все словари, до того как начать обработку соединений.
По умолчанию настройка включена.
Подробнее см. в документации ClickHouse®
. -
Geobase enabled
Консоль управления
CLI
API
Включение встроенного словаря-геобазы.
По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Geobase uri
Консоль управления
CLI
API
Terraform
Адрес архива с пользовательской геобазой в Object Storage.
Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
-
Graphite rollup
Консоль управления
API
Terraform
Конфигурации движка GraphiteMergeTree
для прореживания и агрегирования (rollup) данных Graphite :- Name — имя конфигурации.
- Patterns — набор правил прореживания. Правило применяется, если имя метрики соответствует значению параметра Regexp, а возраст данных соответствует значению группы параметров Retention.
- Function — имя агрегирующей функции.
- Regexp — регулярное выражение, которому должно соответствовать имя метрики.
- Retention — параметры задержки. Функция применяется к данным, чей возраст оказался в интервале [Age, Age + Precision]. Вы можете задать несколько групп таких параметров.
- Age — минимальный возраст данных (в секундах).
- Precision — точность определения возраста данных (в секундах). Значение должно быть кратно
86400
(количеству секунд в сутках).
Вы можете настроить несколько конфигураций и использовать их для разных таблиц. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
Чтобы создавать таблицы семейства
GraphiteMergeTree
, укажите названия столбцов для каждой такой таблицы:- Path column name — столбец с именем метрики (сенсора
Graphite
). Значение по умолчанию —Path
. - Time column name — столбец со временем измерения метрики. Значение по умолчанию —
Time
. - Value column name — столбец со значением метрики. Значение по умолчанию —
Value
. - Version column name — столбец с версией метрики. Значение по умолчанию —
Timestamp
.
Подробнее о поддержке Graphite см. в документации ClickHouse®
. -
Kafka
Консоль управления
CLI
Terraform
Глобальные настройки аутентификации для интеграции с Apache Kafka®
:- Auto offset reset — начальная позиция, откуда начинается чтение сообщений потребителем. С этой позиции потребитель добавляет сдвиги для новых сообщений по мере того, как движется и читает поступаемые сообщения. Подробнее см. в документации Confluent
. - Debug — контекст для отладки. В нем можно указать только одно значение. Список доступных значений см. в документации библиотеки
librdkafka
на GitHub . - Enable ssl certificate verification — определяет, будет ли проводиться проверка SSL-сертификата. По умолчанию выбрано значение
false
. - Max poll interval ms — максимальный интервал (в миллисекундах) между вызовами для получения сообщений высокоуровневых потребителей. При превышении интервала пользователь удаляется из группы и запускается перебалансировка. По умолчанию выбрано значение
300000
(5 минут). - Sasl mechanism — механизм аутентификации SASL:
GSSAPI
— аутентификация с использованием Kerberos .PLAIN
— аутентификация с использованием пары логин-пароль в виде открытого текста .SCRAM-SHA-256
иSCRAM-SHA-512
— аутентификация с использованием механизмов семейства SCRAM .
- Sasl password — пароль учетной записи Apache Kafka®.
- Sasl username — имя учетной записи Apache Kafka®.
- Security protocol — протокол безопасности для использования при аутентификации:
PLAINTEXT
— данные для аутентификации передаются в открытом виде.SSL
— данные для аутентификации передаются в зашифрованном виде с помощью SSL.SASL_PLAINTEXT
— данные для аутентификации передаются в открытом виде, в качестве транспорта используется SASL.SASL_SSL
— данные для аутентификации передаются в зашифрованном виде с помощью SSL, в качестве транспорта используется SASL.
- Session timeout ms — время ожидания (в миллисекундах) периодического сигнала от пользователя для поддержки сессии клиентской группы. При превышении времени брокер удаляет пользователя из группы и запускает перебалансировку. По умолчанию выбрано значение
45000
(45 секунд).
Изменение настроек приводит к перезапуску серверов ClickHouse® на хостах кластера.
- Auto offset reset — начальная позиция, откуда начинается чтение сообщений потребителем. С этой позиции потребитель добавляет сдвиги для новых сообщений по мере того, как движется и читает поступаемые сообщения. Подробнее см. в документации Confluent
-
Kafka topics
Консоль управления
CLI
Terraform
Настройки аутентификации на уровне топиков для интеграции с Apache Kafka®
:-
Name — имя топика Apache Kafka®.
-
Settings — настройки аутентификации для топика, аналогичные глобальным настройкам аутентификации в секции Kafka.
Если для таблицы на движке Kafka настройки аутентификации на уровне топика не заданы, то будут использованы глобальные настройки из секции Kafka.
Изменение настроек приводит к перезапуску серверов ClickHouse® на хостах кластера.
Подробнее см. в документации Apache Kafka®
.
-
-
Keep alive timeout
Консоль управления
CLI
API
Terraform
Время (в секундах) от поступления последнего запроса к ClickHouse® до разрыва соединения. Если за это время поступает новый запрос, соединение не разрывается.
По умолчанию выбрано значение
3
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Log level
Консоль управления
CLI
API
Terraform
Уровень логирования событий. На каждом следующем уровне лог будет содержать всю информацию из предыдущего:
ERROR
— информация об ошибках в работе кластера;WARNING
— информация о событиях, которые могут привести к ошибкам в работе кластера;INFORMATION
— подтверждения, информация о событиях, не приводящих к ошибкам в работе кластера;DEBUG
— системная информация для последующего использования в отладке;TRACE
— вся доступная информация о работе кластера.
Подробнее об уровнях логирования см. в документации ClickHouse®
. -
Mark cache size
Консоль управления
CLI
API
Terraform
Приблизительный размер (в байтах) кеша засечек, используемых движками таблиц семейства MergeTree
. Кеш общий для хоста кластера, память выделяется по мере необходимости.Выбранное значение настройки не является строгим ограничением. ClickHouse® может использовать чуть меньше или чуть больше памяти под этот кеш.
По умолчанию выбрано значение
5368709120
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Max concurrent queries
Консоль управления
CLI
API
Terraform
Максимальное количество одновременно обрабатываемых запросов.
Минимальное значение —
10
, по умолчанию —500
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Max connections
Консоль управления
CLI
API
Terraform
Максимальное количество входящих клиентских соединений. Настройка не учитывает служебные соединения, которые открываются для выполнения распределенных подзапросов.
Минимальное значение —
10
, по умолчанию —4096
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Max partition size to drop
Консоль управления
CLI
API
Terraform
Максимальный размер (в байтах) партиции
таблицы семейства MergeTree , при котором таблицу можно удалить с помощью запросаDROP TABLE
. Настройку можно использовать, чтобы предотвратить ошибочное удаление таблиц с реальными данными: такие таблицы обычно имеют большой размер по сравнению с тестовыми таблицами.По умолчанию выбрано значение
53687091200
(50 ГБ). При значении0
можно удалять таблицы любого размера. -
Max table size to drop
Консоль управления
CLI
API
Terraform
Максимальный размер (в байтах) таблицы семейства MergeTree
, которую можно удалить с помощью запросаDROP TABLE
. Настройку можно использовать, чтобы предотвратить ошибочное удаление таблиц с реальными данными: такие таблицы обычно имеют большой размер по сравнению с тестовыми таблицами.По умолчанию выбрано значение
53687091200
(50 ГБ). При значении0
можно удалять таблицы любого размера. -
Merge tree
Консоль управления
CLI
API
Terraform
Конфигурация движка MergeTree:
-
Allow remote fs zero copy replication — определяет, разрешена ли удаленная репликация с нулевой копией для S3 и HDFS-дисков.
По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Check sample column is correct — при создании таблицы включает проверку, что тип данных столбца является верным для сэмплирования или выражений сэмплирования.
По умолчанию проверка включена. Вы можете ее отключить, если у вас уже есть таблицы с некорректными выражениями сэмплирования. Тогда не будет возникать ложных срабатываний и исключений при запуске сервера.
Подробнее см. в документации ClickHouse®
. -
Cleanup delay period — интервал времени (в секундах) между запусками распределенных DDL-запросов
для очистки устаревших данных.По умолчанию выбрано значение
60
(1 минута). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Inactive parts to delay insert — количество неактивных кусков данных таблицы, при превышении которого ClickHouse® будет искусственно уменьшать скорость вставки данных в таблицу.
По умолчанию ограничение скорости выключено (
0
). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Inactive parts to throw insert — количество неактивных кусков данных таблицы, при превышении которого ClickHouse® отправляет исключение
Too many inactive parts ...
.По умолчанию отправка исключений выключена (
0
). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Max avg part size for too many parts — максимальный средний размер активных кусков данных таблицы (в байтах) для выполнения проверок Parts to delay insert и Parts to throw insert. При превышении указанного значения вставки данных в таблицу не будут замедлены или отклонены.
Минимальное значение —
0
, по умолчанию —1073741824
(1 ГБ). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Max bytes to merge at max space in pool — максимальный общий размер кусков данных (в байтах) для слияния, когда в фоновом пуле есть свободные ресурсы.
По умолчанию выбрано значение
161061273600
(150 ГБ). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Max bytes to merge at min space in pool — максимальный общий размер кусков данных для слияния, когда в фоновом пуле минимум свободных ресурсов.
По умолчанию выбрано значение
1048576
(1 МБ). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Max cleanup delay period — максимальный период в секундах для очистки устаревших данных: логов запросов, хешей блоков и кусков данных.
Укажите значение не меньше, чем у настройки Cleanup delay period.
Значение по умолчанию —
300
. -
Max merge selecting sleep ms — максимальное время ожидания для слияния выборки (в миллисекундах).
Укажите значение не меньше, чем у настройки Merge selecting sleep ms.
Значение по умолчанию —
60000
(1 минута). Если указать меньшее значение, задачи выборки будут часто запускаться в пуле фоновых задач. В результате в кластерах с большими мощностями скопится большое количество запросов к ZooKeeper. -
Max number of merges with ttl in pool — предельное количество слияний по TTL в фоновом пуле.
По умолчанию выбрано значение
2
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Max parts in total — количество активных кусков данных во всех партициях таблицы, при превышении которого ClickHouse® отправляет исключение
Too many parts ...
.По умолчанию выбрано значение
100000
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Max replicated merges in queue — максимальное количество задач слияния, которые могут одновременно находиться в очереди
ReplicatedMergeTree
.По умолчанию выбрано значение
16
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Merge max block size — из скольки строк состоят блоки, которые формируют объединяемые куски данных.
База данных читает строки из этих кусков, затем объединяет эти строки и записывает их в новый кусок. Читаемые строки помещаются в оперативную память (RAM), поэтому настройка влияет на ее размер, необходимый для слияния строк. Если уменьшить значение настройки, сократится допустимый размер RAM, и слияние строк замедлится.
Значение по умолчанию —
8192
.Подробнее см. в документации ClickHouse®
. -
Merge selecting sleep ms — время ожидания (в миллисекундах) для слияния выборки, если ни один кусок не выбран.
По умолчанию выбрано значение
5000
(5 секунд). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Merge with recompression TTL timeout — минимальное время (в секундах) между слияниями для повторного сжатия данных с истекшим TTL.
По умолчанию выбрано значение
14400
(4 часа). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Merge with TTL timeout — минимальное время (в секундах) между слияниями для удаления данных с истекшим TTL.
По умолчанию выбрано значение
14400
(4 часа). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Min age to force merge on partition only — определяет, применять ли объединение из настройки Min age to force merge seconds только к партициям
.По умолчанию применение только к партициям отключено. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
Подробнее см. в документации ClickHouse®
. -
Min age to force merge seconds — минимальное время (в секундах) существования кусков данных для объединения.
По умолчанию выбрано значение
0
(объединение отключено). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Min bytes for wide part — минимальное количество байтов в куске данных, который может храниться в формате
Wide
. Можно задать одновременно с параметром Min rows for wide part.Если количество байтов в куске данных меньше заданного значения, тогда этот кусок данных хранится в формате
Compact
.Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
Подробнее см. в документации ClickHouse®
. -
Min rows for wide part — минимальное количество строк в куске данных, который может храниться в формате
Wide
. Можно задать одновременно с параметром Min bytes for wide part.Если количество строк в куске данных меньше заданного значения, тогда этот кусок данных хранится в формате
Compact
.Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
Подробнее см. в документации ClickHouse®
. -
Number of free entries in pool to execute mutation — предельное значение свободных записей в пуле. Если количество записей в пуле становится меньше этого значения, ClickHouse® перестает выполнять операции мутаций
. Это позволяет оставлять свободные потоки для слияний и избежать исключенияToo many parts ...
.По умолчанию выбрано значение
20
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Number of free entries in pool to lower max size of merge — предельное значение свободных записей в пуле. Если количество записей в пуле становится меньше этого значения, ClickHouse® уменьшает максимальный размер куска данных для слияния. Это позволяет быстрее обрабатывать небольшие слияния.
По умолчанию выбрано значение
8
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Parts to delay insert — количество активных кусков данных таблицы, при превышении которого ClickHouse® будет искусственно уменьшать скорость вставки данных в таблицу. Активным куском является новый кусок данных, образованный в результате слияния.
По умолчанию выбрано значение
150
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Parts to throw insert — предельное число активных кусков данных таблицы, при превышении которого ClickHouse® отправляет исключение
Too many parts ...
По умолчанию выбрано значение
300
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Replicated deduplication window — число блоков последних вставок хешей, которые ZooKeeper будет хранить. Дедупликация работает только для последних вставленных данных. Старые блоки будут удалены.
По умолчанию выбрано значение
100
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Replicated deduplication window seconds — время, в течение которого ZooKeeper хранит блоки последних вставок хешей. Дедупликация работает только для последних вставленных данных. Старые блоки будут удалены.
По умолчанию выбрано значение
604800
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
TTL only drop parts — определяет режим удаления данных по TTL:
true
— целыми кусками данных.false
— построчно, с выполнением дополнительных слияний данных. Этот режим потребляет значительно больше ресурсов, чем удаление целыми кусками.
По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
.
-
-
Metric log enabled
Консоль управления
CLI
Terraform
Определяет, будут ли логироваться значения метрик из таблиц
system.metrics
иsystem.events
в таблицуsystem.metric_log
.По умолчанию выбрано значение
true
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Metric log retention size
Консоль управления
CLI
Terraform
Размер таблицы
system.metric_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
536870912
(0,5 ГБ). При значении0
старые записи не будут удаляться при росте размера таблицы. -
Metric log retention time
Консоль управления
CLI
Terraform
Время (в миллисекундах) от внесения записи в таблицу
system.metric_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Opentelemetry span log enabled
Консоль управления
Определяет, будут ли логироваться значения трассировок и метрик из распределенного приложения. Логи сохраняются в таблицу
system.opentelemetry_span_log
.По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Opentelemetry span log retention size
Консоль управления
CLI
API
Размер таблицы
system.opentelemetry_span_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
0
(старые записи при росте размера таблицы не удаляются). -
Opentelemetry span log retention time
Консоль управления
CLI
API
Время (в миллисекундах) от внесения записи в таблицу
system.opentelemetry_span_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Part log retention size
Консоль управления
CLI
Terraform
Размер таблицы
system.part_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
536870912
(0,5 ГБ). При значении0
старые записи не будут удаляться при росте размера таблицы. -
Part log retention time
Консоль управления
CLI
Terraform
Время (в миллисекундах) от внесения записи в таблицу
system.part_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Query cache
Консоль управления
CLI
Terraform
API
Настройки кеша запросов
. Кеш позволяет выполнять запросыSELECT
по одному разу и использовать сохраненные результаты в дальнейших операциях. В итоге снижается задержка и сокращается потребление ресурсов кластера при обработке запросов.Доступные настройки кеша запросов:
- Max entries — максимальное количество результатов, которое можно сохранить в кеше при выполнении запросов
SELECT
. Значение по умолчанию —1024
. - Max entry size in bytes — максимальное число байтов, которое можно выделить в кеше каждому результату выполнения запроса
SELECT
. Значение по умолчанию —1048576
(один мегабайт). - Max entry size in rows — максимальное число строк, которое можно выделить в кеше каждому результату выполнения запроса
SELECT
. Значение по умолчанию —30000000
. - Max size in bytes — максимальный размер кеша в байтах. Если указать
0
, кеш запросов будет отключен. Значение по умолчанию —1073741824
(один гигабайт).
Подробнее о настройках см. в документации ClickHouse®
. - Max entries — максимальное количество результатов, которое можно сохранить в кеше при выполнении запросов
-
Query log retention size
Консоль управления
CLI
Terraform
Размер таблицы
system.query_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
1073741824
(1 ГБ). При значении0
старые записи не будут удаляться при росте размера таблицы. -
Query log retention time
Консоль управления
CLI
Terraform
Время (в миллисекундах) от внесения записи в таблицу
system.query_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Query masking rules
Консоль управления
CLI
Terraform
API
Настройки маскирования запросов
. Позволяют применить регулярные выражения к запросам и сообщениям в логах. В результате данные хранятся в логах в защищенном виде, так как регулярные выражения помогают предотвратить утечку конфиденциальных данных (например, имени, электронной почты, данных банковских карт).Доступные настройки для правил маскирования запросов:
- Name — название правила. Необязательный параметр.
- Regexp — регулярное выражение с синтаксисом RE2.
- Replace — выражение, которым надо заменить конфиденциальные данные. По умолчанию используются шесть звездочек.
-
Query thread log enabled
Консоль управления
CLI
Terraform
API
Активирует таблицу
system.query_thread_log
для логирования в ней потоков, которые выполняют запросы. Чтобы записывались логи, убедитесь, что также включена настройка Log query threads.По умолчанию выбрано значение
true
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Query thread log retention size
Консоль управления
CLI
Terraform
Размер таблицы
system.query_thread_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
536870912
(0,5 ГБ). При значении0
старые записи не будут удаляться при росте размера таблицы. -
Query thread log retention time
Консоль управления
CLI
Terraform
Время (в миллисекундах) от внесения записи в таблицу
system.query_thread_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Query views log enabled
Консоль управления
CLI
API
Определяет, будет ли логироваться информация о зависимых представлениях, выполняемых при выполнении запроса. Логи сохраняются в таблицу
system.query_views_log
.По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Query views log retention size
Консоль управления
CLI
API
Размер таблицы
system.query_views_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
0
(старые записи при росте размера таблицы не удаляются). -
Query views log retention time
Консоль управления
CLI
API
Время (в миллисекундах) от внесения записи в таблицу
system.query_views_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Rabbitmq
Консоль управления
CLI
API
Terraform
Глобальные настройки аутентификации для интеграции с RabbitMQ
:- Password — пароль учетной записи RabbitMQ.
- Username — имя учетной записи RabbitMQ.
- Vhost — адрес виртуального хоста для RabbitMQ.
Изменение настроек приводит к перезапуску серверов ClickHouse® на хостах кластера.
-
Session log enabled
Консоль управления
CLI
API
Определяет, будет ли логироваться информация об успешных и неудачных событиях входа и выхода из системы. Логи сохраняются в таблицу
system.session_log
.По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Session log retention size
Консоль управления
CLI
API
Размер таблицы
system.session_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
0
(старые записи при росте размера таблицы не удаляются). -
Session log retention time
Консоль управления
CLI
API
Время (в миллисекундах) от внесения записи в таблицу
system.session_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Text log enabled
Консоль управления
CLI
Terraform
Определяет, будут ли записываться системные логи. Логи сохраняются в таблицу
system.text_log
.По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Text log level
Консоль управления
CLI
Terraform
Уровень логирования событий в таблице system.text_log
. На каждом следующем уровне лог будет содержать всю информацию из предыдущего:ERROR
— информация об ошибках в работе СУБД.WARNING
— информация о событиях, которые могут привести к ошибкам в работе СУБД.INFORMATION
— подтверждения, информация о событиях, не приводящих к ошибкам в работе СУБД.DEBUG
— системная информация для последующего использования в отладке.TRACE
— вся доступная информация о работе СУБД.
По умолчанию выбрано значение
TRACE
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Text log retention size
Консоль управления
CLI
Terraform
Размер таблицы
system.text_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
536870912
(0,5 ГБ). При значении0
старые записи не будут удаляться при росте размера таблицы. -
Text log retention time
Консоль управления
CLI
Terraform
Время (в миллисекундах) от внесения записи в таблицу
system.text_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Timezone
Консоль управления
CLI
API
Terraform
Временная зона сервера. Указывается идентификатором IANA в виде часового пояса UTC или географического положения (например, Africa/Abidjan).
Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.
Подробнее см. в документации ClickHouse®
. -
Total memory profiler step
Консоль управления
API
Объем памяти (в байтах) для стектрейса (stack trace) на каждом шаге выделения памяти. Данные хранятся в системной таблице
system.trace_log
, при этом значениеquery_id
является пустой строкой.По умолчанию выбрано значение
4194304
(4 МБ). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Total memory tracker sample probability
Консоль управления
Вероятность записи информации о случайных выделениях и освобождениях памяти (в процентах). Эти записи хранятся в системной таблице
system.trace_log
. Параметрtrace_type
принимает значение параметраMemorySample
. Вероятность касается каждого выделения или освобождения памяти, независимо от размера выделения. Выборка происходит, только когда объем неотслеживаемой памяти превышает значение настройки Total memory profiler step.По умолчанию запись случайных выделений и освобождений памяти выключена (
0
). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Trace log enabled
Консоль управления
CLI
Terraform
Определяет, будут ли логироваться стектрейсы (stack traces), собираемые профилировщиком запросов. Стектрейсы сохраняются в таблицу
system.trace_log
.По умолчанию выбрано значение
true
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Trace log retention size
Консоль управления
CLI
Terraform
Размер таблицы
system.trace_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
536870912
(0,5 ГБ). При значении0
старые записи не будут удаляться при росте размера таблицы. -
Trace log retention time
Консоль управления
CLI
Terraform
Время (в миллисекундах) от внесения записи в таблицу
system.trace_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно. -
Uncompressed cache size
Консоль управления
CLI
API
Terraform
Размер кеша (в байтах) для несжатых данных, используемых движками таблиц семейства MergeTree
.По умолчанию выбрано значение
8589934592
(8 ГБ). Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера. -
Zookeeper log enabled
Консоль управления
CLI
API
Определяет, будет ли логироваться информация о параметрах запроса к серверу ZooKeeper и ответа от него. Логи сохраняются в таблицу
system.zookeeper_log
.По умолчанию выбрано значение
false
. Изменение настройки приводит к перезапуску серверов ClickHouse® на хостах кластера.Подробнее см. в документации ClickHouse®
. -
Zookeeper log retention size
Консоль управления
CLI
API
Размер таблицы
system.zookeeper_log
(в байтах), при превышении которого из нее начнут удаляться старые записи.По умолчанию выбрано значение
0
(старые записи при росте размера таблицы не удаляются). -
Zookeeper log retention time
Консоль управления
CLI
API
Время (в миллисекундах) от внесения записи в таблицу
system.zookeeper_log
до удаления этой записи. Значение должно быть кратно 1000.По умолчанию выбрано значение
2592000000
(30 дней). При значении0
записи хранятся бессрочно.
Настройки на уровне запроса
Настройки СУБД
Эти настройки действуют на уровне отдельного пользователя.
Доступны следующие настройки:
-
Add HTTP CORS header
Консоль управления
CLI
API
SQL
Включает заголовок CORS в HTTP-ответы.
По умолчанию заголовок CORS не включается в HTTP-ответы.
-
Allow DDL
Все интерфейсы
Определяет, будут ли выполняться DDL-запросы (
CREATE
,ALTER
,RENAME
и другие).По умолчанию выполнение DDL-запросов разрешено.
Подробнее см. в документации ClickHouse®
.См. также: настройка Readonly.
-
Allow introspection functions
Консоль управления
API
SQL
Включает функции интроспекции
для профилирования запросов.Возможные значения:
0
— функции интроспекции отключены.1
— функции интроспекции включены.
Значение по умолчанию —
0
.Подробнее см. в документации ClickHouse®
. -
Allow suspicious low cardinality types
Консоль управления
API
SQL
Разрешает использовать тип данных LowCardinality
с типами данных с фиксированным размером 8 байт или меньше.Возможные значения:
0
— использованиеLowCardinality
ограничено.1
— использованиеLowCardinality
не ограничено.
Значение по умолчанию —
0
.Подробнее см. в документации ClickHouse®
. -
Any join distinct right table keys
Консоль управления
SQL
Включает устаревшее поведение сервера ClickHouse® при выполнении операций
ANY INNER|LEFT JOIN
.По умолчанию устаревшее поведение операции
JOIN
выключено.Подробнее см. в документации ClickHouse®
. -
Async insert
Консоль управления
API
SQL
Включает или отключает асинхронные вставки. Работает только для вставок по протоколу HTTP. При таких вставках дедупликация не производится.
Если включено, данные собираются в пачки перед вставкой в таблицу. Это позволяет производить мелкие и частые вставки в ClickHouse® (до 15000 запросов в секунду) без промежуточных таблиц.
Возможные значения:
0
— вставки производятся синхронно, один запрос за другим.1
— включены множественные асинхронные вставки.
Значение по умолчанию —
0
.Подробнее см. в документации ClickHouse®
. -
Async insert busy timeout
Консоль управления
API
SQL
Максимальное время (в миллисекундах) ожидания вставки данных с момента первого запроса
INSERT
.Значение по умолчанию —
200
. Если указан0
, ожидание отключено.Подробнее см. в документации ClickHouse®
. -
Async insert max data size
Консоль управления
API
SQL
Максимальный размер необработанных данных (в байтах), собранных за запрос, перед их вставкой.
Значение по умолчанию —
1000000
. Если указан0
, асинхронные вставки будут отключены.Подробнее см. в документации ClickHouse®
. -
Async insert stale timeout
Консоль управления
API
SQL
Максимальное время (в миллисекундах) ожидания вставки данных с момента последнего запроса
INSERT
. Если установлено ненулевое значение, Async insert busy timeout будет продлеваться с каждым запросомINSERT
, пока не будет превышено значение Async insert max data size.Значение по умолчанию —
0
. Если указан0
, ожидание отключено.Подробнее см. в документации ClickHouse®
. -
Async insert threads
Консоль управления
API
SQL
Максимальное число потоков для фоновой обработки и вставки данных.
Значение по умолчанию —
16
. Если указан0
, асинхронные вставки будут отключены.Подробнее см. в документации ClickHouse®
. -
Cancel HTTP readonly queries on client close
Консоль управления
API
SQL
Если настройка включена, сервис отменяет HTTP readonly запросы (например, SELECT) в момент, когда клиент обрывает соединение до получения ответа.
По умолчанию настройка выключена.
Подробнее см. в документации ClickHouse®
. -
Compile expressions
Консоль управления
CLI
API
SQL
Определяет, компилировать ли выражения при выполнении запросов. При включенной компиляции запросы, в которых используются идентичные выражения, могут выполняться быстрее за счет использования скомпилированных выражений.
Используется вместе с настройкой Min count to compile expression.
По умолчанию компиляция выражений выключена.
-
Connect timeout
Консоль управления
CLI
API
SQL
Время ожидания соединения (в миллисекундах).
Минимальное значение —
1
, по умолчанию —10000
(10 секунд). -
Connect timeout with failover
Консоль управления
API
SQL
Время ожидания соединения (в миллисекундах) с удаленным сервером для движка таблиц
Distributed
, если кластер использует шардирование и репликацию.Если установить соединение с сервером не удалось, будут предприняты попытки установить соединение с его репликами.
Значение по умолчанию —
50
.Подробнее см. в документации ClickHouse®
. -
Count distinct implementation
Консоль управления
CLI
API
Определяет, какая из функций
uniq*
используется при выполнении конструкцииCOUNT(DISTINCT …)
:По умолчанию используется функция
uniqExact
.Подробнее см. в документации ClickHouse®
. -
Date time input format
Консоль управления
SQL
Определяет, какой парсер используется для текстового представления даты и времени при обработке входного формата:
best_effort
— расширенный парсер.basic
— базовый парсер.
По умолчанию используется базовый парсер (
basic
).Подробнее см. в документации ClickHouse®
. -
Date time output format
Консоль управления
SQL
Определяет выходной формат для текстового представления даты и времени:
simple
— простой формат.iso
— формат ISO.unix_timestamp
— формат Unix.
По умолчанию используется простой формат (
simple
).Подробнее см. в документации ClickHouse®
. -
Deduplicate blocks in dependent materialized views
Консоль управления
SQL
Включает проверку дедупликации для материализованных представлений, которые получают данные из реплицируемых таблиц.
По умолчанию проверка выключена (
0
).Подробнее см. в документации ClickHouse®
. -
Distinct overflow mode
Консоль управления
CLI
API
SQL
Определяет поведение ClickHouse® в ситуации, когда количество данных при выполнении запроса
SELECT DISTINCT
превысило ограничения :throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Distributed aggregation memory efficient
Консоль управления
CLI
API
SQL
Определяет, включать ли режим экономии памяти при распределенной агрегации.
При распределенной обработке запроса внешняя агрегация производится на удаленных серверах. Включите эту настройку, чтобы сократить использование оперативной памяти на сервере-инициаторе запроса.
По умолчанию режим экономии памяти выключен.
Подробнее см. в документации ClickHouse®
. -
Distributed ddl task timeout
Все интерфейсы
Устанавливает время ожидания для ответов на DDL-запросы от всех хостов в кластере. Если DDL-запрос не был выполнен на всех хостах, то ответ будет содержать ошибку времени ожидания, и запрос будет выполнен в асинхронном режиме. Возможные значения:
- положительное целое число — время ожидания равно этому числу (в секундах).
0
— асинхронный режим.- отрицательное число — бесконечное время ожидания.
По умолчанию используется значение
180
. -
Distributed product mode
Консоль управления
CLI
API
SQL
Изменяет поведение распределенных подзапросов, когда запрос содержит произведение распределённых таблиц:
deny
— запрещает использование таких подзапросов.local
— заменяет базу данных и таблицу в подзапросе на локальные для конечного сервера (шарда), оставив обычныйIN/JOIN
.global
— заменяет запросIN/JOIN
наGLOBAL IN/GLOBAL JOIN
.allow
— разрешает использование таких подзапросов.
По умолчанию значение не выбрано (эквивалентно
deny
).Подробнее см. в документации ClickHouse®
. -
Empty result for aggregation by empty set
Консоль управления
CLI
API
SQL
Определяет, в каком формате возвращается результат при агрегации данных без ключей (без
GROUP BY
) для пустого множества (например,SELECT count(*) FROM table WHERE 0
):- настройка выключена (по умолчанию) — ClickHouse® вернет результат, состоящий из одной строки со значениями
NULL
для агрегатных функций, в соответствии со стандартом SQL. - настройка включена — ClickHouse® вернет пустой результат.
- настройка выключена (по умолчанию) — ClickHouse® вернет результат, состоящий из одной строки со значениями
-
Enable HTTP compression
Консоль управления
CLI
API
SQL
Определяет, будут ли сжаты данные в ответе на HTTP-запрос.
По умолчанию ClickHouse® хранит данные в сжатом виде. Результат выполнения запроса представлен в несжатом виде. Чтобы ClickHouse® сжимал результат запроса при отправке по HTTP, включите эту настройку и передайте в заголовке
Accept-Encoding
запроса выбранный метод сжатия:gzip
br
deflate
По умолчанию сжатие данных в ответе на HTTP-запрос выключено.
Подробнее см. в документации ClickHouse®
. -
Fallback to stale replicas for distributed queries
Консоль управления
CLI
API
SQL
Форсирует запрос в устаревшую реплику в случае, если актуальные данные недоступны.
ClickHouse® выберет наиболее актуальную из устаревших реплик таблицы. Настройка используется при выполнении запроса
SELECT
из распределенных таблиц, указывающих на реплицированные таблицы.По умолчанию форсирование запроса включено.
Подробнее см. в документации ClickHouse®
.См. также настройку Max replica delay for distributed queries.
-
Flatten nested
Консоль управления
API
SQL
Задает формат данных вложенных столбцов
.Возможные значения:
0
— вложенный столбец преобразуется к массиву кортежей.1
— вложенный столбец преобразуется к отдельным массивам.
Значение по умолчанию:
1
.Подробнее см. в документации ClickHouse®
. -
Force index by date
Консоль управления
CLI
API
SQL
Запрещает выполнение запросов, если использовать индекс по дате невозможно. Работает с таблицами семейства MergeTree
.По умолчанию настройка выключена (выполнение запросов разрешено).
Подробнее см. в документации ClickHouse®
. -
Force primary key
Консоль управления
CLI
API
SQL
Запрещает выполнение запросов, если использовать индекс по первичному ключу невозможно. Работает с таблицами семейства MergeTree
.По умолчанию настройка выключена (выполнение запросов разрешено).
Подробнее см. в документации ClickHouse®
. -
Format regexp
Консоль управления
SQL
Задает регулярное выражение в формате re2
, которое будет применяться к каждой строке импортируемых данных. Количество подшаблонов (скобочных групп) в выражении должно быть равно количеству столбцов в таблице, куда помещаются импортируемые данные. В качестве разделителей строк должны использоваться символы переноса строки\n
или\r\n
, экранировать перенос строки невозможно. Если строка не подходит регулярному выражению, то она пропускается.По умолчанию значение не задано.
-
Format regexp escaping rule
Консоль управления
SQL
Задает правило экранирования для регулярного выражения, заданного в настройке Format regexp:
CSV
Escaped
JSON
Quoted
Raw
XML
По умолчанию выбрано значение
Raw
(экранирование не используется). -
Format regexp skip unmatched
Консоль управления
SQL
Выводит сообщение об ошибке, если строку в импортируемых данных не получается разбить по шаблону, заданному в настройке Format regexp.
По умолчанию сообщение не выводится (
0
). -
Group by overflow mode
Консоль управления
CLI
API
SQL
Определяет поведение ClickHouse®, когда количество уникальных ключей при агрегации превысило ограничение
:throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.any
— выполнитьGROUP BY
приближенно. Качество такого вычисления зависит от статистических свойств данных.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Group by two level threshold
Консоль управления
CLI
API
SQL
Определяет количество ключей, при достижении которого начинается двухуровневая агрегация.
Минимальное значение —
0
(не установлено), по умолчанию —100000
. -
Group by two level threshold bytes
Консоль управления
CLI
API
SQL
Определяет количество байт в агрегате, при достижении которого начинается двухуровневая агрегация.
Минимальное значение —
0
(не установлено), по умолчанию —50000000
. -
Hedged connection timeout ms
Консоль управления
CLI
Terraform
API
SQL
Время в миллисекундах, за которое нужно установить соединение с репликой для работы с хеджированными запросами. Используется вместе с настройкой Use hedged requests.
Значение по умолчанию — 50 миллисекунд.
Подробнее см. в документации ClickHouse®
. -
HTTP connection timeout
Консоль управления
CLI
API
SQL
Задает время ожидания установления HTTP-соединения (в миллисекундах).
Минимальное значение —
1
, по умолчанию —1000
(одна секунда). -
HTTP headers progress interval
Консоль управления
CLI
API
SQL
Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка
X-ClickHouse-Progress
.Минимальное значение —
1
, по умолчанию —100
. -
HTTP receive timeout
Консоль управления
CLI
API
SQL
Задает время ожидания приема данных через HTTP-соединение (в миллисекундах).
Минимальное значение —
1
, по умолчанию —1800000
(30 минут). -
HTTP send timeout
Консоль управления
CLI
API
SQL
Задает время ожидания отправки данных через HTTP-соединение (в миллисекундах).
Минимальное значение —
1
, по умолчанию —1800000
(30 минут). -
Idle connection timeout
Консоль управления
CLI
Terraform
API
SQL
Время в миллисекундах, через которое нужно закрыть простаивающие TCP-соединения.
Если указано значение
0
, соединения закрываются незамедлительно.Значение по умолчанию —
360000
(шесть минут).Подробнее см. в документации ClickHouse®
. -
Input format defaults for omitted fields
Консоль управления
CLI
API
SQL
Определяет, будут ли пропущенные поля заполнены значениями по умолчанию для типа данных столбца при вставке данных запросом
INSERT
.По умолчанию замена включена.
Подробнее см. в документации ClickHouse®
. -
Input format import nested json
Консоль управления
Определяет, вставлять ли данные JSON с вложенными объектами.
По умолчанию такая вставка данных выключена.
Подробнее см. в документации ClickHouse®
. -
Input format null as default
Консоль управления
SQL
Определяет, заполнять ли ячейки со значением
NULL
значениями по умолчанию, если тип данных столбца не позволяет хранить значениеNULL
.По умолчанию настройка включена (ячейки
NULL
заполняются значениями по умолчанию).Подробнее см. в документации ClickHouse®
. -
Input format parallel parsing
Консоль управления
Определяет, разбивать ли входящие данные на части, парсинг каждой из которых осуществляется параллельно с сохранением исходного порядка. Поддерживается только для форматов TSV
, TKSV , CSV и JSONEachRow .По умолчанию такая разбивка входящих данных включена.
Подробнее см. в документации ClickHouse®
. -
Input format values interpret expressions
Консоль управления
CLI
API
SQL
Включает SQL-парсер, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если вставляете в таблицу значения, содержащие выражения SQL.
Например, потоковый парсер не распознает значение, содержащее в себе выражение
now()
, в то время как при включенном SQL-парсере выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функцииnow()
(текущая дата и время).Эта настройка используется только для формата Values
при вставке данных.По умолчанию парсер SQL включен.
Подробнее см. в документации ClickHouse®
. -
Input format with names use header
Консоль управления
SQL
Определяет, выполнять ли проверку порядка столбцов при вставке данных.
По умолчанию проверка включена.
Подробнее см. в документации ClickHouse®
. -
Insert keeper max retries
Консоль управления
CLI
API
Максимальное количество повторных попыток для запросов ClickHouse® Keeper (или ZooKeeper) во время вставки в реплицированные таблицы семейства MergeTree
.Минимальное значение —
0
(повторные попытки отключены), по умолчанию —20
.Подробнее см. в документации ClickHouse®
. -
Insert null as default
Консоль управления
API
SQL
Включает подстановку значений по умолчанию
вместо NULL в столбцы, которые не позволяют хранитьNULL
.Возможные значения:
0
— вставкаNULL
в столбец, не позволяющий хранитьNULL
, приведет к возникновению исключения.1
— вместоNULL
вставляется значение столбца по умолчанию.
Значение по умолчанию —
1
.Подробнее см. в документации ClickHouse®
. -
Insert quorum
Консоль управления
CLI
API
SQL
Управляет кворумной записью в кластере ClickHouse®:
- Если значение меньше 2, то кворумная запись выключена.
- Если значение больше или равно 2, то кворумная запись включена.
Кворумная запись гарантирует, что ClickHouse® без ошибок запишет данные в кворум из Insert quorum реплик за время не больше Insert quorum timeout, а данные не потеряются при выходе из строя одной или нескольких реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов
INSERT
.При чтении данных, записанных с помощью Insert quorum, можно использовать настройку Select sequential consistency.
Подробнее см. в документации ClickHouse®
. -
Insert quorum parallel
Консоль управления
SQL
Когда настройка включена, возможно одновременно выполнять несколько запросов
INSERT
с кворумной записью. Когда настройка выключена, будет выполнен только один запросINSERT
с кворумной записью к одной и той же таблице.По умолчанию настройка включена.
-
Insert quorum timeout
Консоль управления
CLI
API
SQL
Задает время ожидания кворумной записи в миллисекундах. Если время прошло, а запись так и не состоялась, то ClickHouse® прервет выполнение запроса
INSERT
и вернет ошибку.Минимальное значение —
1000
(1 секунда), по умолчанию —60000
(1 минута). -
Join algorithm
Консоль управления
SQL
Определяет алгоритм выполнения запроса
JOIN
:auto
— соединение хешированием (hash join), но если память на сервере заканчивается, ClickHouse® попытается применить соединение merge.direct
— соединение с помощью поиска по строкам в правой таблице, которые являются ключами в левой таблице. Соединение возможно только при выполнении двух условий:- Хранилище правой таблицы поддерживает запросы ключ-значение, например Dictionary
или EmbeddedRocksDB . - Выполняются запросы
LEFT
иINNER JOIN
.
- Хранилище правой таблицы поддерживает запросы ключ-значение, например Dictionary
hash
— соединение хешированием (hash join).parallel_hash
— вариант соединения хешированием (hash join), при котором данные разбиваются на сегменты и создается одновременно несколько хеш-таблиц вместо одной.partial_merge
— вариант соединения слиянием отсортированных списков (sort-merge join), при котором полностью отсортирована только правая часть таблицы.prefer_partial_merge
— алгоритмpartial_merge
. Применяется, когда это возможно, иначе используетсяhash
.sorting_merge
— соединения слиянием отсортированных списков (sort-merge join).
По умолчанию используется алгоритм
hash
.Подробнее см. в документации ClickHouse®
. -
Join overflow mode
Все интерфейсы
Определяет, какое действие выполняет ClickHouse® при достижении любого из следующих ограничений для
JOIN
:max_bytes_in_join
max_rows_in_join
Возможные значения:
throw
— ClickHouse® генерирует исключение и прерывает операцию.break
— ClickHouse® прерывает операцию, но не генерирует исключение.
По умолчанию используется действие
throw
. -
Join use nulls
Консоль управления
CLI
SQL
Управляет поведением запросов
JOIN
. Если настройка включена, то появившиеся при объединении пустые ячейки заполняются значениямиNULL
. В противном случае ячейки заполняются значениями по умолчанию для данного типа поля.По умолчанию настройка выключена.
Подробнее см. в документации ClickHouse®
. -
Joined subquery requires alias
Консоль управления
CLI
SQL
Требует наличия псевдонимов для подзапросов при выполнении операции
JOIN
.При включенной настройке подобный запрос не будет выполнен:
SELECT col1, col2 FROM table1 JOIN (SELECT col3 FROM table2)
При этом запрос с заданным псевдонимом будет выполнен успешно:
SELECT col1, col2 FROM table1 JOIN (SELECT col3 FROM table2) AS MyQuery
По умолчанию настройка выключена.
-
Load balancing
Консоль управления
CLI
Terraform
API
SQL
Задает алгоритм выбора реплик, который используется при отправке и обработке распределенных запросов. ClickHouse® считает число ошибок на каждой реплике и выбирает реплику с наименьшим числом ошибок. Если у нескольких реплик это число одинаковое, настройка Load balancing определяет, в каком порядке сортируются реплики и какая из них выбирается.
Возможные значения:
-
random
— запрос отправляется на любую реплику случайным образом (значение по умолчанию).Недостаток: не учитывается близость хостов.
-
nearest_hostname
— запрос отправляется на реплику, имя хоста которой наиболее близко к имени хоста сервера в конфигурационном файле ClickHouse®. Допустим, есть серверexample-05-05-5
и две репликиexample-05-05-7
иexample-05-06-7
. Будет выбрана репликаexample-05-05-7
, так как ее имя отличается от имени сервера только на один символ.Такой подход повышает вероятность, что распределенные запросы будут отправляться на одни и те же реплики, расположенные близко друг к другу. Это устраняет недостаток значения
random
. -
hostname_levenshtein_distance
— для выбора реплики используется тот же принцип, что при значенииnearest_hostname
. Но подходящее имя хоста реплики определяется по расстоянию Левенштейна . -
in_order
— запрос отправляется на реплику в порядке, заданном в конфигурационном файле ClickHouse®. В кластере Managed Service for ClickHouse® порядок реплик такой, что первое место занимает реплика в той же зоне доступности, где находится хост-инициатор распределенных подзапросов.Недостаток: если первая по порядку реплика выходит из строя, ее нагрузка переходит на следующую по очереди реплику. В результате на нее возникает двойная нагрузка.
-
first_or_random
— запрос отправляется на первую по порядку реплику по аналогии со значениемin_order
. При этом закрывается недостатокin_order
: если первая в списке реплика выходит из строя, случайным образом выбирается любая другая реплика. -
round_robin
— запрос отправляется в соответствии с политикой Round-Robin . Относится только к запросам, которые поддерживают эту политику.
Подробнее см. в документации ClickHouse®
. -
-
Local filesystem read method
Консоль управления
Определяет способ считывания данных из локальной файловой системы.
Возможные значения:
nmap
pread
pread_threadpool
read
Значение по умолчанию —
pread
. -
Log query threads
Консоль управления
CLI
Terraform
API
SQL
Включает логирование потоков, которые выполняют запросы. Логи записываются в таблицу system.query_thread_log
.Настройка работает, только когда также включена настройка Query thread log enabled. По умолчанию обе настройки включены.
Настройку можно применить только для части пользователей или запросов.
Подробнее см. в документации ClickHouse®
. -
Low cardinality allow in native format
Консоль управления
CLI
API
SQL
Определяет, использовать ли тип LowCardinality
в native-формате:- Настройка включена (по умолчанию) — использовать.
- Настройка выключена — не использовать:
- Для запроса
SELECT
конвертировать столбцы типа LowCardinality в обычные. - Для запроса
INSERT
конвертировать обычные столбцы в тип LowCardinality.
- Для запроса
Столбцы этого типа позволяют эффективнее хранить данные в виде хеш-таблиц. Если возможно, ClickHouse® использует столбцы типа LowCardinality.
Некоторые сторонние клиенты для ClickHouse® не поддерживают столбцы типа LowCardinality и не могут правильно интерпретировать результат запроса, в котором присутствуют столбцы такого типа. Выключение настройки позволяет таким клиентам обрабатывать результаты запросов корректно.
Официальный клиент ClickHouse® поддерживает работу со столбцами типа LowCardinality.
По умолчанию настройка включена.
-
Max ast depth
Консоль управления
CLI
API
SQL
Максимальная глубина вложенности синтаксического дерева.
Для сложных запросов синтаксическое дерево может оказаться слишком глубоким. Настройка позволяет запретить выполнение излишне сложных или неоптимизированных запросов для больших таблиц.
Например, запрос
SELECT *
в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запросSELECT ... WHERE ...
с ограничениями и условиями.По умолчанию выбрано значение
1000
. Слишком маленькое значение может привести к невозможности выполнения большинства запросов. -
Max ast elements
Консоль управления
CLI
API
SQL
Максимальное количество элементов синтаксического дерева запроса (количество узлов дерева).
Для сложных запросов синтаксическое дерево может содержать слишком большое количество элементов. Настройка позволяет запретить выполнение излишне сложных или неоптимизированных запросов для больших таблиц.
По умолчанию выбрано значение
50000
. Слишком маленькое значение может привести к невозможности выполнения большинства запросов. -
Max block size
Консоль управления
CLI
API
SQL
Данные в ClickHouse® обрабатываются по блокам (наборам кусочков столбцов). Настройка задает рекомендованный размер блока (количество строк), который будет загружаться при обработке таблиц. Обработка каждого блока влечет за собой накладные расходы, поэтому слишком маленькое значение настройки может замедлить обработку.
Минимальное значение —
1
, по умолчанию —65536
. -
Max bytes before external group by
Консоль управления
CLI
API
SQL
Данные, накопленные при выполнении операции агрегации
GROUP BY
, некоторое время хранятся в оперативной памяти. Настройка задает порог (в байтах), после которого эти данные сбрасываются на диск для экономии оперативной памяти.Настройка полезна, если запросы завершаются с ошибкой из-за того, что для выполнения операции агрегации большого объема данных не хватает оперативной памяти. Задайте ненулевое значение этой настройки, чтобы ClickHouse® сбрасывал данные на диск и успешно выполнял агрегацию в этом случае.
Минимальное значение —
0
(GROUP BY
во внешней памяти отключен), по умолчанию —0
.При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки Max memory usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами).
Подробнее см. в документации ClickHouse®
.См. также настройку Distributed aggregation memory efficient.
-
Max bytes before external sort
Консоль управления
CLI
API
SQL
Настройка аналогична предыдущей, но применяется для операции сортировки (
ORDER BY
). -
Max bytes in distinct
Консоль управления
CLI
API
SQL
Максимальный объем несжатых данных (в байтах), занимаемый хеш-таблицей при использовании
DISTINCT
.Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max bytes in join
Все интерфейсы
Максимальный объем несжатых данных (в байтах), занимаемый хеш-таблицей при использовании
JOIN
.Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max bytes in set
Все интерфейсы
Максимальный объем несжатых данных (в байтах), занимаемый множеством в секции
IN
, которое создается из подзапроса.Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max bytes to read
Консоль управления
CLI
API
SQL
Максимальный объем несжатых данных (в байтах), который можно прочитать из таблицы при выполнении запроса.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max bytes to sort
Консоль управления
CLI
API
SQL
Максимальный объем несжатых данных (в байтах), который можно прочитать из таблицы до сортировки. Настройка позволяет ограничить потребление оперативной памяти при сортировке.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max bytes to transfer
Консоль управления
CLI
API
SQL
Максимальный объем несжатых данных (в байтах), который можно передать на удаленный сервер или сохранить во временную таблицу при использовании
GLOBAL IN
.Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max columns to read
Консоль управления
CLI
API
SQL
Максимальное количество столбцов, которое можно прочитать из таблицы в одном запросе. Запросы, требующие чтения большего количества столбцов, завершатся с ошибкой.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max concurrent queries for user
Консоль управления
API
SQL
Максимальное количество одновременно обрабатываемых пользовательских запросов к таблице семейства MergeTree
.Минимальное значение
0
(нет ограничения), по умолчанию —450
.Подробнее см. в документации ClickHouse®
. -
Max execution time
Консоль управления
CLI
API
SQL
Максимальное время выполнения запроса (в миллисекундах).
Если выполнение запроса находится на одной из стадий сортировки, а также слияния и финализации агрегатных функций, то лимит на максимальное время выполнения запроса не будет проверяться и может быть превышен.
Минимальное значение
0
(нет ограничения), по умолчанию —600000
. -
Max expanded ast elements
Консоль управления
CLI
API
SQL
Максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки.
Для сложных запросов синтаксическое дерево может содержать слишком большое количество элементов. Настройка позволяет запретить выполнение излишне сложных или неоптимизированных запросов для больших таблиц.
По умолчанию выбрано значение
500000
. Слишком маленькое значение может привести к невозможности выполнения большинства запросов. -
Max final threads
Консоль управления
Максимальное количество параллельных потоков для запроса
SELECT
с модификатором FINAL .По умолчанию выбрано значение, равное значению настройки Max threads.
Подробнее см. в документации ClickHouse®
. -
Max HTTP get redirects
Консоль управления
API
SQL
Задает максимальное количество переходов по редиректам в таблицах на движке URL
при выполнении HTTP-запросов методом GET.Если установлено значение
0
, переходы запрещены.Значение по умолчанию —
0
.Подробнее см. в документации ClickHouse®
. -
Max insert block size
Консоль управления
CLI
API
SQL
Формировать блоки указанного размера (в байтах) при вставке в таблицу. Настройка действует только когда сервер сам формирует такие блоки.
По умолчанию выбрано значение
1048576
.Подробнее см. в документации ClickHouse®
. -
Max insert threads
Консоль управления
CLI
Terraform
API
SQL
Максимальное количество потоков для выполнения запроса
INSERT SELECT
.Если указано значение больше
1
, потоки запускаются параллельно. Значение по умолчанию —0
.Запросы
INSERT SELECT
выполняются параллельно, только если настроен параллельный запуск запросовSELECT
с помощью настройки Max threads.Чем больше значение настройки Max insert threads, тем выше потребление оперативной памяти кластера.
Подробнее см. в документации ClickHouse®
. -
Max memory usage
Консоль управления
CLI
API
SQL
Максимальный объем оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объем свободной памяти или общий объем памяти на машине. Ограничение действует на один запрос в пределах одного сервера.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). Максимальное значение ограничено настройкой Max server memory usage, значение которой нельзя изменить напрямую. Подробнее см. в разделе Управление памятью в Managed Service for ClickHouse®. Если задано значение больше, чем Max server memory usage, то применяется значение Max server memory usage.Если вы используете настройки Max bytes before external
GROUP BY
или Max bytes before external sort, рекомендуется задать им значения в два раза меньше значения Max memory usage.Подробнее см. в документации ClickHouse®
. -
Max memory usage for user
Консоль управления
CLI
API
SQL
Максимальный объем оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объем свободной памяти или общий объем памяти на машине.
Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера, в отличие от Max memory usage.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max network bandwidth
Консоль управления
CLI
API
SQL
Максимальная скорость обмена данными по сети при выполнении одного запроса (в байтах в секунду).
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max network bandwidth for user
Консоль управления
CLI
API
SQL
Максимальная скорость обмена данными по сети (в байтах в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя, в отличие от Max network bandwidth.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max parser depth
Консоль управления
CLI
API
Максимальная глубина рекурсии в парсере рекурсивного спуска. Позволяет контролировать размер стека.
Минимальное значение —
0
(глубина рекурсии не ограничена), по умолчанию —1000
.Подробнее см. в документации ClickHouse®
. -
Max partitions per insert block
Консоль управления
SQL
Ограничивает максимальное количество партиций в одном вставленном блоке.
Минимальное значение —
0
(количество разделов не ограничено), по умолчанию —100
.Подробнее см. в документации ClickHouse®
. -
Max query size
Консоль управления
CLI
API
SQL
Ограничивает размер (в байтах) наибольшей части запроса, которая может быть передана в оперативную память для разбора с помощью SQL-парсера.
Минимальное значение —
1
, по умолчанию —262144
. -
Max read buffer size
Консоль управления
Максимальный размер буфера (в байтах) для чтения из файловой системы.
Значение по умолчанию —
1048576
(1 МБ). -
Max replica delay for distributed queries
Консоль управления
CLI
API
SQL
Максимальное отставание реплики (в миллисекундах). Если задержка реплики больше значения настройки, реплика перестает использоваться.
Минимальное значение —
1000
(1 секунда), по умолчанию —300000
(5 минут).См. также описание настройки Fallback to stale replicas for distributed queries.
-
Max result bytes
Консоль управления
CLI
API
SQL
Максимальный размер результата запроса несжатых данных (в байтах). Ограничение распространяется также на подзапросы и на те части распределенных запросов, которые выполняются на удаленных серверах.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max result rows
Консоль управления
CLI
API
SQL
Максимальное количество строк результата. Ограничение распространяется также на подзапросы и на те части распределенных запросов, которые выполняются на удаленных серверах.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max rows in distinct
Консоль управления
CLI
API
SQL
Максимальное количество различных строк при использовании
DISTINCT
.Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max rows in join
Все интерфейсы
Максимальное количество строк в хеш-таблице, которая используется при соединении таблиц. Параметр применяется к операциям
SELECT… JOIN
и к движку таблицJoin
.Минимальное значение и значение по умолчанию —
0
(нет ограничения).Подробнее см. в документации ClickHouse®
. -
Max rows in set
Все интерфейсы
Максимальное количество строк для множества в секции
IN
, которое создается из подзапроса.Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max rows to group by
Консоль управления
CLI
API
SQL
Максимальное количество уникальных ключей, получаемых в процессе агрегации. Используйте настройку, чтобы ограничить потребление оперативной памяти при агрегации.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max rows to read
Консоль управления
CLI
API
SQL
Максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max rows to sort
Консоль управления
CLI
API
SQL
Максимальное количество строк для сортировки. Используйте эту настройку, чтобы ограничить потребление оперативной памяти при сортировке.
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max rows to transfer
Консоль управления
CLI
API
SQL
Максимальное количество строк, которое можно передать на удаленный сервер или сохранить во временную таблицу при использовании
GLOBAL IN
.Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max temporary columns
Консоль управления
CLI
API
SQL
Максимальное количество временных столбцов, которое единовременно хранится в оперативной памяти при выполнении запроса (с учетом постоянных столбцов).
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max temporary data on disk size for query
Консоль управления
CLI
API
Максимальный объем данных (в байтах), потребляемых временными файлами на диске, для всех одновременно выполняемых запросов.
Минимальное значение —
0
(нет ограничения).Подробнее см. в документации ClickHouse®
. -
Max temporary data on disk size for user
Консоль управления
CLI
API
Максимальный объем данных (в байтах), потребляемых временными файлами на диске, для всех одновременно выполняемых пользовательских запросов.
Минимальное значение —
0
(нет ограничения).Подробнее см. в документации ClickHouse®
. -
Max temporary non const columns
Консоль управления
CLI
API
SQL
Максимальное количество временных столбцов, которое единовременно хранится в оперативной памяти при выполнении запроса (без учета постоянных столбцов).
Минимальное значение и значение по умолчанию —
0
(нет ограничения). -
Max threads
Консоль управления
CLI
API
SQL
Максимальное количество потоков обработки запроса, без учета потоков для чтения данных с удаленных серверов. Настройка относится к потокам, которые используются для параллельного выполнения стадий конвейера запросов.
Минимальное значение и значение по умолчанию —
0
(вычислять значение автоматически как количество процессорных ядер без учета Hyper-Threading).Подробнее см. в документации ClickHouse®
. -
Memory overcommit ratio denominator
Консоль управления
CLI
API
Лимит для перегрузки памяти
(в ГБ), когда достигнут жесткий лимит на уровне пользователя.Минимальное значение —
0
(нет лимита). Значение по умолчанию —1
.Подробнее см. в документации ClickHouse®
. -
Memory overcommit ratio denominator for user
Консоль управления
CLI
API
Лимит для перегрузки памяти
(в ГБ), когда достигнут жесткий лимит на глобальном уровне.Минимальное значение —
0
(нет лимита). Значение по умолчанию —1
.Подробнее см. в документации ClickHouse®
. -
Memory profiler sample probability
Консоль управления
API
SQL
Система будет с указанной вероятностью сохранять информацию о том или ином выделении и освобождении оперативной памяти в файл лога
system.trace_log
с типом трассировкиMemorySample
. Вероятность сохранения не зависит от размера выделенной/освобожденной памяти.Возможные значения — от
0
до1
. По умолчанию —0
. -
Memory profiler step
Консоль управления
API
SQL
Шаг профилировщика памяти (в байтах). Если на следующем шаге выполнения запроса потребление памяти возрастает на число байт, большее указанного в данной настройке, то профилировщик сохраняет выделенный стектрейс. Значения менее нескольких мегабайт замедляют обработку запросов.
По умолчанию —
4194304
(4 МБ). Если задан0
— профилировщик памяти отключен. -
Memory usage overcommit max wait microseconds
Консоль управления
CLI
API
Время ожидания (в микросекундах) для освобождения памяти при перегрузке памяти
на уровне пользователя.По умолчанию выбрано значение
5000000
(5 секунд).Подробнее см. в документации ClickHouse®
. -
Merge tree max bytes to use cache
Консоль управления
CLI
API
SQL
Максимальный размер запроса (в байтах), при котором используется кеш несжатых данных. Кеш не используется для запросов, превышающих указанный размер.
Настройка используется совместно с Use uncompressed cache.
По умолчанию выбрано значение
192x10x1024x1024
. -
Merge tree max rows to use cache
Консоль управления
CLI
API
SQL
Максимальный размер запроса (в строках), при котором используется кеш несжатых данных. Кеш не используется для запросов, превышающих указанный размер.
Настройка используется совместно с Use uncompressed cache.
По умолчанию выбрано значение
128x8192
. -
Merge tree min bytes for concurrent read
Консоль управления
CLI
API
SQL
Если количество прочитанных из файла байт превышает значение настройки, то ClickHouse® пытается выполнить одновременное чтение из этого файла в несколько потоков.
Минимальное значение —
1
, по умолчанию —24x10x1024x1024
. -
Merge tree min rows for concurrent read
Консоль управления
CLI
API
SQL
Если количество прочитанных из файла строк превышает значение настройки, то ClickHouse® пытается выполнить одновременное чтение из этого файла в несколько потоков.
Минимальное значение —
1
, по умолчанию —20x8192
. -
Min bytes to use direct io
Консоль управления
CLI
API
SQL
Объем данных (в байтах), необходимый для прямого чтения (Direct I/O) с диска.
По умолчанию ClickHouse® читает данные не напрямую с диска, а полагается на файловую систему и ее кеш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать их с диска напрямую, минуя кеш файловой системы.
Если общий объем всех хранимых данных для чтения превышает заданное значение настройки, тогда ClickHouse® читает данные с диска напрямую.
Минимальное значение и значение по умолчанию —
0
(прямое чтение отключено). -
Min count to compile
CLI
API
SQL
Настройка устарела.
Определяет, после какого количества структурно идентичных запросов начать компиляцию.
Для значения
0
компиляция выполняется синхронно: запрос ожидает окончания компиляции, затем продолжает выполняться. Рекомендуется использовать это значение только в целях тестирования.Для всех других значений компиляция выполняется асинхронно, в отдельном потоке: когда результат будет готов, он сразу же будет использован, в том числе уже выполняющимися в данный момент запросами.
Минимальное значение —
0
, по умолчанию —3
. -
Min count to compile expression
Консоль управления
CLI
API
SQL
Определяет, после какого количества идентичных выражений начать компиляцию выражений.
Для значения
0
компиляция выполняется синхронно: выражение ожидает окончания компиляции, затем продолжается выполнение запроса. Рекомендуется использовать это значение только в целях тестирования.Для всех других значений компиляция выполняется асинхронно, в отдельном потоке: когда результат будет готов, он сразу же будет использован, в том числе уже выполняющимися в данный момент запросами.
Минимальное значение —
0
, по умолчанию —3
. -
Min execution speed
Все интерфейсы
Минимальная скорость выполнения запроса (в строках в секунду).
При выполнении запросов ClickHouse® обрабатывает данные блоками (batches). Если блок обрабатывается дольше времени, заданного настройкой timeout_before_checking_execution_speed
, проверяется скорость выполнения запроса. Если эта скорость ниже указанной в значении настройки, генерируется исключение.Минимальное значение и значение по умолчанию —
0
(нет ограничения).Подробнее см. в документации ClickHouse®
. -
Min execution speed bytes
Все интерфейсы
Минимальная скорость выполнения запроса (в байтах в секунду).
При выполнении запросов ClickHouse® обрабатывает данные блоками (batches). Если блок обрабатывается дольше времени, заданного настройкой timeout_before_checking_execution_speed
, проверяется скорость выполнения запроса. Если эта скорость ниже указанной в значении настройки, генерируется исключение.Минимальное значение и значение по умолчанию —
0
(нет ограничения).Подробнее см. в документации ClickHouse®
. -
Min insert block size bytes
Консоль управления
CLI
API
SQL
Минимальный размер блока (в байтах), который может быть вставлен в таблицу запросом
INSERT
. Блоки меньшего размера склеиваются вместе .Минимальное значение —
0
(склейка блоков выключена), по умолчанию —268435456
(256 МБ). -
Min insert block size rows
Консоль управления
CLI
API
SQL
Минимальный размер блока (в строках), который может быть вставлен в таблицу запросом
INSERT
. Блоки меньшего размера склеиваются вместе .Минимальное значение —
0
(склейка блоков выключена), по умолчанию —1048576
. -
Output format json quote denormals
Консоль управления
CLI
API
SQL
Определяет, выводить ли специальные значения для чисел с плавающей запятой (
+nan
,-nan
,+inf
и-inf
) при использовании формата JSON для результата.По умолчанию выбрано значение
false
— специальные значения не выводятся. -
Output format json quote_64bit integers
Консоль управления
CLI
API
SQL
Определяет формат чисел в JSON-выводе. Если настройка включена, то при выводе в JSON 64-битные числа (
UInt64
иInt64
) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript), иначе — без кавычек.По умолчанию вывод 64-битных целых чисел в кавычках выключен.
-
Prefer localhost replica
Консоль управления
CLI
Terraform
API
SQL
Включает отправку распределенных запросов на реплику
localhost
.Если настройка выключена, Managed Service for ClickHouse® распределяет запросы на основе настройки Load balancing.
По умолчанию настройка включена.
Важно
Если кластер содержит один шард и несколько реплик, отключение этой настройки может повредить работоспособности кластера.
Подробнее см. в документации ClickHouse®
. -
Priority
Консоль управления
CLI
API
SQL
Определяет приоритет запроса:
0
— приоритет не используется.1
— наивысший приоритет.- далее — чем выше число, тем ниже приоритет.
Настройка выставляется отдельно для каждого запроса.
Если в ClickHouse® поступает запрос с более высоким приоритетом, выполнение менее приоритетных запросов приостанавливается до завершения поступившего запроса.
Минимальное значение и значение по умолчанию —
0
. -
Quota mode
Консоль управления
CLI
SQL
Режим учета потребляемых ресурсов при включенных квотах
:default
— ключи не используются.keyed
— в параметре пользовательского запроса передается ключquota_key
, квота считается по отдельности для каждого значения ключа.keyed_by_ip
— аналогичен предыдущему, но в качестве ключа выступает IP-адрес пользователя. Рекомендуется использовать этот режим только в тех случаях, если у пользователя нет способов быстро сменить IP-адрес, например, для обхода ограничений квоты. Это относится как к IPv4-, так и IPv6-адресам.
По умолчанию значение не выбрано (эквивалентно
default
).Подробнее см. в документации ClickHouse®
. -
Read overflow mode
Консоль управления
CLI
API
SQL
Определяет поведение ClickHouse®, когда количество прочитанных данных превысило одно из ограничений
:throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Readonly
Консоль управления
CLI
API
SQL
Разрешения для запросов на изменение параметров, чтение и запись данных:
0
(по умолчанию) — разрешено выполнять все типы запросов.1
— разрешено выполнять только запросы на чтение данных.2
— разрешено выполнять запросы на чтение данных и изменение настроек.
Настройка не влияет на возможность выполнения DDL-запросов. Чтобы разрешить или запретить выполнение DDL-запросов, используйте настройку Allow DDL.
См. также: пример создания пользователя с правами «только чтение».
-
Receive timeout
Консоль управления
CLI
API
SQL
Время ожидания приема данных (в миллисекундах).
По умолчанию выбрано значение
300000
(5 минут). -
Remote filesystem read method
Консоль управления
CLI
API
Определяет способ считывания данных из удаленной файловой системы.
Возможные значения:
read
threadpool
Значение по умолчанию —
threadpool
. -
Replication alter partitions sync
Консоль управления
CLI
API
SQL
Задает условия ожидания завершения асинхронных действий на репликах для запросов
ALTER ... ATTACH DETACH DROP
:0
— не ждать.1
— ждать выполнения только у себя (значение по умолчанию).2
— ждать всех.
Подробнее см. в документации ClickHouse®
. -
Result overflow mode
Консоль управления
CLI
API
SQL
Определяет поведение ClickHouse®, когда объем результата превысил одно из ограничений
:throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Select sequential consistency
Консоль управления
CLI
API
SQL
Определяет, нужно ли обеспечивать последовательную консистентность для запросов
SELECT
.По умолчанию последовательная консистентность не обеспечивается.
Подробнее см. в документации ClickHouse®
. -
Send progress in HTTP headers
Консоль управления
CLI
API
SQL
Разрешает отправку уведомлений о ходе выполнения запроса с использованием заголовков
X-ClickHouse-Progress
.По умолчанию отсылка уведомлений выключена.
-
Send timeout
Консоль управления
CLI
API
SQL
Время ожидания отправки данных (в миллисекундах).
По умолчанию выбрано значение
300000
(5 минут). -
Set overflow mode
Все интерфейсы
Определяет поведение ClickHouse®, когда количество данных превысило одно из ограничений на сложность запроса
:throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Skip unavailable shards
Консоль управления
CLI
API
SQL
Разрешает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны.
По умолчанию тихий пропуск недоступных шардов выключен.
-
Sort overflow mode
Консоль управления
CLI
API
SQL
Определяет поведение ClickHouse®, когда количество полученных перед сортировкой строк превысило одно из ограничений
:throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Timeout before checking execution speed
Консоль управления
API
SQL
Время ожидания (в секундах) между проверками скорости выполнения запроса. Проверяется, что скорость выполнения не ниже указанной в параметре Min execution speed.
Значение по умолчанию —
10
.Подробнее см. в документации ClickHouse®
. -
Timeout overflow mode
Консоль управления
CLI
API
SQL
Определяет поведение ClickHouse®, когда запрос выполняется дольше max_execution_time:
throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Transfer overflow mode
Консоль управления
CLI
API
SQL
Определяет поведение ClickHouse®, когда количество данных для передачи на другой сервер превысило одно из ограничений
:throw
— прервать выполнение, вернуть ошибку.break
— вернуть неполный результат.
По умолчанию значение не выбрано (эквивалентно
throw
). -
Transform null in
Консоль управления
CLI
SQL
При включенной опции сравнение
NULL = NULL
вернетtrue
в оператореIN
.По умолчанию настройка выключена.
Подробнее см. в документации ClickHouse®
. -
Use hedged requests
Консоль управления
CLI
Terraform
API
SQL
Включает хеджированные запросы.
Позволяет устанавливать множество соединений с различными репликами для отправки запросов. Новое соединение устанавливается, если текущие соединения с репликами не были установлены в течение времени Hedged connection timeout ms.
Первое соединение, которое отправило не пустой пакет о прогрессе выполнения запроса, используется для отправки этого запроса. Остальные соединения отменяются.
По умолчанию настройка включена.
Подробнее см. в документации ClickHouse®
. -
Use uncompressed cache
Консоль управления
CLI
API
SQL
Определяет, использовать ли кеш разжатых блоков. Использование этого кеша может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов (только для таблиц семейства MergeTree
). Включите эту настройку для пользователей, от которых идут частые короткие запросы.По умолчанию кеш не используется.
Подробнее см. в документации ClickHouse®
.См. также настройки Merge tree max bytes to use cache и Merge tree max rows to use cache.
-
Wait for async insert
Консоль управления
API
SQL
Включает ожидание обработки асинхронных вставок.
Возможные значения:
0
— сервер возвращаетOK
даже если вставка данных еще не завершена.1
— сервер возвращаетOK
только после завершения вставки данных.
Значение по умолчанию —
1
.Подробнее см. в документации ClickHouse®
. -
Wait for async insert timeout
Консоль управления
API
SQL
Время (в секундах) ожидания обработки асинхронной вставки.
Значение по умолчанию —
120
. Если указан0
, ожидание отключено.Подробнее см. в документации ClickHouse®
.
Пользовательские настройки
Пользовательские настройки
Название пользовательской настройки в Managed Service for ClickHouse® должно начинаться с предопределенного префикса custom_
. Префикс фиксированный — пользователь не может его менять.
Настройки квот
Квота позволяет ограничить потребление ресурсов ClickHouse® в течение заданного интервала времени. Настройки квоты задаются для отдельно взятого пользователя.
Если пользователь превысил одно из ограничений квоты, то он не сможет выполнять новые запросы до того, как истечет интервал.
ClickHouse® выведет сообщение о превышении квоты и укажет время начала нового интервала, когда запрет на выполнение запросов будет снят, а счетчики ограничений — сброшены.
ClickHouse® также использует квоты для учета потребления ресурсов.
Для каждого пользователя есть квота по умолчанию, которая учитывает потребление всех ресурсов за каждый час, но не накладывает никаких ограничений.
Сведения об уровне потребления ресурсов записываются в лог сервера ClickHouse®.
Подробнее см. в документации ClickHouse®
Доступны следующие настройки квот:
-
Errors
Все интерфейсы
Ограничение на суммарное количество запросов, которые завершились с ошибкой.
Минимальное значение —
0
(нет ограничений). -
Execution time
Все интерфейсы
Ограничение на суммарное время выполнения запросов в миллисекундах.
Минимальное значение —
0
(нет ограничений). -
Interval duration
Все интерфейсы
Интервал для квоты (в миллисекундах). Значение должно быть кратно 1000.
Минимальное значение —
1000
(одна секунда). -
Queries
Все интерфейсы
Ограничение на суммарное количество запросов.
Минимальное значение —
0
(нет ограничений). -
Read rows
Все интерфейсы
Ограничение на суммарное число исходных строк, считанных из таблиц для выполнения запросов (включая строки, считанные на удаленных серверах).
Минимальное значение —
0
(нет ограничений). -
Result rows
Все интерфейсы
Ограничение на суммарное число строк в результатах запроса.
Минимальное значение —
0
(нет ограничений).
ClickHouse® является зарегистрированным товарным знаком ClickHouse, Inc