Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Managed Service for ClickHouse
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Information about existing clusters
    • Creating clusters
    • Connecting to a database
    • Stopping and starting clusters
    • SQL queries in the management console
    • Changing cluster and database settings
    • Setting up access to ObjectStorage
    • Connecting external dictionaries
    • Adding your own geobase
    • Managing machine learning models
    • Managing data format schemas
    • Connecting to DataLens
    • Changing ClickHouse versions
    • Managing ZooKeeper hosts
    • Managing ClickHouse hosts
    • Managing databases
    • Managing database users
    • Managing backups
    • Managing shards
    • Managing groups of shards
    • Viewing cluster logs
    • Deleting clusters
    • Monitoring the state of clusters and hosts
  • Practical guidelines
    • All use cases
    • Adding data to the database
    • Sharding tables
    • Using hybrid storage
    • Getting data from Managed Service for Apache Kafka®
    • Getting data from RabbitMQ
    • Exchanging data with Yandex Data Proc
    • Configuring Yandex Cloud DNS for accessing clusters from other cloud networks
    • Analyzing Object Storage logs in DataLens
    • Configuring Managed Service for ClickHouse for Graphite
    • Saving a Yandex Data Streams data stream in Managed Service for ClickHouse
  • Concepts
    • Relationships between service resources
    • Host classes
      • Active host classes
      • Archive
        • Before June 1, 2020
      • Using deprecated host classes
    • Network in Managed Service for ClickHouse
    • Quotas and limits
    • Storage types
    • Backups
    • Replication
    • Dictionaries
    • Sharding
    • Maintenance
    • Supported clients
    • Managing memory in Managed Service for ClickHouse
    • ClickHouse versioning policy
    • ClickHouse settings
  • Access management
  • Pricing policy
    • Current pricing policy
    • Archive
      • Before January 1, 2019
      • From January 1 to March 1, 2019
      • From March 1, 2019 to February 1, 2020
  • API reference
    • Authentication in the 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
  • Revision history
  • Questions and answers
    • General questions
    • Questions about ClickHouse
    • Connection
    • Updating clusters
    • Cluster configuration
    • Moving and restoring a cluster
    • Monitoring and logs
    • All questions on one page
  1. API reference
  2. REST
  3. Cluster
  4. create

Managed Service for ClickHouse API, REST: Cluster.create

Written by
Yandex Cloud
,
improved by
amatol
  • HTTP request
  • Body parameters
  • Response

