Подключиться
Yandex Managed Service for ClickHouse

Метод create

Создает пользователя ClickHouse в указанном кластере.

HTTP-запрос

POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/users

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера ClickHouse, в котором следует создать пользователя. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

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

{
  "userSpec": {
    "name": "string",
    "password": "string",
    "permissions": [
      {
        "databaseName": "string"
      }
    ],
    "settings": {
      "readonly": "integer",
      "allowDdl": true,
      "insertQuorum": "integer",
      "connectTimeout": "integer",
      "receiveTimeout": "integer",
      "sendTimeout": "integer",
      "insertQuorumTimeout": "integer",
      "selectSequentialConsistency": true,
      "maxReplicaDelayForDistributedQueries": "integer",
      "fallbackToStaleReplicasForDistributedQueries": true,
      "replicationAlterPartitionsSync": "integer",
      "distributedProductMode": "string",
      "distributedAggregationMemoryEfficient": true,
      "distributedDdlTaskTimeout": "integer",
      "skipUnavailableShards": true,
      "compile": true,
      "minCountToCompile": "integer",
      "compileExpressions": true,
      "minCountToCompileExpression": "integer",
      "maxBlockSize": "integer",
      "minInsertBlockSizeRows": "integer",
      "minInsertBlockSizeBytes": "integer",
      "maxInsertBlockSize": "integer",
      "minBytesToUseDirectIo": "integer",
      "useUncompressedCache": true,
      "mergeTreeMaxRowsToUseCache": "integer",
      "mergeTreeMaxBytesToUseCache": "integer",
      "mergeTreeMinRowsForConcurrentRead": "integer",
      "mergeTreeMinBytesForConcurrentRead": "integer",
      "maxBytesBeforeExternalGroupBy": "integer",
      "maxBytesBeforeExternalSort": "integer",
      "groupByTwoLevelThreshold": "integer",
      "groupByTwoLevelThresholdBytes": "integer",
      "priority": "integer",
      "maxThreads": "integer",
      "maxMemoryUsage": "integer",
      "maxMemoryUsageForUser": "integer",
      "maxNetworkBandwidth": "integer",
      "maxNetworkBandwidthForUser": "integer",
      "forceIndexByDate": true,
      "forcePrimaryKey": true,
      "maxRowsToRead": "integer",
      "maxBytesToRead": "integer",
      "readOverflowMode": "string",
      "maxRowsToGroupBy": "integer",
      "groupByOverflowMode": "string",
      "maxRowsToSort": "integer",
      "maxBytesToSort": "integer",
      "sortOverflowMode": "string",
      "maxResultRows": "integer",
      "maxResultBytes": "integer",
      "resultOverflowMode": "string",
      "maxRowsInDistinct": "integer",
      "maxBytesInDistinct": "integer",
      "distinctOverflowMode": "string",
      "maxRowsToTransfer": "integer",
      "maxBytesToTransfer": "integer",
      "transferOverflowMode": "string",
      "maxExecutionTime": "integer",
      "timeoutOverflowMode": "string",
      "maxColumnsToRead": "integer",
      "maxTemporaryColumns": "integer",
      "maxTemporaryNonConstColumns": "integer",
      "maxQuerySize": "integer",
      "maxAstDepth": "integer",
      "maxAstElements": "integer",
      "maxExpandedAstElements": "integer",
      "inputFormatValuesInterpretExpressions": true,
      "inputFormatDefaultsForOmittedFields": true,
      "outputFormatJsonQuote_64BitIntegers": true,
      "outputFormatJsonQuoteDenormals": true,
      "lowCardinalityAllowInNativeFormat": true,
      "emptyResultForAggregationByEmptySet": true,
      "httpConnectionTimeout": "integer",
      "httpReceiveTimeout": "integer",
      "httpSendTimeout": "integer",
      "enableHttpCompression": true,
      "sendProgressInHttpHeaders": true,
      "httpHeadersProgressInterval": "integer",
      "addHttpCorsHeader": true
    },
    "quotas": [
      {
        "intervalDuration": "integer",
        "queries": "integer",
        "errors": "integer",
        "resultRows": "integer",
        "readRows": "integer",
        "executionTime": "integer"
      }
    ]
  }
}
Поле Описание
userSpec object

Обязательное поле. Свойства создаваемого пользователя.
userSpec.
name		 string

Обязательное поле. Имя пользователя базы данных ClickHouse.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
userSpec.
password		 string

Обязательное поле. Пароль пользователя ClickHouse.

