Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Managed Service for ClickHouse
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к базе данных
    • Остановка и запуск кластера
    • SQL-запросы в консоли управления
    • Изменение настроек кластера и базы данных
    • Настройка доступа к ObjectStorage
    • Подключение внешних словарей
    • Подключение собственной геобазы
    • Управление моделями машинного обучения
    • Управление схемами формата данных
    • Подключение к DataLens
    • Изменение версии ClickHouse
    • Управление хостами ZooKeeper
    • Управление хостами ClickHouse
    • Управление базами данных
    • Управление пользователями БД
    • Управление резервными копиями
    • Управление шардами
    • Управление группами шардов
    • Просмотр логов кластера
    • Удаление кластера
    • Мониторинг состояния кластера и хостов
  • Практические руководства
    • Все сценарии
    • Добавление данных в БД
    • Шардирование таблиц
    • Использование гибридного хранилища
    • Получение данных из Managed Service for Apache Kafka®
    • Получение данных из RabbitMQ
    • Обмен данными с Yandex Data Proc
    • Настройка Yandex Cloud DNS для доступа к кластеру из других облачных сетей
    • Анализ логов Object Storage при помощи DataLens
    • Настройка Managed Service for ClickHouse для Graphite
    • Сохранение потока данных Yandex Data Streams в Managed Service for ClickHouse
    • Миграция базы данных из Google BigQuery в Managed Service for ClickHouse
    • Поставка данных из Yandex Managed Service for Apache Kafka® с помощью Yandex Data Transfer
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Классы хостов
      • Действующие классы хостов
      • Архив
        • До 1 июня 2020 года
      • Использование устаревших классов хостов
    • Сеть в Managed Service for ClickHouse
    • Квоты и лимиты
    • Типы дисков
    • Резервные копии
    • Репликация
    • Словари
    • Шардирование
    • Техническое обслуживание
    • Поддерживаемые клиенты
    • Управление памятью в Managed Service for ClickHouse
    • Политика работы с версиями ClickHouse
    • Настройки ClickHouse
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
      • С 1 января до 1 марта 2019 года
      • С 1 марта 2019 года до 1 февраля 2020 года
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • BackupService
      • ClusterService
      • DatabaseService
      • FormatSchemaService
      • MlModelService
      • ResourcePresetService
      • UserService
      • VersionsService
      • OperationService
    • REST (англ.)
      • Overview
      • Backup
        • Overview
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • addShard
        • addZookeeper
        • backup
        • create
        • createExternalDictionary
        • createShardGroup
        • delete
        • deleteExternalDictionary
        • deleteHosts
        • deleteShard
        • deleteShardGroup
        • get
        • getShard
        • getShardGroup
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • listShardGroups
        • listShards
        • move
        • rescheduleMaintenance
        • restore
        • start
        • stop
        • streamLogs
        • update
        • updateExternalDictionary
        • updateHosts
        • updateShard
        • updateShardGroup
      • Database
        • Overview
        • create
        • delete
        • get
        • list
      • FormatSchema
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • MlModel
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • ResourcePreset
        • Overview
        • get
        • list
      • User
        • Overview
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
      • Versions
        • Overview
        • list
      • Operation
        • Overview
        • get
  • История изменений
  • Вопросы и ответы
    • Общие вопросы
    • Вопросы о ClickHouse
    • Подключение
    • Изменение кластера
    • Настройки параметров кластера
    • Перемещение и восстановление кластера
    • Мониторинг и логи
    • Все вопросы на одной странице
  1. Справочник API
  2. REST (англ.)
  3. User
  4. create

Managed Service for ClickHouse API, REST: User.create

Статья создана
Yandex Cloud
  • HTTP request
  • Path parameters
  • Body parameters
  • Response

Creates a ClickHouse user in the specified cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId

Required. ID of the ClickHouse cluster to create a user in. To get the cluster ID, use a list request.

The maximum string length in characters is 50.

Body parameters