Creates a ClickHouse cluster in the specified folder.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "version": "string",
    "clickhouse": {
      "config": {
        "logLevel": "string",
        "mergeTree": {
          "replicatedDeduplicationWindow": "integer",
          "replicatedDeduplicationWindowSeconds": "integer",
          "partsToDelayInsert": "integer",
          "partsToThrowInsert": "integer",
          "inactivePartsToDelayInsert": "integer",
          "inactivePartsToThrowInsert": "integer",
          "maxReplicatedMergesInQueue": "integer",
          "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
          "maxBytesToMergeAtMinSpaceInPool": "integer",
          "maxBytesToMergeAtMaxSpaceInPool": "integer",
          "minBytesForWidePart": "integer",
          "minRowsForWidePart": "integer",
          "ttlOnlyDropParts": true,
          "allowRemoteFsZeroCopyReplication": true
        },
        "compression": [
          {
            "method": "string",
            "minPartSize": "string",
            "minPartSizeRatio": "number"
          }
        ],
        "dictionaries": [
          {
            "name": "string",
            "structure": {
              "id": {
                "name": "string"
              },
              "key": {
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "rangeMin": {
                "name": "string",
                "type": "string",
                "nullValue": "string",
                "expression": "string",
                "hierarchical": true,
                "injective": true
              },
              "rangeMax": {
                "name": "string",
                "type": "string",
                "nullValue": "string",
                "expression": "string",
                "hierarchical": true,
                "injective": true
              },
              "attributes": [
                {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                }
              ]
            },
            "layout": {
              "type": "string",
              "sizeInCells": "string"
            },

            // `configSpec.clickhouse.config.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
            "fixedLifetime": "string",
            "lifetimeRange": {
              "min": "string",
              "max": "string"
            },
            // end of the list of possible fields`configSpec.clickhouse.config.dictionaries[]`

            "httpSource": {
              "url": "string",
              "format": "string"
            },
            "mysqlSource": {
              "db": "string",
              "table": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "replicas": [
                {
                  "host": "string",
                  "priority": "string",
                  "port": "string",
                  "user": "string",
                  "password": "string"
                }
              ],
              "where": "string",
              "invalidateQuery": "string"
            },
            "clickhouseSource": {
              "db": "string",
              "table": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "where": "string"
            },
            "mongodbSource": {
              "db": "string",
              "collection": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string"
            },
            "postgresqlSource": {
              "db": "string",
              "table": "string",
              "hosts": [
                "string"
              ],
              "port": "string",
              "user": "string",
              "password": "string",
              "invalidateQuery": "string",
              "sslMode": "string"
            }
          }
        ],
        "graphiteRollup": [
          {
            "name": "string",
            "patterns": [
              {
                "regexp": "string",
                "function": "string",
                "retention": [
                  {
                    "age": "string",
                    "precision": "string"
                  }
                ]
              }
            ]
          }
        ],
        "kafka": {
          "securityProtocol": "string",
          "saslMechanism": "string",
          "saslUsername": "string",
          "saslPassword": "string"
        },
        "kafkaTopics": [
          {
            "name": "string",
            "settings": {
              "securityProtocol": "string",
              "saslMechanism": "string",
              "saslUsername": "string",
              "saslPassword": "string"
            }
          }
        ],
        "rabbitmq": {
          "username": "string",
          "password": "string",
          "vhost": "string"
        },
        "maxConnections": "integer",
        "maxConcurrentQueries": "integer",
        "keepAliveTimeout": "integer",
        "uncompressedCacheSize": "integer",
        "markCacheSize": "integer",
        "maxTableSizeToDrop": "integer",
        "maxPartitionSizeToDrop": "integer",
        "builtinDictionariesReloadInterval": "integer",
        "timezone": "string",
        "geobaseUri": "string",
        "queryLogRetentionSize": "integer",
        "queryLogRetentionTime": "integer",
        "queryThreadLogEnabled": true,
        "queryThreadLogRetentionSize": "integer",
        "queryThreadLogRetentionTime": "integer",
        "partLogRetentionSize": "integer",
        "partLogRetentionTime": "integer",
        "metricLogEnabled": true,
        "metricLogRetentionSize": "integer",
        "metricLogRetentionTime": "integer",
        "traceLogEnabled": true,
        "traceLogRetentionSize": "integer",
        "traceLogRetentionTime": "integer",
        "textLogEnabled": true,
        "textLogRetentionSize": "integer",
        "textLogRetentionTime": "integer",
        "textLogLevel": "string",
        "opentelemetrySpanLogEnabled": true,
        "backgroundPoolSize": "integer",
        "backgroundSchedulePoolSize": "integer",
        "backgroundFetchesPoolSize": "integer",
        "backgroundMovePoolSize": "integer",
        "backgroundDistributedSchedulePoolSize": "integer",
        "backgroundBufferFlushSchedulePoolSize": "integer",
        "defaultDatabase": "string",
        "totalMemoryProfilerStep": "integer",
        "totalMemoryTrackerSampleProbability": "number"
      },
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "zookeeper": {
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true,
      "webSql": true,
      "metrika": true,
      "serverless": true,
      "dataTransfer": true,
      "yandexQuery": true
    },
    "cloudStorage": {
      "enabled": true,
      "moveFactor": "number",
      "dataCacheEnabled": true,
      "dataCacheMaxSize": "integer"
    },
    "sqlDatabaseManagement": true,
    "sqlUserManagement": true,
    "adminPassword": "string",
    "embeddedKeeper": true
  },
  "databaseSpecs": [
    {
      "name": "string"
    }
  ],
  "userSpecs": [
    {
      "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"
        }
      ]
    }
  ],
  "hostSpecs": [
    {
      "zoneId": "string",
      "type": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "shardName": "string"
    }
  ],
  "networkId": "string",
  "shardName": "string",
  "serviceAccountId": "string",
  "securityGroupIds": [
    "string"
  ],
  "deletionProtection": true
}
Field Description
folderId string

Required. ID of the folder to create the ClickHouse cluster in.

The maximum string length in characters is 50.

name string

Required. Name of the ClickHouse cluster. The name must be unique within the folder.

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

description string

Description of the ClickHouse cluster.

The maximum string length in characters is 256.

labels object

Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".

No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*.

environment string

Required. Deployment environment of the ClickHouse cluster.

  • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
  • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
configSpec object

Required. Configuration and resources for hosts that should be created for the ClickHouse cluster.

configSpec.
version
string

Version of the ClickHouse server software.

configSpec.
clickhouse
object

Configuration and resources for a ClickHouse server.

configSpec.
clickhouse.
config
object

Configuration for a ClickHouse server.

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.

configSpec.
clickhouse.
config.
logLevel
string

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

configSpec.
clickhouse.
config.
mergeTree
object

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.

configSpec.
clickhouse.
config.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Number of blocks of hashes to keep in ZooKeeper.

configSpec.
clickhouse.
config.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Period of time to keep blocks of hashes for.

configSpec.
clickhouse.
config.
mergeTree.
partsToDelayInsert
integer (int64)

If table contains at least that many active parts in single partition, artificially slow down insert into table.

configSpec.
clickhouse.
config.
mergeTree.
partsToThrowInsert
integer (int64)

If more than this number active parts in single partition, throw 'Too many parts ...' exception.

configSpec.
clickhouse.
config.
mergeTree.
inactivePartsToDelayInsert
integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
inactivePartsToThrowInsert
integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
maxReplicatedMergesInQueue
integer (int64)

How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue.

configSpec.
clickhouse.
config.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge
integer (int64)

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.

configSpec.
clickhouse.
config.
mergeTree.
maxBytesToMergeAtMinSpaceInPool
integer (int64)

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).

configSpec.
clickhouse.
config.
mergeTree.
maxBytesToMergeAtMaxSpaceInPool
integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
minBytesForWidePart
integer (int64)

Minimum number of bytes in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

configSpec.
clickhouse.
config.
mergeTree.
minRowsForWidePart
integer (int64)

Minimum number of rows in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

configSpec.
clickhouse.
config.
mergeTree.
ttlOnlyDropParts
boolean (boolean)

Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables.

More info see in ClickHouse documentation.

configSpec.
clickhouse.
config.
mergeTree.
allowRemoteFsZeroCopyReplication
boolean (boolean)
configSpec.
clickhouse.
config.
compression[]
object

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.

configSpec.
clickhouse.
config.
compression[].
method
string

Compression method to use for the specified combination of minPartSize and minPartSizeRatio.

  • LZ4: LZ4 compression algorithm.
  • ZSTD: Zstandard compression algorithm.
configSpec.
clickhouse.
config.
compression[].
minPartSize
string (int64)

Minimum size of a part of a table.

The minimum value is 1.

configSpec.
clickhouse.
config.
compression[].
minPartSizeRatio
number (double)

Minimum ratio of a part relative to the size of all the data in the table.

configSpec.
clickhouse.
config.
dictionaries[]
object

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.

configSpec.
clickhouse.
config.
dictionaries[].
name
string

Required. Name of the external dictionary.

configSpec.
clickhouse.
config.
dictionaries[].
structure
object
Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
id
object

Single numeric key column for the dictionary.

Numeric key.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
id.
name
string

Required. Name of the numeric key.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key
object

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[]
object

Required. Attributes of a complex key.

Must contain at least one element.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
name
string

Required. Name of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
type
string

Required. Type of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin
object

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
name
string

Required. Name of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
type
string

Required. Type of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
nullValue
string

Default value for an element without data (for example, an empty string).

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
expression
string

Expression, describing the attribute, if applicable.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax
object

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
name
string

Required. Name of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
type
string

Required. Type of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
nullValue
string

Default value for an element without data (for example, an empty string).

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
expression
string

Expression, describing the attribute, if applicable.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[]
object

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
name
string

Required. Name of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
type
string

Required. Type of the column.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

configSpec.
clickhouse.
config.
dictionaries[].
layout
object
Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation.
configSpec.
clickhouse.
config.
dictionaries[].
layout.
type
string

Required. Layout type for an external dictionary.

  • FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
  • HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
  • COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
  • RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
  • CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
  • COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.
configSpec.
clickhouse.
config.
dictionaries[].
layout.
sizeInCells
string (int64)

Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

configSpec.
clickhouse.
config.
dictionaries[].
fixedLifetime
string (int64)
configSpec.clickhouse.config.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

Fixed interval between dictionary updates.

configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange
object
Range of intervals between dictionary updates for ClickHouse to choose from.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange
configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange.
min
string (int64)

Minimum dictionary lifetime.

configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange.
max
string (int64)

Maximum dictionary lifetime.

configSpec.
clickhouse.
config.
dictionaries[].
httpSource
object
HTTP source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
url
string

Required. URL of the source dictionary available over HTTP.

configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
format
string

Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource
object
MySQL source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
db
string

Required. Name of the MySQL database to connect to.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
table
string

Required. Name of the database table to use as a ClickHouse dictionary.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
port
string (int64)

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
user
string

Name of the default user for replicas of the dictionary source.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
password
string

Password of the default user for replicas of the dictionary source.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[]
object

Required. List of MySQL replicas of the database used as dictionary source.

Must contain at least one element.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
host
string

Required. MySQL host of the replica.

The maximum string length in characters is 253.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number.

Value must be greater than 0.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source.

Acceptable values are 0 to 65535, inclusive.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
user
string

Name of the MySQL database user.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
password
string

Password of the MySQL database user.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
where
string

Selection criteria for the data in the specified MySQL table.

configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource
object
ClickHouse source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
db
string

Required. Name of the ClickHouse database.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
host
string

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
user
string

Required. Name of the ClickHouse database user.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
password
string

Password of the ClickHouse database user.

configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
where
string

Selection criteria for the data in the specified ClickHouse table.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource
object
MongoDB source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
db
string

Required. Name of the MongoDB database.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
collection
string

Required. Name of the collection in the specified database to be used as the dictionary source.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
host
string

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
user
string

Required. Name of the MongoDB database user.

configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
password
string

Password of the MongoDB database user.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource
object
PostgreSQL source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
db
string

Required. Name of the PostrgreSQL database.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
hosts[]
string

Required. Name of the PostrgreSQL host

Must contain at least one element.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
user
string

Required. Name of the PostrgreSQL database user.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
password
string

Password of the PostrgreSQL database user.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
sslMode
string

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

  • DISABLE: Only try a non-SSL connection.
  • ALLOW: First try a non-SSL connection; if that fails, try an SSL connection.
  • PREFER: First try an SSL connection; if that fails, try a non-SSL connection.
  • VERIFY_CA: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA).
  • VERIFY_FULL: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.
configSpec.
clickhouse.
config.
graphiteRollup[]
object

Settings for thinning Graphite data. See in-depth description in ClickHouse documentation.

configSpec.
clickhouse.
config.
graphiteRollup[].
name
string

Required. Name for the specified combination of settings for Graphite rollup.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[]
object

Required. Pattern to use for the rollup.

Must contain at least one element.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
regexp
string

Pattern for metric names.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
function
string

Required. Name of the aggregating function to apply to data of the age specified in retention.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[]
object

Required. Age of data to use for thinning.

Must contain at least one element.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Minimum age of the data in seconds.

Value must be greater than 0.

configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Precision of determining the age of the data, in seconds.

Value must be greater than 0.

configSpec.
clickhouse.
config.
kafka
object
configSpec.
clickhouse.
config.
kafka.
securityProtocol
string
configSpec.
clickhouse.
config.
kafka.
saslMechanism
string
configSpec.
clickhouse.
config.
kafka.
saslUsername
string
configSpec.
clickhouse.
config.
kafka.
saslPassword
string
configSpec.
clickhouse.
config.
kafkaTopics[]
object
configSpec.
clickhouse.
config.
kafkaTopics[].
name
string

Required.

configSpec.
clickhouse.
config.
kafkaTopics[].
settings
object

Required.

configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
securityProtocol
string
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
saslMechanism
string
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
saslUsername
string
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
saslPassword
string
configSpec.
clickhouse.
config.
rabbitmq
object
configSpec.
clickhouse.
config.
rabbitmq.
username
string

RabbitMQ username

configSpec.
clickhouse.
config.
rabbitmq.
password
string

RabbitMQ password

configSpec.
clickhouse.
config.
rabbitmq.
vhost
string

RabbitMQ virtual host

configSpec.
clickhouse.
config.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

configSpec.
clickhouse.
config.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

configSpec.
clickhouse.
config.
keepAliveTimeout
integer (int64)

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.

configSpec.
clickhouse.
config.
uncompressedCacheSize
integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables.

configSpec.
clickhouse.
config.
markCacheSize
integer (int64)

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.

configSpec.
clickhouse.
config.
maxTableSizeToDrop
integer (int64)

Maximum size of the table that can be deleted using a DROP query.

configSpec.
clickhouse.
config.
maxPartitionSizeToDrop
integer (int64)

Maximum size of the partition that can be deleted using a DROP query.

configSpec.
clickhouse.
config.
builtinDictionariesReloadInterval
integer (int64)

The setting is deprecated and has no effect.

configSpec.
clickhouse.
config.
timezone
string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.

configSpec.
clickhouse.
config.
geobaseUri
string

Address of the archive with the user geobase in Object Storage.

configSpec.
clickhouse.
config.
queryLogRetentionSize
integer (int64)

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.

configSpec.
clickhouse.
config.
queryLogRetentionTime
integer (int64)

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.

configSpec.
clickhouse.
config.
queryThreadLogEnabled
boolean (boolean)

Whether query_thread_log system table is enabled.

configSpec.
clickhouse.
config.
queryThreadLogRetentionSize
integer (int64)

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.

configSpec.
clickhouse.
config.
queryThreadLogRetentionTime
integer (int64)

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.

configSpec.
clickhouse.
config.
partLogRetentionSize
integer (int64)

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.

configSpec.
clickhouse.
config.
partLogRetentionTime
integer (int64)

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.

configSpec.
clickhouse.
config.
metricLogEnabled
boolean (boolean)

Whether metric_log system table is enabled.

configSpec.
clickhouse.
config.
metricLogRetentionSize
integer (int64)

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.

configSpec.
clickhouse.
config.
metricLogRetentionTime
integer (int64)

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.

configSpec.
clickhouse.
config.
traceLogEnabled
boolean (boolean)

Whether trace_log system table is enabled.

configSpec.
clickhouse.
config.
traceLogRetentionSize
integer (int64)

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.

configSpec.
clickhouse.
config.
traceLogRetentionTime
integer (int64)

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.

configSpec.
clickhouse.
config.
textLogEnabled
boolean (boolean)

Whether text_log system table is enabled.

configSpec.
clickhouse.
config.
textLogRetentionSize
integer (int64)

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.

configSpec.
clickhouse.
config.
textLogRetentionTime
integer (int64)

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.

configSpec.
clickhouse.
config.
textLogLevel
string

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

configSpec.
clickhouse.
config.
opentelemetrySpanLogEnabled
boolean (boolean)
configSpec.
clickhouse.
config.
backgroundPoolSize
integer (int64)

Value must be greater than 0.

configSpec.
clickhouse.
config.
backgroundSchedulePoolSize
integer (int64)

Value must be greater than 0.

configSpec.
clickhouse.
config.
backgroundFetchesPoolSize
integer (int64)

Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8.

More info see in ClickHouse documentation.

Value must be greater than 0.

configSpec.
clickhouse.
config.
backgroundMovePoolSize
integer (int64)

Value must be greater than 0.

configSpec.
clickhouse.
config.
backgroundDistributedSchedulePoolSize
integer (int64)

Value must be greater than 0.

configSpec.
clickhouse.
config.
backgroundBufferFlushSchedulePoolSize
integer (int64)

Value must be greater than 0.

configSpec.
clickhouse.
config.
defaultDatabase
string

The default database.

To get a list of cluster databases, see Yandex Managed ClickHouse documentation.

configSpec.
clickhouse.
config.
totalMemoryProfilerStep
integer (int64)

Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304.

More info see in ClickHouse documentation.

configSpec.
clickhouse.
config.
totalMemoryTrackerSampleProbability
number (double)
configSpec.
clickhouse.
resources
object

Resources allocated to ClickHouse hosts.

configSpec.
clickhouse.
resources.
resourcePresetId
string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation

configSpec.
clickhouse.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
clickhouse.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
configSpec.
zookeeper
object

Configuration and resources for a ZooKeeper server.

configSpec.
zookeeper.
resources
object

Resources allocated to ZooKeeper hosts. If not set, minimal available resources will be used. All available resource presets can be retrieved with a list request.

configSpec.
zookeeper.
resources.
resourcePresetId
string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation

configSpec.
zookeeper.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
zookeeper.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
configSpec.
backupWindowStart
object

Time to start the daily backup, in the UTC timezone.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

configSpec.
backupWindowStart.
hours
integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

configSpec.
backupWindowStart.
minutes
integer (int32)

Minutes of hour of day. Must be from 0 to 59.

configSpec.
backupWindowStart.
seconds
integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

configSpec.
backupWindowStart.
nanos
integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

configSpec.
access
object

Access policy for external services.

If you want a specific service to access the ClickHouse cluster, then set the necessary values in this policy.

configSpec.
access.
dataLens
boolean (boolean)

Allow to export data from the cluster to DataLens.

configSpec.
access.
webSql
boolean (boolean)

Allow SQL queries to the cluster databases from the management console.

See SQL queries in the management console for more details.

configSpec.
access.
metrika
boolean (boolean)

Allow to import data from Yandex Metrica and AppMetrica to the cluster.

See AppMetrica documentation for more details.

configSpec.
access.
serverless
boolean (boolean)

Allow access to cluster for Serverless.

configSpec.
access.
dataTransfer
boolean (boolean)

Allow access for DataTransfer

configSpec.
access.
yandexQuery
boolean (boolean)

Allow access for Query

configSpec.
cloudStorage
object
configSpec.
cloudStorage.
enabled
boolean (boolean)

Whether to use Object Storage for storing ClickHouse data.

configSpec.
cloudStorage.
moveFactor
number (double)

Acceptable values are 0 to 1, inclusive.

configSpec.
cloudStorage.
dataCacheEnabled
boolean (boolean)
configSpec.
cloudStorage.
dataCacheMaxSize
integer (int64)
configSpec.
sqlDatabaseManagement
boolean (boolean)

Whether database management through SQL commands is enabled.

configSpec.
sqlUserManagement
boolean (boolean)

Whether user management through SQL commands is enabled.

configSpec.
adminPassword
string

Password for user 'admin' that has SQL user management access.

configSpec.
embeddedKeeper
boolean (boolean)

Whether cluster should use embedded Keeper instead of Zookeeper

databaseSpecs[] object

Required. Descriptions of databases to be created in the ClickHouse cluster.

Must contain at least one element.

databaseSpecs[].
name
string

Required. Name of the ClickHouse database. 1-63 characters long.

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

userSpecs[] object

Required. Descriptions of database users to be created in the ClickHouse cluster.

Must contain at least one element.

userSpecs[].
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_]*.

userSpecs[].
password
string

Required. Password of the ClickHouse user.

The string length in characters must be 8-128.

userSpecs[].
permissions[]
object

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

userSpecs[].
permissions[].
databaseName
string

Name of the database that the permission grants access to.

userSpecs[].
settings
object

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

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
allowIntrospectionFunctions
boolean (boolean)

Enables introspections functions for query profiling.

More info see in ClickHouse documentation.

userSpecs[].
settings.
connectTimeout
integer (int64)

Connection timeout in milliseconds.

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

Value must be greater than 0.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
insertQuorumParallel
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpecs[].
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.

userSpecs[].
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).

userSpecs[].
settings.
deduplicateBlocksInDependentMaterializedViews
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
settings.
distributedDdlTaskTimeout
integer (int64)

Timeout for DDL queries, in milliseconds.

userSpecs[].
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.

userSpecs[].
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).

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
maxBytesBeforeExternalSort
integer (int64)

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

userSpecs[].
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).

userSpecs[].
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).

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
maxPartitionsPerInsertBlock
integer (int64)

See in-depth description in ClickHouse documentation.

userSpecs[].
settings.
maxConcurrentQueriesForUser
integer (int64)

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

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
settings.
maxBytesInDistinct
integer (int64)

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

The minimum value is 0.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
maxRowsInJoin
integer (int64)

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

The minimum value is 0.

userSpecs[].
settings.
maxBytesInJoin
integer (int64)

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

The minimum value is 0.

userSpecs[].
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.

userSpecs[].
settings.
joinAlgorithm[]
string

See in-depth description in ClickHouse documentation.

userSpecs[].
settings.
anyJoinDistinctRightTableKeys
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
minExecutionSpeed
integer (int64)

Minimal execution speed in rows per second.

The minimum value is 0.

userSpecs[].
settings.
minExecutionSpeedBytes
integer (int64)

Minimal execution speed in bytes per second.

The minimum value is 0.

userSpecs[].
settings.
countDistinctImplementation
string

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

