Настройки ClickHouse

Статья создана

Настройки на уровне кластера
Настройки на уровне пользователя
- Настройки квот
- Настройки СУБД
Пользовательские настройки

Для кластера Managed Service for ClickHouse можно задать настройки, которые относятся к ClickHouse. Часть настроек задается на уровне кластера, часть — на уровне пользователя.

Метки рядом с названием настройки позволяют определить, с помощью какого интерфейса задается значение этой настройки: консоль управления, 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.

Настройки на уровне кластера

Доступны следующие настройки:

Background fetches pool size Консоль управления API

Количество потоков для выполнения фоновых операций извлечения в таблицах семейства ReplicatedMergeTree.

По умолчанию выбрано значение 8.

Подробнее см. в документации ClickHouse.
Background pool size Консоль управления API Terraform

Количество потоков для выполнения фоновых операций слияния и мутаций в таблицах семейства MergeTree.

По умолчанию выбрано значение 16.
Background schedule pool size Консоль управления API Terraform

Количество потоков для выполнения фоновых задач. Применяется для реплицируемых таблиц, стримов в Apache Kafka® и обновления IP-адресов записей во внутреннем DNS-кеше.

По умолчанию выбрано значение 128.
Default database Консоль управления API

База данных по умолчанию. Инструкцию о получении списка баз данных в кластере см. в разделе Управление базами данных.
Geobase uri Консоль управления CLI API Terraform

Адрес архива с пользовательской геобазой в Object Storage.
Keep alive timeout Консоль управления CLI API Terraform

Время (в секундах) от поступления последнего запроса к ClickHouse до разрыва соединения. Если за это время поступает новый запрос, соединение не разрывается.

По умолчанию выбрано значение 3.
Log level Консоль управления CLI API Terraform

Уровень логирования событий. На каждом следующем уровне лог будет содержать всю информацию из предыдущего:
1. ERROR — информация об ошибках в работе кластера;
2. WARNING — информация о событиях, которые могут привести к ошибкам в работе кластера;
3. INFORMATION — подтверждения, информация о событиях, не приводящих к ошибкам в работе кластера;
4. DEBUG — системная информация для последующего использования в отладке;
5. TRACE — вся доступная информация о работе кластера.
Подробнее об уровнях логирования см. в документации ClickHouse.
Mark cache size Консоль управления CLI API Terraform

Приблизительный размер (в байтах) кеша засечек, используемых движками таблиц семейства MergeTree. Кеш общий для хоста кластера, память выделяется по мере необходимости.

Выбранное значение настройки не является строгим ограничением. ClickHouse может использовать чуть меньше или чуть больше памяти под этот кеш.

По умолчанию выбрано значение 5368709120.
Max concurrent queries Консоль управления CLI API Terraform

Максимальное количество одновременно обрабатываемых запросов.

Минимальное значение — 10, по умолчанию — 500.
Max connections Консоль управления CLI API Terraform

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

Минимальное значение — 10, по умолчанию — 4096.
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 можно удалять таблицы любого размера.
Metric log enabled Консоль управления CLI Terraform

Определяет, будут ли логироваться значения метрик из таблиц system.metrics и system.events в таблицу system.metric_log.

По умолчанию выбрано значение true.
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 записи хранятся бессрочно.
Min bytes for wide part Консоль управления API

Минимальное количество байт в куске данных, который может храниться в формате Wide. Можно задать одновременно с параметром Min rows for wide part.

Подробнее см. в документации ClickHouse.
Min rows for wide part Консоль управления API

Минимальное количество строк в куске данных, который может храниться в формате Wide. Можно задать одновременно с параметром Min bytes for wide part.

Подробнее см. в документации ClickHouse.
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 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 thread log enabled Консоль управления CLI Terraform

Определяет, будет ли логироваться информация о потоках, которые выполняют запросы. Логи сохраняются в таблицу system.query_thread_log.

По умолчанию выбрано значение true.

Подробнее см. в документации 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 записи хранятся бессрочно.
Text log enabled Консоль управления CLI Terraform

Определяет, будут ли записываться системные логи. Логи сохраняются в таблицу system.text_log.

По умолчанию выбрано значение false.
Text log level Консоль управления CLI Terraform

Уровень логирования событий в таблице system.text_log. На каждом следующем уровне лог будет содержать всю информацию из предыдущего:
1. ERROR — информация об ошибках в работе СУБД;
2. WARNING — информация о событиях, которые могут привести к ошибкам в работе СУБД;
3. INFORMATION — подтверждения, информация о событиях, не приводящих к ошибкам в работе СУБД;
4. DEBUG — системная информация для последующего использования в отладке;
5. TRACE — вся доступная информация о работе СУБД.
По умолчанию выбрано значение TRACE.
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.
Total memory profiler step Консоль управления API