{
  "userSpec": {
    "name": "string",
    "password": "string",
    "permissions": [
      {
        "databaseName": "string"
      }
    ],
    "settings": {
      "readonly": "integer",
      "allowDdl": true,
      "allowIntrospectionFunctions": true,
      "connectTimeout": "integer",
      "connectTimeoutWithFailover": "integer",
      "receiveTimeout": "integer",
      "sendTimeout": "integer",
      "timeoutBeforeCheckingExecutionSpeed": "integer",
      "insertQuorum": "integer",
      "insertQuorumTimeout": "integer",
      "insertQuorumParallel": true,
      "insertNullAsDefault": true,
      "selectSequentialConsistency": true,
      "deduplicateBlocksInDependentMaterializedViews": true,
      "replicationAlterPartitionsSync": "integer",
      "maxReplicaDelayForDistributedQueries": "integer",
      "fallbackToStaleReplicasForDistributedQueries": true,
      "distributedProductMode": "string",
      "distributedAggregationMemoryEfficient": true,
      "distributedDdlTaskTimeout": "integer",
      "skipUnavailableShards": true,
      "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",
      "maxPartitionsPerInsertBlock": "integer",
      "maxConcurrentQueriesForUser": "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",
      "maxRowsInSet": "integer",
      "maxBytesInSet": "integer",
      "setOverflowMode": "string",
      "maxRowsInJoin": "integer",
      "maxBytesInJoin": "integer",
      "joinOverflowMode": "string",
      "joinAlgorithm": [
        "string"
      ],
      "anyJoinDistinctRightTableKeys": true,
      "maxColumnsToRead": "integer",
      "maxTemporaryColumns": "integer",
      "maxTemporaryNonConstColumns": "integer",
      "maxQuerySize": "integer",
      "maxAstDepth": "integer",
      "maxAstElements": "integer",
      "maxExpandedAstElements": "integer",
      "minExecutionSpeed": "integer",
      "minExecutionSpeedBytes": "integer",
      "countDistinctImplementation": "string",
      "inputFormatValuesInterpretExpressions": true,
      "inputFormatDefaultsForOmittedFields": true,
      "inputFormatNullAsDefault": true,
      "dateTimeInputFormat": "string",
      "inputFormatWithNamesUseHeader": true,
      "outputFormatJsonQuote_64BitIntegers": true,
      "outputFormatJsonQuoteDenormals": true,
      "dateTimeOutputFormat": "string",
      "lowCardinalityAllowInNativeFormat": true,
      "allowSuspiciousLowCardinalityTypes": true,
      "emptyResultForAggregationByEmptySet": true,
      "httpConnectionTimeout": "integer",
      "httpReceiveTimeout": "integer",
      "httpSendTimeout": "integer",
      "enableHttpCompression": true,
      "sendProgressInHttpHeaders": true,
      "httpHeadersProgressInterval": "integer",
      "addHttpCorsHeader": true,
      "cancelHttpReadonlyQueriesOnClientClose": true,
      "maxHttpGetRedirects": "integer",
      "joinedSubqueryRequiresAlias": true,
      "joinUseNulls": true,
      "transformNullIn": true,
      "quotaMode": "string",
      "flattenNested": true,
      "formatRegexp": "string",
      "formatRegexpEscapingRule": "string",
      "formatRegexpSkipUnmatched": true,
      "asyncInsert": true,
      "asyncInsertThreads": "integer",
      "waitForAsyncInsert": true,
      "waitForAsyncInsertTimeout": "integer",
      "asyncInsertMaxDataSize": "integer",
      "asyncInsertBusyTimeout": "integer",
      "asyncInsertStaleTimeout": "integer",
      "memoryProfilerStep": "integer",
      "memoryProfilerSampleProbability": "number",
      "compile": true,
      "minCountToCompile": "integer"
    },
    "quotas": [
      {
        "intervalDuration": "integer",
        "queries": "integer",
        "errors": "integer",
        "resultRows": "integer",
        "readRows": "integer",
        "executionTime": "integer"
      }
    ]
  }
}
Field Description
userSpec object

Required. Properties of the user to be created.

userSpec.
name
string

Required. Name of the ClickHouse user.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.

userSpec.
password
string

Required. Password of the ClickHouse user.

The string length in characters must be 8-128.

userSpec.
permissions[]
object

Set of permissions to grant to the user. If not set, it's granted permissions to access all databases.

userSpec.
permissions[].
databaseName
string

Name of the database that the permission grants access to.

userSpec.
settings
object

ClickHouse user settings. Supported settings are a limited subset of all settings described in ClickHouse documentation.

userSpec.
settings.
readonly
integer (int64)

Restricts permissions for non-DDL queries. To restrict permissions for DDL queries, use allowDdl instead.

  • 0 (default)-no restrictions.
  • 1-only read data queries are allowed.
  • 2-read data and change settings queries are allowed.

See in-depth description in ClickHouse documentation.

Acceptable values are 0 to 2, inclusive.

userSpec.
settings.
allowDdl
boolean (boolean)

Determines whether DDL queries are allowed (e.g., CREATE, ALTER, RENAME, etc).

Default value: true.

See in-depth description in ClickHouse documentation.

userSpec.
settings.
allowIntrospectionFunctions
boolean (boolean)

Enables introspections functions for query profiling.

More info see in ClickHouse documentation.

