UserService
Набор методов для управления ресурсами User для ClickHouse.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс User для ClickHouse. |
List | Получает список ресурсов User для указанного кластера ClickHouse. |
Create | Создает пользователя ClickHouse в указанном кластере. |
Update | Изменяет указанного пользователя ClickHouse. |
Delete | Удаляет указанного пользователя ClickHouse. |
GrantPermission | Предоставляет разрешение указанному пользователю ClickHouse. |
RevokePermission | Отзывает разрешение у указанного пользователя ClickHouse. |
Вызовы UserService
Get
Возвращает указанный ресурс User для ClickHouse.
Чтобы получить список доступных ресурсов User для ClickHouse, отправьте запрос List.
rpc Get (GetUserRequest) returns (User)
GetUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя запрашиваемого ресурса User для ClickHouse. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
User
Поле | Описание |
---|---|
name | string Имя пользователя базы данных ClickHouse. |
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
settings | UserSettings |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 0. |
List
Получает список ресурсов User для указанного кластера ClickHouse.
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера для вывода списка пользователей ClickHouse. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListUsersResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListUsersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListUsersResponse
Поле | Описание |
---|---|
users[] | User Список ресурсов User для ClickHouse. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListUsersRequest.page_size, используйте next_page_token в качестве значения параметра ListUsersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
User
Поле | Описание |
---|---|
name | string Имя пользователя базы данных ClickHouse. |
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
settings | UserSettings |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 0. |
Create
Создает пользователя ClickHouse в указанном кластере.
rpc Create (CreateUserRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateUserMetadata
Operation.response:User
CreateUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, в котором следует создать пользователя. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_spec | UserSpec Обязательное поле. Свойства создаваемого пользователя. |
UserSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя пользователя базы данных ClickHouse. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
password | string Обязательное поле. Пароль пользователя ClickHouse. Длина строки в символах должна быть от 8 до 128. |
permissions[] | Permission Набор разрешений, которые следует предоставить пользователю. |
settings | UserSettings |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 0. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateUserMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
CreateUserMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера ClickHouse, в котором создается пользователь. |
user_name | string Имя создаваемого пользователя. |
User
Поле | Описание |
---|---|
name | string Имя пользователя базы данных ClickHouse. |
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
settings | UserSettings |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 0. |
Update
Изменяет указанного пользователя ClickHouse.
rpc Update (UpdateUserRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateUserMetadata
Operation.response:User
UpdateUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя пользователя, которого следует изменить. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
update_mask | google.protobuf.FieldMask Маска, которая указывает, какие атрибуты пользователя ClickHouse должны быть изменены. |
password | string Новый пароль для пользователя. Длина строки в символах должна быть от 8 до 128. |
permissions[] | Permission Новый набор разрешений для пользователя. |
settings | UserSettings |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateUserMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
UpdateUserMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
user_name | string Имя изменяемого пользователя. |
User
Поле | Описание |
---|---|
name | string Имя пользователя базы данных ClickHouse. |
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
settings | UserSettings |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 0. |
Delete
Удаляет указанного пользователя ClickHouse.
rpc Delete (DeleteUserRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteUserMetadata
Operation.response:google.protobuf.Empty
DeleteUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя удаляемого пользователя. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteUserMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteUserMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
user_name | string Имя удаляемого пользователя. |
GrantPermission
Предоставляет разрешение указанному пользователю ClickHouse.
rpc GrantPermission (GrantUserPermissionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:GrantUserPermissionMetadata
Operation.response:User
GrantUserPermissionRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя пользователя, которому следует предоставить разрешение. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
permission | Permission Разрешение, которое должно быть предоставлено указанному пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<GrantUserPermissionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
GrantUserPermissionMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
user_name | string Имя пользователя, которому предоставляется разрешение. |
User
Поле | Описание |
---|---|
name | string Имя пользователя базы данных ClickHouse. |
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
settings | UserSettings |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 0. |
RevokePermission
Отзывает разрешение у указанного пользователя ClickHouse.
rpc RevokePermission (RevokeUserPermissionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:RevokeUserPermissionMetadata
Operation.response:User
RevokeUserPermissionRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера ClickHouse, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя пользователя, у которого следует отозвать разрешение. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
database_name | string Имя базы данных, к которой пользователь должен потерять доступ. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<RevokeUserPermissionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
RevokeUserPermissionMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
user_name | string Имя пользователя, чье разрешение отзывается. |
User
Поле | Описание |
---|---|
name | string Имя пользователя базы данных ClickHouse. |
cluster_id | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
settings | UserSettings |
quotas[] | UserQuota Набор квот, назначенных пользователю. |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
readonly | google.protobuf.Int64Value Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allow_ddl . - 0 (по умолчанию) — нет ограничений. - 1 — разрешено выполнять только запросы на чтение данных. - 2 — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
allow_ddl | google.protobuf.BoolValue Определяет, разрешены ли DDL-запросы (например, CREATE , ALTER , RENAME , и т.д.). Значение по умолчанию: true . См. подробное описание в документации ClickHouse. |
insert_quorum | google.protobuf.Int64Value Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2 , то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем insert_quorum_timeout , ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT . Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку select_sequential_consistency . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
connect_timeout | google.protobuf.Int64Value Время ожидания соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 10000 , 10 секунд). Значение должно быть больше 0. |
receive_timeout | google.protobuf.Int64Value Время ожидания приема данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
send_timeout | google.protobuf.Int64Value Время ожидания отправки данных в миллисекундах. Значение должно быть больше 0 (по умолчанию: 300000 , 300 секунд, 5 минут). Значение должно быть больше 0. |
insert_quorum_timeout | google.protobuf.Int64Value Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в insert_quorum реплик так не состоялась, то ClickHouse прервет выполнение INSERT -запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: 1000 , одна секунда (по умолчанию: 60000 , одна минута). Минимальная значение — 1000. |
select_sequential_consistency | google.protobuf.BoolValue Определяет поведение SELECT -запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: false (последовательная консистентность выключена). |
max_replica_delay_for_distributed_queries | google.protobuf.Int64Value Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: 1000 , 1 секунда (по умолчанию: 300000 , 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальная значение — 1000. |
fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: true (форсирование запроса включено). См. подробное описание в документации ClickHouse. |
replication_alter_partitions_sync | google.protobuf.Int64Value Условия ожидания завершения асинхронных действий на репликах для запросов ALTER : - 0 — не ждать. - 1 — ждать выполнения только у себя (значение по умолчанию). - 2 — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно. |
distributed_product_mode | enum DistributedProductMode Определяет поведение распределенных подзапросов. См. подробное описание в документации ClickHouse.
|
distributed_aggregation_memory_efficient | google.protobuf.BoolValue Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: false (режим экономии памяти выключен). См. подробное описание в документации ClickHouse. |
distributed_ddl_task_timeout | google.protobuf.Int64Value Время ожидания выполнения DDL-запросов в миллисекундах. |
skip_unavailable_shards | google.protobuf.BoolValue Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: false (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse. |
compile | google.protobuf.BoolValue Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с min_count_to_compile . Значение по умолчанию: false (компиляция выключена). См. подробное описание в документации ClickHouse. |
min_count_to_compile | google.protobuf.Int64Value После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
compile_expressions | google.protobuf.BoolValue Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с min_count_to_compile_expression . Значение по умолчанию: false (компиляция выражений выключена). |
min_count_to_compile_expression | google.protobuf.Int64Value После какого количества идентичных выражений начать их компиляцию. Минимальное значение: 0 (по умолчанию: 3 ). Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальная значение — 0. |
max_block_size | google.protobuf.Int64Value Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше 0 (по умолчанию: 65536 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_insert_block_size_rows | google.protobuf.Int64Value Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 1048576 ). Минимальная значение — 0. |
min_insert_block_size_bytes | google.protobuf.Int64Value Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом INSERT . Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: 0 , склейка блоков выключена (по умолчанию: 268435456 , 256 МБ). Минимальная значение — 0. |
max_insert_block_size | google.protobuf.Int64Value Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше 0 (по умолчанию: 1048576 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
min_bytes_to_use_direct_io | google.protobuf.Int64Value минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен). Минимальная значение — 0. |
use_uncompressed_cache | google.protobuf.BoolValue Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (кэш не используется). См. подробное описание в документации ClickHouse. |
merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 128x8192 ). Значение должно быть больше 0. |
merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с use_uncompressed_cache . Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024 ). Значение должно быть больше 0. |
merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 20x8192 ). Значение должно быть больше 0. |
merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024 ). Значение должно быть больше 0. |
max_bytes_before_external_group_by | google.protobuf.Int64Value задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY , сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку max_memory_usage ). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: 0 , GROUP BY во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки max_memory_usage (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку distributed_aggregation_memory_efficient . |
max_bytes_before_external_sort | google.protobuf.Int64Value Настройка аналогична max_bytes_before_external_group_by , за исключением того, что она применяется для операции сортировки (ORDER BY ). |
group_by_two_level_threshold | google.protobuf.Int64Value Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 10000 ). |
group_by_two_level_threshold_bytes | google.protobuf.Int64Value Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: 0 , порог не установлен (по умолчанию: 100000000 ). |
priority | google.protobuf.Int64Value Определяет приоритет запроса. - 0 — приоритет не используется. - 1 — наивысший приоритет. - и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: 0 , приоритет не используется. Минимальная значение — 0. |
max_threads | google.protobuf.Int64Value Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: 0 (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_memory_usage | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: 0 , нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ). Если вы также используете настройки max_bytes_before_external_group_by или max_bytes_before_external_sort , рекомендуется, чтобы их значения были в два раза меньше значения max_memory_usage . См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_memory_usage_for_user | google.protobuf.Int64Value Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_network_bandwidth | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
max_network_bandwidth_for_user | google.protobuf.Int64Value Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: 0 , нет ограничения. |
force_index_by_date | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse. |
force_primary_key | google.protobuf.BoolValue Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse. |
max_rows_to_read | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. См. подробное описание в документации ClickHouse. Минимальная значение — 0. |
max_bytes_to_read | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
read_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_group_by | google.protobuf.Int64Value Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
group_by_overflow_mode | enum GroupByOverflowMode Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. - any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор. |
max_rows_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_sort | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
sort_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_result_rows | google.protobuf.Int64Value Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_result_bytes | google.protobuf.Int64Value Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
result_overflow_mode | enum OverflowMode определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество различных строк при использовании DISTINCT . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_in_distinct | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT . Минимальная значение — 0. |
distinct_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_rows_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_bytes_to_transfer | google.protobuf.Int64Value Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании GLOBAL IN . Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
transfer_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_execution_time | google.protobuf.Int64Value Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
timeout_overflow_mode | enum OverflowMode Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. - throw — прервать выполнение запроса, вернуть ошибку. - break — прервать выполнение запроса, вернуть неполный результат. |
max_columns_to_read | google.protobuf.Int64Value Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_temporary_non_const_columns | google.protobuf.Int64Value Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: 0 , нет ограничения. Минимальная значение — 0. |
max_query_size | google.protobuf.Int64Value Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше 0 (по умолчанию: 262144 ). См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_depth | google.protobuf.Int64Value Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос SELECT * в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос SELECT ... WHERE ... с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше 0 (по умолчанию: 1000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 50000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0. |
max_expanded_ast_elements | google.protobuf.Int64Value Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше 0 (по умолчанию: 500000 ). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0. |
input_format_values_interpret_expressions | google.protobuf.BoolValue Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение now() , потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: true (парсер SQL включен). См. подробное описание в документации ClickHouse. |
input_format_defaults_for_omitted_fields | google.protobuf.BoolValue Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом INSERT . Значение по умолчанию: true (замена включена). |
output_format_json_quote_64bit_integers | google.protobuf.BoolValue Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа ( UInt64 и Int64 ) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен). |
output_format_json_quote_denormals | google.protobuf.BoolValue Включает вывод специальных значений для чисел с плавающей запятой ( +nan , -nan , +inf и -inf ) при выводе в JSON. Значение по умолчанию: false (специальные значения не выводятся). |
low_cardinality_allow_in_native_format | google.protobuf.BoolValue Определяет, использовать ли тип LowCardinality в Native-формате. - true (по умолчанию) — да, использовать. - false — конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT , и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT . Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате). |
empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY ) для пустого множества (например, SELECT count(*) FROM table WHERE 0 ). - true — ClickHouse вернет пустой результат. - false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL. |
http_connection_timeout | google.protobuf.Int64Value Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1000 , 1 секунда). |
http_receive_timeout | google.protobuf.Int64Value Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
http_send_timeout | google.protobuf.Int64Value Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше 0 (по умолчанию: 1800000 , 1800 секунд, 30 минут). |
enable_http_compression | google.protobuf.BoolValue Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: gzip , br и deflate . Значение по умолчанию: false (сжатие выключено). См. подробное описание в документации ClickHouse. |
send_progress_in_http_headers | google.protobuf.BoolValue Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress . Значение по умолчанию: false (отсылка уведомлений выключена). |
http_headers_progress_interval | google.protobuf.Int64Value Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress . Значение должно быть больше 0 (по умолчанию: 100 ). |
add_http_cors_header | google.protobuf.BoolValue Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: false (заголовок не включается в HTTP-ответы). |
UserQuota
Поле | Описание |
---|---|
interval_duration | google.protobuf.Int64Value Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальная значение — 1000. |
queries | google.protobuf.Int64Value Общее количество запросов. 0-неограниченно. Минимальная значение — 0. |
errors | google.protobuf.Int64Value Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальная значение — 0. |
result_rows | google.protobuf.Int64Value Общее число строк, приведенных в результате. 0-неограниченно. Минимальная значение — 0. |
read_rows | google.protobuf.Int64Value Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальная значение — 0. |
execution_time | google.protobuf.Int64Value Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальная значение — 0. |