Задает объем памяти (в байтах) для стектрейса (stack trace) на каждом шаге выделения памяти. Данные хранятся в системной таблице system.trace_log, при этом значение query_id является пустой строкой.

По умолчанию установлено значение 4194304.

Подробнее см. в документации ClickHouse.
Trace log enabled Консоль управления CLI Terraform

Определяет, будут ли логироваться стектрейсы (stack traces), собираемые профилировщиком запросов. Стектрейсы сохраняются в таблицу system.trace_log.

По умолчанию выбрано значение true.
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 записи хранятся бессрочно.
TTL only drop parts Консоль управления API

Полное удаление кусков данных из таблиц семейства MergeTree, когда время жизни всех строк в куске истекло.

Если настройка отключена, ClickHouse удаляет строки согласно их TTL. Если включена — удаляет весь кусок данных, когда время жизни всех строк в нем истекло.

Возможные значения:
- 0 — настройка отключена (по умолчанию).
- 1 — настройка включена.
Подробнее см. в документации ClickHouse.
Uncompressed cache size Консоль управления CLI API Terraform

Размер кеша (в байтах) для несжатых данных, используемых движками таблиц семейства MergeTree.

По умолчанию выбрано значение 8589934592 (8 ГБ).
Compression Консоль управления API Terraform

Правила сжатия данных для таблиц семейства MergeTree. Для каждого правила указываются:
- 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.
Graphite rollup Консоль управления API Terraform

Конфигурации движка GraphiteMergeTree для прореживания и агрегирования/усреднения (rollup) данных Graphite:
- Name — имя конфигурации.
- Patterns — набор правил прореживания. Правило применяется, если имя метрики соответствует значению параметра Regexp, а возраст данных соответствует значению группы параметров Retention.
  - Function — имя агрегирующей функции.
  - Regexp — регулярное выражение, которому должно соответствовать имя метрики.
  - Retention — параметры задержки. Функция применяется к данным, чей возраст оказался в интервале [Age, Age + Precision]. Вы можете задать несколько групп таких параметров.
    - Age — минимальный возраст данных в секундах.
    - Precision — точность определения возраста данных в секундах. Значение должно быть кратно 86400 (количеству секунд в сутках).
Вы можете настроить несколько конфигураций и использовать их для разных таблиц.

Подробнее о поддержке Graphite см. в документации ClickHouse.
Kafka Консоль управления CLI Terraform

Глобальные настройки аутентификации для интеграции с Apache Kafka®:
- Sasl mechanism — механизм аутентификации SASL:
  - GSSAPI — аутентификация c использованием 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.
Kafka topics Консоль управления CLI Terraform

Настройки аутентификации на уровне топиков для интеграции с Apache Kafka®:
- Name — имя топика Apache Kafka®.
- Settings — настройки аутентификации для топика, аналогичные глобальным настройкам аутентификации в секции Kafka.
  
  Если для таблицы на движке Kafka настройки аутентификации на уровне топика не заданы, то будут использованы глобальные настройки из секции Kafka.
  
  Подробнее см. в документации Apache Kafka®.
Merge tree Консоль управления CLI API Terraform

Конфигурация движка MergeTree:
- Max bytes to merge at min space in pool — максимальный общий размер кусков данных для слияния, когда в фоновом пуле минимум свободных ресурсов.
  
  По умолчанию выбрано значение 1048576 (1 МБ).
  
  Подробнее см. в документации ClickHouse.
- Max replicated merges in queue — максимальное количество задач слияния, которые могут одновременно находиться в очереди ReplicatedMergeTree.
  
  По умолчанию выбрано значение 16.
- Number of free entries in pool to lower max size of merge — предельное значение свободных записей в пуле. Если количество записей в пуле становится меньше этого значения, ClickHouse уменьшает максимальный размер куска данных для слияния. Это позволяет быстрее обрабатывать небольшие слияния.
  
  По умолчанию выбрано значение 8.
- Parts to delay insert — количество активных кусков данных таблицы, при превышении которого ClickHouse будет искусственно уменьшать скорость вставки данных в таблицу. Активным куском является новый кусок данных, образованный в результате слияния.
  
  По умолчанию выбрано значение 150.
- Parts to throw insert — предельное число активных кусков данных таблицы, при превышении которого ClickHouse отправляет исключение Too many parts ...
  
  По умолчанию выбрано значение 300.
  
  Подробнее см. в документации ClickHouse.
- Replicated deduplication window — число блоков последних вставок хешей, которые ZooKeeper будет хранить. Дедупликация работает только для последних вставленных данных. Старые блоки будут удалены.
  
  По умолчанию выбрано значение 100.
  
  Подробнее см. в документации ClickHouse.
- Replicated deduplication window seconds — время, в течение которого ZooKeeper хранит блоки последних вставок хешей. Дедупликация работает только для последних вставленных данных. Старые блоки будут удалены.
  
  По умолчанию выбрано значение 604800.
  
  Подробнее см. в документации ClickHouse.
Rabbitmq Консоль управления CLI API Terraform

Глобальные настройки аутентификации для интеграции с RabbitMQ:
- Password — пароль учетной записи RabbitMQ.
- Username — имя учетной записи RabbitMQ.
- Vhost — адрес виртуального хоста для RabbitMQ.

Настройки на уровне пользователя

Настройки квот

Квота позволяет ограничить потребление ресурсов ClickHouse в течение заданного интервала времени. Настройки квоты задаются для отдельно взятого пользователя.

Если пользователь превысил одно из ограничений квоты, то он не сможет выполнять новые запросы до того, как истечет интервал.
ClickHouse выведет сообщение о превышении квоты и укажет время начала нового интервала, когда запрет на выполнение запросов будет снят, а счетчики ограничений — сброшены.

ClickHouse также использует квоты для учета потребления ресурсов.
Для каждого пользователя есть квота по умолчанию, которая учитывает потребление всех ресурсов за каждый час, но не накладывает никаких ограничений.
Сведения об уровне потребления ресурсов записываются в лог сервера ClickHouse.

Подробнее см. в документации ClickHouse.

Доступны следующие настройки квот:

Interval duration Все интерфейсы

Интервал для квоты (в миллисекундах).

Минимальное значение — 1000 (одна секунда).
Errors Все интерфейсы

Ограничение на суммарное количество запросов, которые завершились с ошибкой.

Минимальное значение — 0 (нет ограничений).
Execution time Все интерфейсы

Ограничение на суммарное время выполнения запросов в миллисекундах.

Минимальное значение — 0 (нет ограничений).
Queries Все интерфейсы

Ограничение на суммарное количество запросов.

Минимальное значение — 0 (нет ограничений).
Read rows Все интерфейсы

Ограничение на суммарное число исходных строк, считанных из таблиц для выполнения запросов (включая строки, считанные на удаленных серверах).

Минимальное значение — 0 (нет ограничений).
Result rows Все интерфейсы

Ограничение на суммарное число строк в результатах запроса.

Минимальное значение — 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 ms Консоль управления API SQL

Максимальное время (в миллисекундах) ожидания вставки данных с момента первого запроса INSERT.

Значение по умолчанию — 200. Если указан 0, ожидание отключено.

Подробнее см. в документации ClickHouse.
Async insert max data size Консоль управления API SQL

Максимальный размер необработанных данных (в байтах), собранных за запрос, перед их вставкой.

Значение по умолчанию — 1000000. Если указан 0, асинхронные вставки будут отключены.

Подробнее см. в документации ClickHouse.
Async insert stale timeout ms Консоль управления API SQL

Максимальное время (в миллисекундах) ожидания вставки данных с момента последнего запроса INSERT. Если установлено ненулевое значение, Async insert busy timeout ms будет продлеваться с каждым запросом 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 Консоль управления CLI API SQL

Определяет, компилировать ли запросы при их выполнении. При включенной компиляции структурно идентичные запросы могут выполняться быстрее за счет использования скомпилированных частей запроса.

Используется вместе с настройкой Min count to compile.

По умолчанию компиляция выключена.

Подробнее см. в документации ClickHouse.
Compile expressions Консоль управления CLI API SQL

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

Используется вместе с настройкой Min count to compile expression.

По умолчанию компиляция выражений выключена.
Connect timeout Консоль управления CLI API SQL

Время ожидания соединения (в миллисекундах).

Минимальное значение — 1, по умолчанию — 10000 (10 секунд).
Connect timeout with failover ms Консоль управления API SQL

Время ожидания соединения (в миллисекундах) с удаленным сервером для движка таблиц Distributed, если кластер использует шардирование и репликацию.

Если установить соединение с сервером не удалось, будут предприняты попытки установить соединение с его репликами.

Значение по умолчанию — 50.

Подробнее см. в документации ClickHouse.
Count distinct implementation Все интерфейсы

Определяет, какая из функций uniq* используется при выполнении конструкции COUNT(DISTINCT …):
- uniq
- uniqCombined
- uniqCombined64
- uniqHLL12
- uniqExact
По умолчанию используется функция uniqExact.
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 вернет пустой результат.
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
- JSON
- Escaped
- Quoted
- Raw
По умолчанию выбрано значение 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.
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 минут).
Input format defaults for omitted fields Консоль управления CLI API SQL

Определяет, будут ли пропущенные поля заполнены значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT.

По умолчанию замена включена.