Длина строки в символах должна быть от 8 до 128.
userSpec.
permissions[]		 object

Набор разрешений, которые следует предоставить пользователю.
userSpec.
permissions[].
databaseName		 string

Имя базы данных, к которой предоставляет доступ разрешение.
userSpec.
settings		 object

Пользовательские настройки ClickHouse. Поддерживаемые параметры входят в число параметров, описанных в документации ClickHouse.
userSpec.
settings.
readonly		 integer (int64)

Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку allowDdl.

  • 0 (по умолчанию) — нет ограничений.
  • 1— разрешено выполнять только запросы на чтение данных.
  • 2 — разрешено выполнять запросы на чтение данных и изменение настроек.

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

Допустимые значения — от 0 до 2 включительно.
userSpec.
settings.
allowDdl		 boolean (boolean)

Определяет, разрешены ли DDL-запросы (например, CREATE, ALTER, RENAME, и т.д.).

Значение по умолчанию: true.

См. подробное описание в документации ClickHouse.
userSpec.
settings.
insertQuorum		 integer (int64)

Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше 2, то кворумная запись выключена, в противном случае она включена.

Кворумная запись позволяет гарантировать, что за время, не большее чем insertQuorumTimeout, ClickHouse смог без ошибок записать данные в кворум из insert_quorum реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов INSERT. Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик.

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

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

Минимальное значение — 0.
userSpec.
settings.
connectTimeout		 integer (int64)

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

Значение должно быть больше 0 (по умолчанию: 10000, 10 секунд).

Значение должно быть больше 0.
userSpec.
settings.
receiveTimeout		 integer (int64)

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

Значение должно быть больше 0 (по умолчанию: 300000, 300 секунд, 5 минут).

Значение должно быть больше 0.
userSpec.
settings.
sendTimeout		 integer (int64)

Время ожидания отправки данных в миллисекундах.

Значение должно быть больше 0 (по умолчанию: 300000, 300 секунд, 5 минут).

Значение должно быть больше 0.
userSpec.
settings.
insertQuorumTimeout		 integer (int64)

Время ожидания кворумной записи в миллисекундах.

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

Минимальное значение: 1000, одна секунда (по умолчанию: 60000, одна минута).

Минимальное значение — 1000.
userSpec.
settings.
selectSequentialConsistency		 boolean (boolean)

Определяет поведение SELECT-запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут.

Значение по умолчанию: false (последовательная консистентность выключена).
userSpec.
settings.
maxReplicaDelayForDistributedQueries		 integer (int64)

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

Минимальное значение: 1000, 1 секунда (по умолчанию: 300000, 300 секунд, 5 минут).

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

Минимальное значение — 1000.
userSpec.
settings.
fallbackToStaleReplicasForDistributedQueries		 boolean (boolean)

Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении SELECT из распределенной таблицы, которая указывает на реплицированные таблицы.

Значение по умолчанию: true (форсирование запроса включено).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
replicationAlterPartitionsSync		 integer (int64)

Условия ожидания завершения асинхронных действий на репликах для запросов ALTER:

  • 0 — не ждать.
  • 1 — ждать выполнения только у себя (значение по умолчанию).
  • 2 — ждать всех.

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

Допустимые значения — от 0 до 2 включительно.
userSpec.
settings.
distributedProductMode		 string

Определяет поведение распределенных подзапросов.

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

  • DISTRIBUTED_PRODUCT_MODE_DENY: Значение по умолчанию. Запрещает использование этих типов подзапросов (возвращает исключение "Double-distributed in/JOIN subqueries is denied").
  • DISTRIBUTED_PRODUCT_MODE_LOCAL: Заменяет базу данных и таблицу в подзапросе локальными для конечного сервера (шарда), оставляя обычный IN / JOIN.
  • DISTRIBUTED_PRODUCT_MODE_GLOBAL: Заменяет IN/JOIN запрос на GLOBAL IN/GLOBAL JOIN.
  • DISTRIBUTED_PRODUCT_MODE_ALLOW: Позволяет использовать эти типы подзапросов.
userSpec.
settings.
distributedAggregationMemoryEfficient		 boolean (boolean)

Включает или выключает режим экономии памяти при распределенной агрегации.

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

Значение по умолчанию: false (режим экономии памяти выключен).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
distributedDdlTaskTimeout		 integer (int64)

Время ожидания выполнения DDL-запросов в миллисекундах.
userSpec.
settings.
skipUnavailableShards		 boolean (boolean)

Включает или выключает тихий пропуск недоступных шардов.

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