userSpecs[].
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.

userSpecs[].
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).

userSpecs[].
settings.
inputFormatNullAsDefault
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpecs[].
settings.
dateTimeInputFormat
string

See in-depth description in ClickHouse documentation.

userSpecs[].
settings.
inputFormatWithNamesUseHeader
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpecs[].
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).

userSpecs[].
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).

userSpecs[].
settings.
dateTimeOutputFormat
string

See in-depth description in ClickHouse documentation.

userSpecs[].
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).

userSpecs[].
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.

userSpecs[].
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.
userSpecs[].
settings.
httpConnectionTimeout
integer (int64)

HTTP connection timeout, in milliseconds.

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

userSpecs[].
settings.
httpReceiveTimeout
integer (int64)

HTTP receive timeout, in milliseconds.

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

userSpecs[].
settings.
httpSendTimeout
integer (int64)

HTTP send timeout, in milliseconds.

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

userSpecs[].
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.

userSpecs[].
settings.
sendProgressInHttpHeaders
boolean (boolean)

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

Default value: false (notifications disabled).

userSpecs[].
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).

userSpecs[].
settings.
addHttpCorsHeader
boolean (boolean)

Adds CORS header in HTTP responses.

Default value: false (header is not added).

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
joinedSubqueryRequiresAlias
boolean (boolean)
userSpecs[].
settings.
joinUseNulls
boolean (boolean)
userSpecs[].
settings.
transformNullIn
boolean (boolean)
userSpecs[].
settings.
quotaMode
string

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

userSpecs[].
settings.
flattenNested
boolean (boolean)

Sets the data format of a nested columns.

More info see in ClickHouse documentation.

userSpecs[].
settings.
formatRegexp
string

Regular expression (for Regexp format)

userSpecs[].
settings.
formatRegexpEscapingRule
string

See in-depth description in ClickHouse documentation.

userSpecs[].
settings.
formatRegexpSkipUnmatched
boolean (boolean)

See in-depth description in ClickHouse documentation.

userSpecs[].
settings.
asyncInsert
boolean (boolean)

Enables asynchronous inserts.

Disabled by default.

More info see in ClickHouse documentation.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
waitForAsyncInsertTimeout
integer (int64)

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

Default value: 120.

More info see in ClickHouse documentation.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
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.

userSpecs[].
settings.
compile
boolean (boolean)

The setting is deprecated and has no effect.

userSpecs[].
settings.
minCountToCompile
integer (int64)

The setting is deprecated and has no effect.

userSpecs[].
quotas[]
object

Set of quotas assigned to the user.

userSpecs[].
quotas[].
intervalDuration
integer (int64)

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

The minimum value is 1000.

userSpecs[].
quotas[].
queries
integer (int64)

The total number of queries. 0 - unlimited.

The minimum value is 0.

userSpecs[].
quotas[].
errors
integer (int64)

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

The minimum value is 0.

userSpecs[].
quotas[].
resultRows
integer (int64)

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

The minimum value is 0.

userSpecs[].
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.

userSpecs[].
quotas[].
executionTime
integer (int64)

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

The minimum value is 0.

hostSpecs[] object

Required. Individual configurations for hosts that should be created for the ClickHouse cluster.

Must contain at least one element.

hostSpecs[].
zoneId
string

ID of the availability zone where the host resides. To get a list of available zones, use the list request.

The maximum string length in characters is 50.

hostSpecs[].
type
string

Required. Type of the host to be deployed.

  • CLICKHOUSE: ClickHouse host.
  • ZOOKEEPER: ZooKeeper host.
hostSpecs[].
subnetId
string

ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.networkId field.

The maximum string length in characters is 50.

hostSpecs[].
assignPublicIp
boolean (boolean)

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assignPublicIp set as needed.

Possible values:

  • false - don't assign a public IP to the host.
  • true - the host should have a public IP address.
hostSpecs[].
shardName
string

Name of the shard that the host is assigned to.

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

networkId string

Required. ID of the network to create the cluster in.

The maximum string length in characters is 50.

shardName string

Name of the first shard in cluster. If not set, defaults to the value 'shard1'.

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

serviceAccountId string

ID of the service account used for access to Object Storage.

securityGroupIds[] string

User security groups

deletionProtection boolean (boolean)

Deletion Protection inhibits deletion of the cluster

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.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Body parameters
  • Response