userSpec.
settings.
connectTimeout
integer (int64)

Connection timeout in milliseconds.

Value must be greater than 0 (default: 10000, 10 seconds).

Value must be greater than 0.

userSpec.
settings.
connectTimeoutWithFailover
integer (int64)

The timeout in milliseconds for connecting to a remote server for a Distributed table engine. Applies only if the cluster uses sharding and replication. If unsuccessful, several attempts are made to connect to various replicas.

Default value: 50.

More info see in ClickHouse documentation.

Value must be greater than 0.

userSpec.
settings.
receiveTimeout
integer (int64)

Receive timeout in milliseconds.

Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes).

Value must be greater than 0.

userSpec.
settings.
sendTimeout
integer (int64)

Send timeout in milliseconds.

Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes).

Value must be greater than 0.

userSpec.
settings.
timeoutBeforeCheckingExecutionSpeed
integer (int64)

Timeout (in seconds) between checks of execution speed. It is checked that execution speed is not less that specified in minExecutionSpeed parameter.

Default value: 10.

userSpec.
settings.
insertQuorum
integer (int64)

Enables or disables write quorum for ClickHouse cluster. If the value is less than 2, then write quorum is disabled, otherwise it is enabled.

When used, write quorum guarantees that ClickHouse has written data to the quorum of insert_quorum replicas with no errors until the insertQuorumTimeout expires. All replicas in the quorum are in the consistent state, meaning that they contain linearized data from the previous INSERT queries. Employ write quorum, if you need the guarantees that the written data would not be lost in case of one or more replicas failure.

You can use selectSequentialConsistency setting to read the data written with write quorum.

See in-depth description in ClickHouse documentation.

The minimum value is 0.

userSpec.
settings.
insertQuorumTimeout
integer (int64)

Quorum write timeout in milliseconds.

If the write quorum is enabled in the cluster, this timeout expires and some data is not written to the insertQuorum replicas, then ClickHouse will abort the execution of INSERT query and return an error. In this case, the client must send the query again to write the data block into the same or another replica.

Minimum value: 1000, 1 second (default: 60000, 1 minute).

The minimum value is 1000.

userSpec.
settings.
insertQuorumParallel
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpec.
settings.
insertNullAsDefault
boolean (boolean)

Enables the insertion of default values instead of NULL into columns with not nullable data type.

Default value: true.

More info see in ClickHouse documentation.

userSpec.
settings.
selectSequentialConsistency
boolean (boolean)

Determines the behavior of SELECT queries from the replicated table: if enabled, ClickHouse will terminate a query with error message in case the replica does not have a chunk written with the quorum and will not read the parts that have not yet been written with the quorum.

Default value: false (sequential consistency is disabled).

userSpec.
settings.
deduplicateBlocksInDependentMaterializedViews
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpec.
settings.
replicationAlterPartitionsSync
integer (int64)

Wait mode for asynchronous actions in ALTER queries on replicated tables:

  • 0-do not wait for replicas.
  • 1-only wait for own execution (default).
  • 2-wait for all replicas.

See in-depth description in ClickHouse documentation.

Acceptable values are 0 to 2, inclusive.

userSpec.
settings.
maxReplicaDelayForDistributedQueries
integer (int64)

Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one.

Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes).

See in-depth description in ClickHouse documentation.

The minimum value is 1000.

userSpec.
settings.
fallbackToStaleReplicasForDistributedQueries
boolean (boolean)

Enables or disables query forcing to a stale replica in case the actual data is unavailable. If enabled, ClickHouse will choose the most up-to-date replica and force the query to use the data in this replica. This setting can be used when doing SELECT query from a distributed table that points to replicated tables.

Default value: true (query forcing is enabled).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
distributedProductMode
string

Determine the behavior of distributed subqueries.

See in-depth description in ClickHouse documentation.

  • DISTRIBUTED_PRODUCT_MODE_DENY: Default value. Prohibits using these types of subqueries (returns the "Double-distributed in/JOIN subqueries is denied" exception).
  • DISTRIBUTED_PRODUCT_MODE_LOCAL: Replaces the database and table in the subquery with local ones for the destination server (shard), leaving the normal IN/JOIN.
  • DISTRIBUTED_PRODUCT_MODE_GLOBAL: Replaces the IN/JOIN query with GLOBAL IN/GLOBAL JOIN.
  • DISTRIBUTED_PRODUCT_MODE_ALLOW: Allows the use of these types of subqueries.
userSpec.
settings.
distributedAggregationMemoryEfficient
boolean (boolean)

Enables of disables memory saving mode when doing distributed aggregation.

When ClickHouse works with a distributed query, external aggregation is done on remote servers. Enable this setting to achieve a smaller memory footprint on the server that sourced such a distributed query.