Значение по умолчанию: false (тихий пропуск недоступных шардов выключен).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
compile		 boolean (boolean)

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

Эта настройка используется совместно с minCountToCompile.

Значение по умолчанию: false (компиляция выключена).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
minCountToCompile		 integer (int64)

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

Минимальное значение: 0 (по умолчанию: 3).

Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования.

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

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

Минимальное значение — 0.
userSpec.
settings.
compileExpressions		 boolean (boolean)

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

Эта настройка используется совместно с minCountToCompileExpression.

Значение по умолчанию: false (компиляция выражений выключена).
userSpec.
settings.
minCountToCompileExpression		 integer (int64)

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

Минимальное значение: 0 (по умолчанию: 3).

Для значения 0 компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования.

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

Минимальное значение — 0.
userSpec.
settings.
maxBlockSize		 integer (int64)

Максимальный размер блока для чтения.

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

Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц.

Значение должно быть больше 0 (по умолчанию: 65536).

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

Значение должно быть больше 0.
userSpec.
settings.
minInsertBlockSizeRows		 integer (int64)

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

Минимальное значение: 0, склейка блоков выключена (по умолчанию: 1048576).

Минимальное значение — 0.
userSpec.
settings.
minInsertBlockSizeBytes		 integer (int64)

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

Минимальное значение: 0, склейка блоков выключена (по умолчанию: ‭268435456‬‬, 256 МБ).

Минимальное значение — 0.
userSpec.
settings.
maxInsertBlockSize		 integer (int64)

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

Значение должно быть больше 0 (по умолчанию: 1048576).

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

Значение должно быть больше 0.
userSpec.
settings.
minBytesToUseDirectIo		 integer (int64)

минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск.

По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы.

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

Минимальное значение и значение по умолчанию: 0 (прямой ввод/вывод отключен).

Минимальное значение — 0.
userSpec.
settings.
useUncompressedCache		 boolean (boolean)

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

Этот настройка действует только для таблиц семейства MergeTree.

Значение по умолчанию: false (кэш не используется).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
mergeTreeMaxRowsToUseCache		 integer (int64)

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

Эта настройка используется совместно с useUncompressedCache.

Значение должно быть больше 0 (по умолчанию: 128x8192).

Значение должно быть больше 0.
userSpec.
settings.
mergeTreeMaxBytesToUseCache		 integer (int64)

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

Эта настройка используется совместно с useUncompressedCache.

Значение должно быть больше 0 (по умолчанию: 192x10x1024x1024).

Значение должно быть больше 0.
userSpec.
settings.
mergeTreeMinRowsForConcurrentRead		 integer (int64)

Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков.

Этот настройка действует только для таблиц семейства MergeTree.

Значение должно быть больше 0 (по умолчанию: 20x8192).

Значение должно быть больше 0.
userSpec.
settings.
mergeTreeMinBytesForConcurrentRead		 integer (int64)

Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков.

Этот настройка действует только для таблиц семейства MergeTree.

Значение должно быть больше 0 (по умолчанию: 24x10x1024x1024).

Значение должно быть больше 0.
userSpec.
settings.
maxBytesBeforeExternalGroupBy		 integer (int64)

задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации GROUP BY, сбрасываются на диск для экономии оперативной памяти.

По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку maxMemoryUsage). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию.

Минимальное значение и значение по умолчанию: 0, GROUP BY во внешней памяти отключен.

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

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

Смотрите также настройку distributedAggregationMemoryEfficient.
userSpec.
settings.
maxBytesBeforeExternalSort		 integer (int64)

Настройка аналогична maxBytesBeforeExternalGroupBy, за исключением того, что она применяется для операции сортировки (ORDER BY).
userSpec.
settings.
groupByTwoLevelThreshold		 integer (int64)

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

Минимальное значение: 0, порог не установлен (по умолчанию: 10000‬‬).
userSpec.
settings.
groupByTwoLevelThresholdBytes		 integer (int64)

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

Минимальное значение: 0, порог не установлен (по умолчанию: 100000000‬‬).
userSpec.
settings.
priority		 integer (int64)

Определяет приоритет запроса.

  • 0 — приоритет не используется.
  • 1 — наивысший приоритет.
  • и так далее. Чем больше число, тем ниже приоритет.

Эта настройка выставляется для каждого запроса по отдельности.

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

Минимальное значение и значение по умолчанию: 0, приоритет не используется.

Минимальное значение — 0.
userSpec.
settings.
maxThreads		 integer (int64)

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

Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса.

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

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