Подробнее см. в документации ClickHouse.
Input format null as default Консоль управления SQL

Определяет, заполнять ли ячейки со значением NULL значениями по умолчанию, если тип данных столбца не позволяет хранить значение NULL.

По умолчанию настройка включена (ячейки NULL заполняются значениями по умолчанию).

Подробнее см. в документации 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 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:
- hash — соединение хешированием (hash join).
- partial_merge — соединение слиянием отсортированных списков (sort-merge join).
- prefer_partial_merge — соединение merge, когда это возможно.
- auto — соединение хешированием (hash join), но если память на сервере заканчивается, ClickHouse попытается применить соединение merge.
По умолчанию используется алгоритм 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
```
По умолчанию настройка выключена.
Low cardinality allow in native format Консоль управления CLI API SQL

Определяет, использовать ли [тип LowCardinality]}(https://clickhouse.com/docs/ru/sql-reference/data-types/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 (нет ограничения).
Max expanded ast elements Консоль управления CLI API SQL

Максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки.

Для сложных запросов синтаксическое дерево может содержать слишком большое количество элементов. Настройка позволяет запретить выполнение излишне сложных или неоптимизированных запросов для больших таблиц.

По умолчанию выбрано значение 500000. Слишком маленькое значение может привести к невозможности выполнения большинства запросов.
Max http get redirects Консоль управления API SQL

Задает максимальное количество переходов по редиректам в таблицах на движке URL при выполнении HTTP-запросов методом GET.

Если установлено значение 0, переходы запрещены.

Значение по умолчанию — 0.

Подробнее см. в документации ClickHouse.
Max insert block size Консоль управления CLI API SQL

Формировать блоки указанного размера (в байтах) при вставке в таблицу. Настройка действует только когда сервер сам формирует такие блоки.

По умолчанию выбрано значение 1048576.

Подробнее см. в документации ClickHouse.
Max memory usage Консоль управления CLI API SQL

Максимальный объем оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объем свободной памяти или общий объем памяти на машине. Ограничение действует на один запрос в пределах одного сервера.

Минимальное значение — 0 (нет ограничения), по умолчанию — 10737418240 (10 ГБ). Максимальное значение ограничено настройкой Max server memory usage, значение которой нельзя изменить напрямую. Подробнее см. в разделе Управление памятью в Managed Service for ClickHouse.

Если вы используете настройки 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 partitions per insert block Консоль управления SQL

Ограничивает максимальное количество партиций в одном вставленном блоке.

Минимальное значение — 0 (количество разделов не ограничено), по умолчанию — 100.

Подробнее см. в документации ClickHouse.
Max query size Консоль управления CLI API SQL

Ограничивает размер (в байтах) наибольшей части запроса, которая может быть передана в оперативную память для разбора с помощью SQL-парсера.

Минимальное значение — 1, по умолчанию — 262144.
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 non const columns Консоль управления CLI API SQL

Максимальное количество временных столбцов, которое единовременно хранится в оперативной памяти при выполнении запроса (без учета постоянных столбцов).

Минимальное значение и значение по умолчанию — 0 (нет ограничения).
Max threads Консоль управления CLI API SQL

Максимальное количество потоков обработки запроса, без учета потоков для чтения данных с удаленных серверов. Настройка относится к потокам, которые используются для параллельного выполнения стадий конвейера запросов.

Минимальное значение и значение по умолчанию — 0 (вычислять значение автоматически как количество процессорных ядер без учета Hyper-Threading).

Подробнее см. в документации ClickHouse.
Memory profiler step Консоль управления API SQL

Шаг профилировщика памяти (в байтах). Если на следующем шаге выполнения запроса потребление памяти возрастает на число байт, большее указанного в данной настройке, то профилировщик сохраняет выделенный стектрейс. Значения менее нескольких мегабайт замедляют обработку запросов.

По умолчанию — 4194304 (4 МБ). Если задан 0 — профилировщик памяти отключен.
Memory profiler sample probability Консоль управления API SQL

Система будет с указанной вероятностью сохранять информацию о том или ином выделении и освобождении оперативной памяти в файл лога system.trace_log с типом трассировки MemorySample. Вероятность сохранения не зависит от размера выделенной/освобожденной памяти.

Возможные значения — от 0 до 1. По умолчанию — 0.
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-битных целых чисел в кавычках выключен.
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 минут).
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 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.

Пользовательские настройки

SQL

Пользовательские настройки можно переопределять, как переменные, в профиле настроек, сессии или запросе. Работа с профилями настроек доступна, если для кластера включено управление пользователями через SQL.

Название пользовательской настройки в Managed Service for ClickHouse должно начинаться с предопределенного префикса custom_. Префикс фиксированный — пользователь не может его менять.