Default value: false (memory saving mode is disabled).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
distributedDdlTaskTimeout
integer (int64)

Timeout for DDL queries, in milliseconds.

userSpec.
settings.
skipUnavailableShards
boolean (boolean)

Enables or disables silent skipping of unavailable shards.

A shard is considered unavailable if all its replicas are also unavailable.

Default value: false (silent skipping is disabled).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
compileExpressions
boolean (boolean)

Enables or disables expression compilation. If you execute a lot of queries that contain identical expressions, then enable this setting. As a result, such queries may be executed faster due to use of compiled expressions.

Use this setting in combination with minCountToCompileExpression setting.

Default value: false (expression compilation is disabled).

userSpec.
settings.
minCountToCompileExpression
integer (int64)

How many identical expressions ClickHouse has to encounter before they are compiled.

Minimum value: 0 (default: 3).

For the 0 value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. It is recommended to set this value only for testing purposes.

For all other values, compilation is asynchronous: the compilation process executes in a separate thread. When a compiled expression is ready, it will be used by ClickHouse for eligible queries, including the ones that are currently running.

The minimum value is 0.

userSpec.
settings.
maxBlockSize
integer (int64)

The maximum block size for reading.

Data in ClickHouse is organized and processed by blocks (block is a set of columns' parts). The internal processing cycles for a single block are efficient enough, but there are noticeable expenditures on each block.

This setting is a recommendation for size of block (in a count of rows) that should be loaded from tables.

Value must be greater than 0 (default: 65536).

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

userSpec.
settings.
minInsertBlockSizeRows
integer (int64)

Limits the minimum number of rows in a block to be inserted in a table by INSERT query. Blocks that are smaller than the specified value, will be squashed together into the bigger blocks.

Minimal value: 0, block squashing is disabled (default: 1048576).

The minimum value is 0.

userSpec.
settings.
minInsertBlockSizeBytes
integer (int64)

Limits the minimum number of bytes in a block to be inserted in a table by INSERT query. Blocks that are smaller than the specified value, will be squashed together into the bigger blocks.

Minimal value: 0, block squashing is disabled (default: 268435456, 256 MB).

The minimum value is 0.

userSpec.
settings.
maxInsertBlockSize
integer (int64)

Allows to form blocks of the specified size (in bytes) when inserting data in a table. This setting has effect only if server is creating such blocks by itself.

Value must be greater than 0 (default: 1048576).

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

userSpec.
settings.
minBytesToUseDirectIo
integer (int64)

Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O).

By default, ClickHouse does not read data directly from disk, but relies on the filesystem and its cache instead. Such reading strategy is effective when the data volume is small. If the amount of the data to read is huge, it is more effective to read directly from the disk, bypassing the filesystem cache.

If the total amount of the data to read is greater than the value of this setting, then ClickHouse will fetch this data directly from the disk.

Minimal value and default value: 0, Direct I/O is disabled.

The minimum value is 0.

userSpec.
settings.
useUncompressedCache
boolean (boolean)

Determines whether to use the cache of uncompressed blocks, or not. Using this cache can significantly reduce latency and increase the throughput when a huge amount of small queries is to be processed. Enable this setting for the users who instantiates small queries frequently.

This setting has effect only for tables of the MergeTree family.

Default value: false (uncompressed cache is disabled).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
mergeTreeMaxRowsToUseCache
integer (int64)

Limits the maximum size in rows of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value.

Use this setting in combination with useUncompressedCache setting.

Value must be greater than 0 (default: 128x8192).

Value must be greater than 0.

userSpec.
settings.
mergeTreeMaxBytesToUseCache
integer (int64)

Limits the maximum size in bytes of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value.

Use this setting in combination with useUncompressedCache setting.

Value must be greater than 0 (default: 192x10x1024x1024).

Value must be greater than 0.

userSpec.
settings.
mergeTreeMinRowsForConcurrentRead
integer (int64)

Limits the minimum number of rows to be read from a file to enable concurrent read. If the number of rows to be read exceeds this value, then ClickHouse will try to use a few threads to read from a file concurrently.

This setting has effect only for tables of the MergeTree family.

Value must be greater than 0 (default: 20x8192).

Value must be greater than 0.

userSpec.
settings.
mergeTreeMinBytesForConcurrentRead
integer (int64)

Limits the number of bytes to be read from a file to enable concurrent read. If the number of bytes to be read exceeds this value, then ClickHouse will try to use a few threads to read from a file concurrently.

This setting has effect only for tables of the MergeTree family.

Value must be greater than 0 (default: 24x10x1024x1024).

Value must be greater than 0.

userSpec.
settings.
maxBytesBeforeExternalGroupBy
integer (int64)

Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the GROUP BY operation, should be flushed to disk to limit the RAM comsumption.

By default, aggregation is done by employing hash table that resides in RAM. A query can result in aggregation of huge data volumes that can lead to memory exhaustion and abortion of the query (see the maxMemoryUsage setting). For such queries, you can use this setting to force ClickHouse to do flushing and complete aggregation successfully.

Minimal value and default value: 0, GROUP BY in the external memory is disabled.

When using aggregation in external memory, it is recommended to set the value of this setting twice as low as the maxMemoryUsage setting value (by default, the maximum memory usage is limited to ten gigabytes).

See in-depth description in ClickHouse documentation.

See also: the distributedAggregationMemoryEfficient setting.

userSpec.
settings.
maxBytesBeforeExternalSort
integer (int64)

This setting is equivalent of the maxBytesBeforeExternalGroupBy setting, except for it is for sort operation (ORDER BY), not aggregation.

userSpec.
settings.
groupByTwoLevelThreshold
integer (int64)

Sets the threshold of the number of keys, after that the two-level aggregation should be used.

Minimal value: 0, threshold is not set (default: 10000).

userSpec.
settings.
groupByTwoLevelThresholdBytes
integer (int64)

Sets the threshold of the number of bytes, after that the two-level aggregation should be used.

Minimal value: 0, threshold is not set (default: 100000000).

userSpec.
settings.
priority
integer (int64)

Sets the priority of a query.

  • 0-priority is not used.
  • 1-the highest priority.
  • and so on. The higher the number, the lower a query's priority.

This setting should be set up for each query individually.

If ClickHouse is working with the high-priority queries, and a low-priority query enters, then the low-priority query is paused until higher-priority queries are completed.

Minimal value and default value: 0, priority is not used.

The minimum value is 0.

userSpec.
settings.
maxThreads
integer (int64)

Limits the maximum number of threads to process the request (setting does not take threads that read data from remote servers into account).

This setting applies to threads that perform the same stages of the query processing pipeline in parallel.

Minimal value and default value: 0 (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account).

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

userSpec.
settings.
maxMemoryUsage
integer (int64)

Limits the maximum memory usage (in bytes) for processing of a single user's query on a single server. This setting does not take server's free RAM amount or total RAM amount into account.

This limitation is enforced for any user's single query on a single server.

Minimal value: 0, no limitation is set. Value that is set in the ClickHouse default config file: 10737418240 (10 GB).

If you use maxBytesBeforeExternalGroupBy or maxBytesBeforeExternalSort setting, then it is recommended to set their values twice as low as maxMemoryUsage setting value.

See in-depth description in ClickHouse documentation.

The minimum value is 0.

userSpec.
settings.
maxMemoryUsageForUser
integer (int64)

Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. This setting does not take server's free RAM amount or total RAM amount into account.

This limitation is enforced for all queries that belong to one user and run simultaneously on a single server.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxNetworkBandwidth
integer (int64)

The maximum speed of data exchange over the network in bytes per second for a query.

Minimal value and default value: 0, no limitation is set.

userSpec.
settings.
maxNetworkBandwidthForUser
integer (int64)

The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries.

Minimal value and default value: 0, no limitation is set.

userSpec.
settings.
maxPartitionsPerInsertBlock
integer (int64)

See in-depth description in ClickHouse documentation.

userSpec.
settings.
maxConcurrentQueriesForUser
integer (int64)

The maximum number of concurrent requests per user. Default value: 0 (no limit).

userSpec.
settings.
forceIndexByDate
boolean (boolean)

If enabled, query is not executed if the ClickHouse can't use index by date. This setting has effect only for tables of the MergeTree family.

Default value: false (setting is disabled, query executes even if ClickHouse can't use index by date).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
forcePrimaryKey
boolean (boolean)

If enabled, query is not executed if the ClickHouse can't use index by primary key. This setting has effect only for tables of the MergeTree family.

Default value: false (setting is disabled, query executes even if ClickHouse can't use index by primary key).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
maxRowsToRead
integer (int64)

Limits the maximum number of rows that can be read from a table when running a query.

Minimal value and default value: 0, no limitation is set.

See in-depth description in ClickHouse documentation.

The minimum value is 0.

userSpec.
settings.
maxBytesToRead
integer (int64)

Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
readOverflowMode
string

Determines the behavior on exceeding limits while reading the data.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
userSpec.
settings.
maxRowsToGroupBy
integer (int64)

Limits the maximum number of unique keys received from aggregation function. This setting helps to reduce RAM consumption while doing aggregation.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
groupByOverflowMode
string

Determines the behavior on exceeding limits while doing aggregation.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
  • any-perform approximate GROUP BY operation by continuing aggregation for the keys that got into the set, but don't add new keys to the set.
userSpec.
settings.
maxRowsToSort
integer (int64)

Limits the maximum number of rows that can be read from a table for sorting. This setting helps to reduce RAM consumption.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxBytesToSort
integer (int64)

Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting. This setting helps to reduce RAM consumption.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
sortOverflowMode
string

Determines the behavior on exceeding limits while sorting.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
userSpec.
settings.
maxResultRows
integer (int64)

Limits the number of rows in the result. This limitation is also checked for subqueries and parts of distributed queries that run on remote servers.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxResultBytes
integer (int64)

Limits the number of bytes in the result. This limitation is also checked for subqueries and parts of distributed queries that run on remote servers.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
resultOverflowMode
string

Determines the behavior on exceeding limits while forming result.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
userSpec.
settings.
maxRowsInDistinct
integer (int64)

Limits the maximum number of different rows when using DISTINCT.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxBytesInDistinct
integer (int64)

Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.

The minimum value is 0.

userSpec.
settings.
distinctOverflowMode
string

Determines the behavior on exceeding limits while doing DISCTINCT.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
userSpec.
settings.
maxRowsToTransfer
integer (int64)

Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxBytesToTransfer
integer (int64)

Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
transferOverflowMode
string

Determines the behavior on exceeding limits while doing transfers.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
userSpec.
settings.
maxExecutionTime
integer (int64)

Limits the maximum query execution time in milliseconds. At this moment, this limitation is not checked when passing one of the sorting stages, as well as merging and finalizing aggregation funictions.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
timeoutOverflowMode
string

Determines the behavior on exceeding limits of execution time.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
userSpec.
settings.
maxRowsInSet
integer (int64)

Limit on the number of rows in the set resulting from the execution of the IN section.

The minimum value is 0.

userSpec.
settings.
maxBytesInSet
integer (int64)

Limit on the number of bytes in the set resulting from the execution of the IN section.

The minimum value is 0.

userSpec.
settings.
setOverflowMode
string

Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.

userSpec.
settings.
maxRowsInJoin
integer (int64)

Limit on maximum size of the hash table for JOIN, in rows.

The minimum value is 0.

userSpec.
settings.
maxBytesInJoin
integer (int64)

Limit on maximum size of the hash table for JOIN, in bytes.

The minimum value is 0.

userSpec.
settings.
joinOverflowMode
string

Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.

userSpec.
settings.
joinAlgorithm[]
string

See in-depth description in ClickHouse documentation.

userSpec.
settings.
anyJoinDistinctRightTableKeys
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpec.
settings.
maxColumnsToRead
integer (int64)

Limits the maximum number of columns that can be read from a table in a single query. If the query requires to read more columns to complete, then it will be aborted.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxTemporaryColumns
integer (int64)

Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxTemporaryNonConstColumns
integer (int64)

Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.

Minimal value and default value: 0, no limitation is set.

The minimum value is 0.

userSpec.
settings.
maxQuerySize
integer (int64)

Limits the size of the part of a query that can be transferred to RAM for parsing with the SQL parser, in bytes.

Value must be greater than 0 (default: 262144).

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

userSpec.
settings.
maxAstDepth
integer (int64)

Limits the maximum depth of query syntax tree.

Executing a big and complex query may result in building a syntax tree of enormous depth. By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.

For example, the **SELECT *** query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. A user can be forced to construct more optimized queries, if this setting is used.

Value must be greater than 0 (default: 1000). If a too small value is set, it may render ClickHouse unable to execute even simple queries.

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

userSpec.
settings.
maxAstElements
integer (int64)

Limits the maximum size of query syntax tree in number of nodes.

Executing a big and complex query may result in building a syntax tree of enormous size. By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.

Value must be greater than 0 (default: 50000). If a too small value is set, it may render ClickHouse unable to execute even simple queries.

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

userSpec.
settings.
maxExpandedAstElements
integer (int64)

Limits the maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk values.

Executing a big and complex query may result in building a syntax tree of enormous size. By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.

Value must be greater than 0 (default: 500000). If a too small value is set, it may render ClickHouse unable to execute even simple queries.

Value must be greater than 0.

userSpec.
settings.
minExecutionSpeed
integer (int64)

Minimal execution speed in rows per second.

The minimum value is 0.

userSpec.
settings.
minExecutionSpeedBytes
integer (int64)

Minimal execution speed in bytes per second.

The minimum value is 0.

userSpec.
settings.
countDistinctImplementation
string

Aggregate function to use for implementation of count(DISTINCT ...).

userSpec.
settings.
inputFormatValuesInterpretExpressions
boolean (boolean)

Enables or disables SQL parser if the fast stream parser cannot parse the data.

Enable this setting, if the data that you want to insert into a table contains SQL expressions.

For example, the stream parser is unable to parse a value that contains now() expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. With enabled SQL parser, this expression is parsed correctly: the now() expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result.

This setting has effect only if you use Values format when inserting data.

Default value: true (SQL parser is enabled).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
inputFormatDefaultsForOmittedFields
boolean (boolean)

Enables or disables replacing omitted input values with default values of the respective columns when performing INSERT queries.

Default value: true (replacing is enabled).

userSpec.
settings.
inputFormatNullAsDefault
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpec.
settings.
dateTimeInputFormat
string

See in-depth description in ClickHouse documentation.

userSpec.
settings.
inputFormatWithNamesUseHeader
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpec.
settings.
outputFormatJsonQuote_64BitIntegers
boolean (boolean)

Enables quoting of 64-bit integers in JSON output format.

If this setting is enabled, then 64-bit integers (UInt64 and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. Otherwise, such integers will not be quoted.

Default value: false (quoting 64-bit integers is disabled).

userSpec.
settings.
outputFormatJsonQuoteDenormals
boolean (boolean)

Enables special floating-point values (+nan, -nan, +inf and -inf) in JSON output format.

Default value: false (special values do not present in output).

userSpec.
settings.
dateTimeOutputFormat
string

See in-depth description in ClickHouse documentation.

userSpec.
settings.
lowCardinalityAllowInNativeFormat
boolean (boolean)

Determines whether to use LowCardinality type in Native format.

  • true (default)-yes, use.
  • false-convert LowCardinality columns to regular columns when doing SELECT, and convert regular columns to LowCardinality when doing INSERT.

LowCardinality columns (aka sparse columns) store data in more effective way, compared to regular columns, by using hash tables. If data to insert suits this storage format, ClickHouse will place them into LowCardinality column.

If you use a third-party ClickHouse client that can't work with LowCardinality columns, then this client will not be able to correctly interpret the result of the query that asks for data stored in LowCardinality column. Disable this setting to convert LowCardinality column to regular column when creating the result, so such clients will be able to process the result.

Official ClickHouse client works with LowCardinality columns out-of-the-box.

Default value: true (LowCardinality columns are used in Native format).

userSpec.
settings.
allowSuspiciousLowCardinalityTypes
boolean (boolean)

Allows specifying LowCardinality modifier for types of small fixed size (8 or less) in CREATE TABLE statements. Enabling this may increase merge times and memory consumption.

More info see in ClickHouse documentation.

userSpec.
settings.
emptyResultForAggregationByEmptySet
boolean (boolean)

Enables returning of empty result when aggregating without keys (with GROUP BY operation absent) on empty set (e.g., SELECT count(*) FROM table WHERE 0).

  • true-ClickHouse will return an empty result for such queries.
  • false (default)-ClickHouse will return a single-line result consisting of NULL values for aggregation functions, in accordance with SQL standard.
userSpec.
settings.
httpConnectionTimeout
integer (int64)

HTTP connection timeout, in milliseconds.

Value must be greater than 0 (default: 1000, 1 second).

userSpec.
settings.
httpReceiveTimeout
integer (int64)

HTTP receive timeout, in milliseconds.

Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes).

userSpec.
settings.
httpSendTimeout
integer (int64)

HTTP send timeout, in milliseconds.

Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes).

userSpec.
settings.
enableHttpCompression
boolean (boolean)

Enables or disables data compression in HTTP responses.

By default, ClickHouse stores data compressed. When executing a query, its result is uncompressed. Use this setting to command ClickHouse to compress the result when sending it via HTTP.

Enable this setting and add the Accept-Encoding: HTTP header in a HTTP request to force compression of HTTP response from ClickHouse.

ClickHouse support the following compression methods: gzip, br and deflate.

Default value: false (compression is disabled).

See in-depth description in ClickHouse documentation.

userSpec.
settings.
sendProgressInHttpHeaders
boolean (boolean)

Enables progress notifications using X-ClickHouse-Progress HTTP header.

Default value: false (notifications disabled).

userSpec.
settings.
httpHeadersProgressInterval
integer (int64)

Minimum interval between progress notifications with X-ClickHouse-Progress HTTP header, in milliseconds.

Value must be greater than 0 (default: 100).

userSpec.
settings.
addHttpCorsHeader
boolean (boolean)

Adds CORS header in HTTP responses.

Default value: false (header is not added).

userSpec.
settings.
cancelHttpReadonlyQueriesOnClientClose
boolean (boolean)

Cancels HTTP read-only queries (e.g. SELECT) when a client closes the connection without waiting for the response.

Default value: false.

More info see in ClickHouse documentation.

userSpec.
settings.
maxHttpGetRedirects
integer (int64)

Limits the maximum number of HTTP GET redirect hops for URL-engine tables.

If the parameter is set to 0 (default), no hops is allowed.

More info see in ClickHouse documentation.

userSpec.
settings.
joinedSubqueryRequiresAlias
boolean (boolean)
userSpec.
settings.
joinUseNulls
boolean (boolean)
userSpec.
settings.
transformNullIn
boolean (boolean)
userSpec.
settings.
quotaMode
string

Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

userSpec.
settings.
flattenNested
boolean (boolean)

Sets the data format of a nested columns.

More info see in ClickHouse documentation.

userSpec.
settings.
formatRegexp
string

Regular expression (for Regexp format)

userSpec.
settings.
formatRegexpEscapingRule
string

See in-depth description in ClickHouse documentation.

userSpec.
settings.
formatRegexpSkipUnmatched
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpec.
settings.
asyncInsert
boolean (boolean)

Enables asynchronous inserts.

Disabled by default.

More info see in ClickHouse documentation.

userSpec.
settings.
asyncInsertThreads
integer (int64)

The maximum number of threads for background data parsing and insertion.

If the parameter is set to 0, asynchronous insertions are disabled. Default value: 16.

More info see in ClickHouse documentation.

userSpec.
settings.
waitForAsyncInsert
boolean (boolean)

Enables waiting for processing of asynchronous insertion. If enabled, server returns OK only after the data is inserted.

More info see in ClickHouse documentation.

userSpec.
settings.
waitForAsyncInsertTimeout
integer (int64)

The timeout (in seconds) for waiting for processing of asynchronous insertion.

Default value: 120.

More info see in ClickHouse documentation.

userSpec.
settings.
asyncInsertMaxDataSize
integer (int64)

The maximum size of the unparsed data in bytes collected per query before being inserted.

If the parameter is set to 0, asynchronous insertions are disabled. Default value: 100000.

More info see in ClickHouse documentation.

userSpec.
settings.
asyncInsertBusyTimeout
integer (int64)

The maximum timeout in milliseconds since the first INSERT query before inserting collected data.

If the parameter is set to 0, the timeout is disabled. Default value: 200.

More info see in ClickHouse documentation.

userSpec.
settings.
asyncInsertStaleTimeout
integer (int64)

The maximum timeout in milliseconds since the last INSERT query before dumping collected data. If enabled, the settings prolongs the asyncInsertBusyTimeout with every INSERT query as long as asyncInsertMaxDataSize is not exceeded.

More info see in ClickHouse documentation.

userSpec.
settings.
memoryProfilerStep
integer (int64)

Memory profiler step (in bytes).

If the next query step requires more memory than this parameter specifies, the memory profiler collects the allocating stack trace. Values lower than a few megabytes slow down query processing.

Default value: 4194304 (4 MB). Zero means disabled memory profiler.

userSpec.
settings.
memoryProfilerSampleProbability
number (double)

Collect random allocations and deallocations and write them into system.trace_log with 'MemorySample' trace_type. The probability is for every alloc/free regardless to the size of the allocation.

Possible values: from 0 to 1. Default: 0.

userSpec.
settings.
compile
boolean (boolean)

The setting is deprecated and has no effect.

userSpec.
settings.
minCountToCompile
integer (int64)

The setting is deprecated and has no effect.

userSpec.
quotas[]
object

Set of quotas assigned to the user.

userSpec.
quotas[].
intervalDuration
integer (int64)

Duration of interval for quota in milliseconds. Minimal value is 1 second.

The minimum value is 1000.

userSpec.
quotas[].
queries
integer (int64)

The total number of queries. 0 - unlimited.

The minimum value is 0.

userSpec.
quotas[].
errors
integer (int64)

The number of queries that threw exception. 0 - unlimited.

The minimum value is 0.

userSpec.
quotas[].
resultRows
integer (int64)

The total number of rows given as the result.. 0 - unlimited.

The minimum value is 0.

userSpec.
quotas[].
readRows
integer (int64)

The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited.

The minimum value is 0.

userSpec.
quotas[].
executionTime
integer (int64)

The total query execution time, in milliseconds (wall time). 0 - unlimited.

The minimum value is 0.

Response

HTTP Code: 200 - OK

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

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.

description string

Description of the operation. 0-256 characters long.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy string

ID of the user or service account who initiated the operation.

modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Path parameters
  • Body parameters
  • Response