Значение должно быть больше 0.
userSpec.
settings.
maxMemoryUsage		 integer (int64)

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

Ограничение действует на один запрос, в пределах одного сервера.

Минимальное значение: 0, нет ограничения. В конфигурационном файле по умолчанию ограничение равно 10737418240 (10 ГБ).

Если вы также используете настройки maxBytesBeforeExternalGroupBy или maxBytesBeforeExternalSort, рекомендуется, чтобы их значения были в два раза меньше значения maxMemoryUsage.

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

Минимальное значение — 0.
userSpec.
settings.
maxMemoryUsageForUser		 integer (int64)

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

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxNetworkBandwidth		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.
userSpec.
settings.
maxNetworkBandwidthForUser		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.
userSpec.
settings.
forceIndexByDate		 boolean (boolean)

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

Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
forcePrimaryKey		 boolean (boolean)

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

Значение по умолчанию: false (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxRowsToRead		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

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

Минимальное значение — 0.
userSpec.
settings.
maxBytesToRead		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
readOverflowMode		 string

Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения.

  • throw — прервать выполнение запроса, вернуть ошибку.
  • break — прервать выполнение запроса, вернуть неполный результат.
userSpec.
settings.
maxRowsToGroupBy		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
groupByOverflowMode		 string

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

  • throw — прервать выполнение запроса, вернуть ошибку.
  • break — прервать выполнение запроса, вернуть неполный результат.
  • any — выполнить GROUP BY приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор.
userSpec.
settings.
maxRowsToSort		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxBytesToSort		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
sortOverflowMode		 string

Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения.

  • throw — прервать выполнение запроса, вернуть ошибку.
  • break — прервать выполнение запроса, вернуть неполный результат.
userSpec.
settings.
maxResultRows		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxResultBytes		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
resultOverflowMode		 string

определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения.

  • throw — прервать выполнение запроса, вернуть ошибку.
  • break — прервать выполнение запроса, вернуть неполный результат.
userSpec.
settings.
maxRowsInDistinct		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxBytesInDistinct		 integer (int64)

Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании DISTINCT.

Минимальное значение — 0.
userSpec.
settings.
distinctOverflowMode		 string

Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса DISTINCT превысило ограничения.

  • throw — прервать выполнение запроса, вернуть ошибку.
  • break — прервать выполнение запроса, вернуть неполный результат.
userSpec.
settings.
maxRowsToTransfer		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxBytesToTransfer		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
transferOverflowMode		 string

Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения.

  • throw — прервать выполнение запроса, вернуть ошибку.
  • break — прервать выполнение запроса, вернуть неполный результат.
userSpec.
settings.
maxExecutionTime		 integer (int64)

Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций.

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
timeoutOverflowMode		 string

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

  • throw — прервать выполнение запроса, вернуть ошибку.
  • break — прервать выполнение запроса, вернуть неполный результат.
userSpec.
settings.
maxColumnsToRead		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxTemporaryColumns		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxTemporaryNonConstColumns		 integer (int64)

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

Минимальное значение и значение по умолчанию: 0, нет ограничения.

Минимальное значение — 0.
userSpec.
settings.
maxQuerySize		 integer (int64)

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

Значение должно быть больше 0 (по умолчанию: 262144).

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

Значение должно быть больше 0.
userSpec.
settings.
maxAstDepth		 integer (int64)

Ограничивает максимальную глубину вложенности синтаксического дерева.

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

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

Значение должно быть больше 0 (по умолчанию: 1000). Слишком маленькое значение может привести к невозможности выполнения большинства запросов.

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

Значение должно быть больше 0.
userSpec.
settings.
maxAstElements		 integer (int64)

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

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

Значение должно быть больше 0 (по умолчанию: 50000). Слишком маленькое значение может привести к невозможности выполнения большинства запросов.

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

Значение должно быть больше 0.
userSpec.
settings.
maxExpandedAstElements		 integer (int64)

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

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

Значение должно быть больше 0 (по умолчанию: 500000). Слишком маленькое значение может привести к невозможности выполнения большинства запросов.

Значение должно быть больше 0.
userSpec.
settings.
inputFormatValuesInterpretExpressions		 boolean (boolean)

Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные.

Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL.

Например, при вставке в таблицу значения, содержащего в себе выражение now(), потоковый парсер не сможет распознать это выражение; запрос INSERT завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции now() (текущая дата и время).

Эта настройка действует только в том случае, если вы используете формат Values при вставке данных.

Значение по умолчанию: true (парсер SQL включен).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
inputFormatDefaultsForOmittedFields		 boolean (boolean)

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

Значение по умолчанию: true (замена включена).
userSpec.
settings.
outputFormatJsonQuote_64BitIntegers		 boolean (boolean)

Определяет формат чисел в JSON-выводе.

Если эта настройка включена, то при выводе в JSON 64-битные числа (UInt64 и Int64) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек.

Значение по умолчанию: false (вывод 64-битных целых чисел в кавычках выключен).
userSpec.
settings.
outputFormatJsonQuoteDenormals		 boolean (boolean)

Включает вывод специальных значений для чисел с плавающей запятой (+nan, -nan, +inf и -inf) при выводе в JSON.

Значение по умолчанию: false (специальные значения не выводятся).
userSpec.
settings.
lowCardinalityAllowInNativeFormat		 boolean (boolean)

Определяет, использовать ли тип LowCardinality в Native-формате.

  • true (по умолчанию) — да, использовать.
  • false— конвертировать столбцы LowCardinality в обычные столбцы для запроса SELECT, и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса INSERT.

Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality.

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

Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality.

Значение по умолчанию: true (столбцы LowCardinality используются в Native-формате).
userSpec.
settings.
emptyResultForAggregationByEmptySet		 boolean (boolean)

Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без GROUP BY) для пустого множества (например, SELECT count(*) FROM table WHERE 0).

  • true— ClickHouse вернет пустой результат.
  • false (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями NULL для агрегатных функций, в соответствии со стандартом SQL.
userSpec.
settings.
httpConnectionTimeout		 integer (int64)

Время ожидания установления HTTP-соединения в миллисекундах.

Значение должно быть больше 0 (по умолчанию: 1000, 1 секунда).
userSpec.
settings.
httpReceiveTimeout		 integer (int64)

Время ожидания приема данных через HTTP-соединение в миллисекундах.

Значение должно быть больше 0 (по умолчанию: 1800000, 1800 секунд, 30 минут).
userSpec.
settings.
httpSendTimeout		 integer (int64)

Время ожидания отправки данных через HTTP-соединение в миллисекундах.

Значение должно быть больше 0 (по умолчанию: 1800000, 1800 секунд, 30 минут).
userSpec.
settings.
enableHttpCompression		 boolean (boolean)

Включает или выключает сжатие данных в ответе на HTTP-запрос.

По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP.

Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b.

ClickHouse поддерживает следующие методы сжатия: gzip, br и deflate.

Значение по умолчанию: false (сжатие выключено).

См. подробное описание в документации ClickHouse.
userSpec.
settings.
sendProgressInHttpHeaders		 boolean (boolean)

Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков X-ClickHouse-Progress.

Значение по умолчанию: false (отсылка уведомлений выключена).
userSpec.
settings.
httpHeadersProgressInterval		 integer (int64)

Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка X-ClickHouse-Progress.

Значение должно быть больше 0 (по умолчанию: 100).
userSpec.
settings.
addHttpCorsHeader		 boolean (boolean)

Включает заголовок CORS в HTTP-ответы.

Значение по умолчанию: false (заголовок не включается в HTTP-ответы).
userSpec.
quotas[]		 object

Представление квот ClickHouse. Каждая квота связана с пользователем и ограничивает использование ресурсов на определенный интервал. См. подробное описание в документации ClickHouse.
userSpec.
quotas[].
intervalDuration		 integer (int64)

Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда.

Минимальное значение — 1000.
userSpec.
quotas[].
queries		 integer (int64)

Общее количество запросов. 0-неограниченно.

Минимальное значение — 0.
userSpec.
quotas[].
errors		 integer (int64)

Количество запросов, которые вызвали исключение. 0-неограниченно.

Минимальное значение — 0.
userSpec.
quotas[].
resultRows		 integer (int64)

Общее число строк, приведенных в результате. 0-неограниченно.

Минимальное значение — 0.
userSpec.
quotas[].
readRows		 integer (int64)

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

Минимальное значение — 0.
userSpec.
quotas[].
executionTime		 integer (int64)

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

Минимальное значение — 0.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле Описание
id string

Идентификатор операции.
description string

Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

Строка в формате RFC3339.
createdBy string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.
done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.
error.
code		 integer (int32)

Код ошибки. Значение из списка google.rpc.Code.
error.
message		 string

Текст ошибки.
error.
details[]		 object

Список сообщений с подробными сведениями об ошибке.
response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
В этой статье: