Связаться с намиПодключиться

Managed Service for ClickHouse API, REST: Cluster.update

Статья создана
Улучшена
Обновлена 4 сентября 2024 г.

Updates the specified ClickHouse cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId

Required. ID of the ClickHouse Cluster resource to update. To get the ClickHouse cluster ID, use a list request.

The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "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,
          "mergeWithTtlTimeout": "integer",
          "mergeWithRecompressionTtlTimeout": "integer",
          "maxPartsInTotal": "integer",
          "maxNumberOfMergesWithTtlInPool": "integer",
          "cleanupDelayPeriod": "integer",
          "numberOfFreeEntriesInPoolToExecuteMutation": "integer",
          "maxAvgPartSizeForTooManyParts": "integer",
          "minAgeToForceMergeSeconds": "integer",
          "minAgeToForceMergeOnPartitionOnly": true,
          "mergeSelectingSleepMs": "integer",
          "mergeMaxBlockSize": "integer",
          "checkSampleColumnIsCorrect": true,
          "maxMergeSelectingSleepMs": "integer",
          "maxCleanupDelayPeriod": "integer"
        },
        "compression": [
          {
            "method": "string",
            "minPartSize": "string",
            "minPartSizeRatio": "number",
            "level": "integer"
          }
        ],
        "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",
              "maxArraySize": "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",
              "headers": [
                {
                  "name": "string",
                  "value": "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",
              "closeConnection": true,
              "shareConnection": true
            },
            "clickhouseSource": {
              "db": "string",
              "table": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "where": "string",
              "secure": true
            },
            "mongodbSource": {
              "db": "string",
              "collection": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "options": "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"
                  }
                ]
              }
            ],
            "pathColumnName": "string",
            "timeColumnName": "string",
            "valueColumnName": "string",
            "versionColumnName": "string"
          }
        ],
        "kafka": {
          "securityProtocol": "string",
          "saslMechanism": "string",
          "saslUsername": "string",
          "saslPassword": "string",
          "enableSslCertificateVerification": true,
          "maxPollIntervalMs": "integer",
          "sessionTimeoutMs": "integer",
          "debug": "string",
          "autoOffsetReset": "string"
        },
        "kafkaTopics": [
          {
            "name": "string",
            "settings": {
              "securityProtocol": "string",
              "saslMechanism": "string",
              "saslUsername": "string",
              "saslPassword": "string",
              "enableSslCertificateVerification": true,
              "maxPollIntervalMs": "integer",
              "sessionTimeoutMs": "integer",
              "debug": "string",
              "autoOffsetReset": "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",
        "geobaseEnabled": true,
        "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,
        "opentelemetrySpanLogRetentionSize": "integer",
        "opentelemetrySpanLogRetentionTime": "integer",
        "queryViewsLogEnabled": true,
        "queryViewsLogRetentionSize": "integer",
        "queryViewsLogRetentionTime": "integer",
        "asynchronousMetricLogEnabled": true,
        "asynchronousMetricLogRetentionSize": "integer",
        "asynchronousMetricLogRetentionTime": "integer",
        "sessionLogEnabled": true,
        "sessionLogRetentionSize": "integer",
        "sessionLogRetentionTime": "integer",
        "zookeeperLogEnabled": true,
        "zookeeperLogRetentionSize": "integer",
        "zookeeperLogRetentionTime": "integer",
        "asynchronousInsertLogEnabled": true,
        "asynchronousInsertLogRetentionSize": "integer",
        "asynchronousInsertLogRetentionTime": "integer",
        "backgroundPoolSize": "integer",
        "backgroundMergesMutationsConcurrencyRatio": "integer",
        "backgroundSchedulePoolSize": "integer",
        "backgroundFetchesPoolSize": "integer",
        "backgroundMovePoolSize": "integer",
        "backgroundDistributedSchedulePoolSize": "integer",
        "backgroundBufferFlushSchedulePoolSize": "integer",
        "backgroundMessageBrokerSchedulePoolSize": "integer",
        "backgroundCommonPoolSize": "integer",
        "defaultDatabase": "string",
        "totalMemoryProfilerStep": "integer",
        "totalMemoryTrackerSampleProbability": "number",
        "queryMaskingRules": [
          {
            "name": "string",
            "regexp": "string",
            "replace": "string"
          }
        ],
        "dictionariesLazyLoad": true,
        "queryCache": {
          "maxSizeInBytes": "integer",
          "maxEntries": "integer",
          "maxEntrySizeInBytes": "integer",
          "maxEntrySizeInRows": "integer"
        }
      },
      "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",
      "preferNotToMerge": true
    },
    "sqlDatabaseManagement": true,
    "sqlUserManagement": true,
    "adminPassword": "string",
    "embeddedKeeper": true,
    "backupRetainPeriodDays": "integer"
  },
  "name": "string",
  "serviceAccountId": "string",
  "maintenanceWindow": {

    // `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": {},
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    },
    // end of the list of possible fields`maintenanceWindow`

  },
  "securityGroupIds": [
    "string"
  ],
  "deletionProtection": true,
  "networkId": "string"
}
Field Description
updateMask string

Field mask that specifies which fields of the ClickHouse Cluster resource should be updated.

A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
description string

New 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".

The new set of labels will completely replace the old ones. To add a label, request the current set with the get method, then send an update request with the new label added to the set.

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]*.
configSpec object

New configuration and resources for hosts in the 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.
mergeTree.
mergeWithTtlTimeout		 integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
mergeWithRecompressionTtlTimeout		 integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
maxPartsInTotal		 integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
maxNumberOfMergesWithTtlInPool		 integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
cleanupDelayPeriod		 integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
numberOfFreeEntriesInPoolToExecuteMutation		 integer (int64)
configSpec.
clickhouse.
config.
mergeTree.
maxAvgPartSizeForTooManyParts		 integer (int64)

The 'too many parts' check according to 'parts_to_delay_insert' and 'parts_to_throw_insert' will be active only if the average part size (in the relevant partition) is not larger than the specified threshold. If it is larger than the specified threshold, the INSERTs will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. Default: 1 GiB Min version: 22.10 See in-depth description in ClickHouse GitHub

The minimum value is 0.
configSpec.
clickhouse.
config.
mergeTree.
minAgeToForceMergeSeconds		 integer (int64)

Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds. Default: 0 - disabled Min_version: 22.10 See in-depth description in ClickHouse documentation

The minimum value is 0.
configSpec.
clickhouse.
config.
mergeTree.
minAgeToForceMergeOnPartitionOnly		 boolean (boolean)

Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. Default: false Min_version: 22.11 See in-depth description in ClickHouse documentation
configSpec.
clickhouse.
config.
mergeTree.
mergeSelectingSleepMs		 integer (int64)

Sleep time for merge selecting when no part is selected. A lower setting triggers selecting tasks in background_schedule_pool frequently, which results in a large number of requests to ClickHouse Keeper in large-scale clusters. Default: 5000 Min_version: 21.10 See in-depth description in ClickHouse documentation

Value must be greater than 0.
configSpec.
clickhouse.
config.
mergeTree.
mergeMaxBlockSize		 integer (int64)

The number of rows that are read from the merged parts into memory. Default: 8192 See in-depth description in ClickHouse documentation

Value must be greater than 0.
configSpec.
clickhouse.
config.
mergeTree.
checkSampleColumnIsCorrect		 boolean (boolean)

Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. Default: true See in-depth description in ClickHouse documentation
configSpec.
clickhouse.
config.
mergeTree.
maxMergeSelectingSleepMs		 integer (int64)

Maximum sleep time for merge selecting, a lower setting will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to zookeeper in large-scale clusters. Default: 60000 Min_version: 23.6 See in-depth description in ClickHouse GitHub

The minimum value is 0.
configSpec.
clickhouse.
config.
mergeTree.
maxCleanupDelayPeriod		 integer (int64)

Maximum period to clean old queue logs, blocks hashes and parts. Default: 300 Min_version: 23.6 See in-depth description in ClickHouse GitHub

The minimum value is 0.
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.
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.
compression[].
level		 integer (int64)

The minimum value is 0.
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[].
layout.
maxArraySize		 string (int64)

Maximum dictionary key size. Applicable only for FLAT layout type.
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[].
httpSource.
headers[]		 object

HTTP headers.
configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
headers[].
name		 string

Required.
configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
headers[].
value		 string

Required.
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[].
mysqlSource.
closeConnection		 boolean (boolean)

Should the connection be closed after each request.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
shareConnection		 boolean (boolean)

Should a connection be shared for some requests.
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

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[].
clickhouseSource.
secure		 boolean (boolean)

Use ssl for connection.
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

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[].
mongodbSource.
options		 string
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.

The minimum value is 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.
graphiteRollup[].
pathColumnName		 string

The name of the column storing the metric name (Graphite sensor). Default: Path See in-depth description in ClickHouse documentation
configSpec.
clickhouse.
config.
graphiteRollup[].
timeColumnName		 string

The name of the column storing the time of measuring the metric. Default: Time See in-depth description in ClickHouse documentation
configSpec.
clickhouse.
config.
graphiteRollup[].
valueColumnName		 string

The name of the column storing the value of the metric at the time set in time_column_name. Default: Value See in-depth description in ClickHouse documentation
configSpec.
clickhouse.
config.
graphiteRollup[].
versionColumnName		 string

The name of the column storing the version of the metric. Default: Timestamp See in-depth description in ClickHouse documentation
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.
kafka.
enableSslCertificateVerification		 boolean (boolean)
configSpec.
clickhouse.
config.
kafka.
maxPollIntervalMs		 integer (int64)

The minimum value is 0.
configSpec.
clickhouse.
config.
kafka.
sessionTimeoutMs		 integer (int64)

The minimum value is 0.
configSpec.
clickhouse.
config.
kafka.
debug		 string
configSpec.
clickhouse.
config.
kafka.
autoOffsetReset		 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.
kafkaTopics[].
settings.
enableSslCertificateVerification		 boolean (boolean)
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
maxPollIntervalMs		 integer (int64)

The minimum value is 0.
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
sessionTimeoutMs		 integer (int64)

The minimum value is 0.
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
debug		 string
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
autoOffsetReset		 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.
geobaseEnabled		 boolean (boolean)

Enable or disable geobase.
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)

Enable or disable opentelemetry_span_log system table. Default value: false.
configSpec.
clickhouse.
config.
opentelemetrySpanLogRetentionSize		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
opentelemetrySpanLogRetentionTime		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
queryViewsLogEnabled		 boolean (boolean)

Enable or disable query_views_log system table. Default value: false.
configSpec.
clickhouse.
config.
queryViewsLogRetentionSize		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
queryViewsLogRetentionTime		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
asynchronousMetricLogEnabled		 boolean (boolean)

Enable or disable asynchronous_metric_log system table. Default value: false.
configSpec.
clickhouse.
config.
asynchronousMetricLogRetentionSize		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
asynchronousMetricLogRetentionTime		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
sessionLogEnabled		 boolean (boolean)

Enable or disable session_log system table. Default value: false.
configSpec.
clickhouse.
config.
sessionLogRetentionSize		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
sessionLogRetentionTime		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
zookeeperLogEnabled		 boolean (boolean)

Enable or disable zookeeper_log system table. Default value: false.
configSpec.
clickhouse.
config.
zookeeperLogRetentionSize		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
zookeeperLogRetentionTime		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
asynchronousInsertLogEnabled		 boolean (boolean)

Enable or disable asynchronous_insert_log system table. Default value: false. Minimal required ClickHouse version: 22.10.
configSpec.
clickhouse.
config.
asynchronousInsertLogRetentionSize		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
asynchronousInsertLogRetentionTime		 integer (int64)

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

The minimum value is 0.
configSpec.
clickhouse.
config.
backgroundPoolSize		 integer (int64)

Value must be greater than 0.
configSpec.
clickhouse.
config.
backgroundMergesMutationsConcurrencyRatio		 integer (int64)

Sets a ratio between the number of threads and the number of background merges and mutations that can be executed concurrently. For example, if the ratio equals to 2 and background_pool_size is set to 16 then ClickHouse can execute 32 background merges concurrently. This is possible, because background operations could be suspended and postponed. This is needed to give small merges more execution priority. You can only increase this ratio at runtime. To lower it you have to restart the server. The same as for background_pool_size setting background_merges_mutations_concurrency_ratio could be applied from the default profile for backward compatibility. Default: 2 See in-depth description in ClickHouse documentation

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.
backgroundMessageBrokerSchedulePoolSize		 integer (int64)

Value must be greater than 0.
configSpec.
clickhouse.
config.
backgroundCommonPoolSize		 integer (int64)

The maximum number of threads that will be used for performing a variety of operations (mostly garbage collection) for *MergeTree-engine tables in a background. Default: 8 See in-depth description in ClickHouse documentation

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.
config.
queryMaskingRules[]		 object

Required. Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, system.query_log, system.text_log, system.processes tables, and in logs sent to the client. That allows preventing sensitive data leakage from SQL queries (like names, emails, personal identifiers or credit card numbers) to logs. Change of these settings is applied with ClickHouse restart See in-depth description in ClickHouse documentation

Must contain at least one element.
configSpec.
clickhouse.
config.
queryMaskingRules[].
name		 string

Name for the rule.
configSpec.
clickhouse.
config.
queryMaskingRules[].
regexp		 string

Required. RE2 compatible regular expression. Required.
configSpec.
clickhouse.
config.
queryMaskingRules[].
replace		 string

Substitution string for sensitive data. Default: six asterisks
configSpec.
clickhouse.
config.
dictionariesLazyLoad		 boolean (boolean)

Lazy loading of dictionaries. Default: true See in-depth description in ClickHouse documentation
configSpec.
clickhouse.
config.
queryCache		 object

Query cache configuration. Min version: 23.5 See in-depth description in ClickHouse documentation
configSpec.
clickhouse.
config.
queryCache.
maxSizeInBytes		 integer (int64)

The maximum cache size in bytes. Default: 1073741824 (1 GiB)

The minimum value is 0.
configSpec.
clickhouse.
config.
queryCache.
maxEntries		 integer (int64)

The maximum number of SELECT query results stored in the cache. Default: 1024

The minimum value is 0.
configSpec.
clickhouse.
config.
queryCache.
maxEntrySizeInBytes		 integer (int64)

The maximum size in bytes SELECT query results may have to be saved in the cache. Dafault: 1048576 (1 MiB)

The minimum value is 0.
configSpec.
clickhouse.
config.
queryCache.
maxEntrySizeInRows		 integer (int64)

The maximum number of rows SELECT query results may have to be saved in the cache. Default: 30000000 (30 mil)

The minimum value is 0.
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.
cloudStorage.
preferNotToMerge		 boolean (boolean)
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
configSpec.
backupRetainPeriodDays		 integer (int64)

Retain period of automatically created backup in days
name string

New name for the cluster.

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.
maintenanceWindow object

New maintenance window settings for the cluster.

A maintenance window settings.
maintenanceWindow.
anytime		 object
Maintenance operation can be scheduled anytime.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow		 object
Maintenance operation can be scheduled on a weekly basis.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow.
day		 string

Day of the week (in DDD format).
maintenanceWindow.
weeklyMaintenanceWindow.
hour		 string (int64)

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.
securityGroupIds[] string

User security groups
deletionProtection boolean (boolean)

Deletion Protection inhibits deletion of the cluster
networkId string

ID of the network to move the cluster to.

The maximum string length in characters is 50.

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.
Предыдущая
streamLogs
Следующая
updateExternalDictionary