Method get

Returns the specified ClickHouse cluster.

To get the list of available ClickHouse clusters, make a list request.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the ClickHouse Cluster resource to return. To get the cluster ID, use a list request. The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "clickhouse": {
      "config": {
        "effectiveConfig": {
          "logLevel": "string",
          "mergeTree": {
            "replicatedDeduplicationWindow": "integer",
            "replicatedDeduplicationWindowSeconds": "integer"
          },
          "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
                    }
                  ]
                },
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "layout": {
                "type": "string",
                "sizeInCells": "string"
              },

              // `config.clickhouse.config.effectiveConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`
              "fixedLifetime": "string",
              "lifetimeRange": {
                "min": "string",
                "max": "string"
              },
              // end of the list of possible fields`config.clickhouse.config.effectiveConfig.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"
              }
            }
          ],
          "graphiteRollup": [
            {
              "name": "string",
              "patterns": [
                {
                  "regexp": "string",
                  "function": "string",
                  "retention": [
                    {
                      "age": "string",
                      "precision": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "maxConnections": "integer",
          "maxConcurrentQueries": "integer",
          "keepAliveTimeout": "integer",
          "uncompressedCacheSize": "integer",
          "markCacheSize": "integer",
          "maxTableSizeToDrop": "integer",
          "maxPartitionSizeToDrop": "integer",
          "builtinDictionariesReloadInterval": "integer",
          "timezone": "string"
        },
        "userConfig": {
          "logLevel": "string",
          "mergeTree": {
            "replicatedDeduplicationWindow": "integer",
            "replicatedDeduplicationWindowSeconds": "integer"
          },
          "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
                    }
                  ]
                },
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "layout": {
                "type": "string",
                "sizeInCells": "string"
              },

              // `config.clickhouse.config.userConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`
              "fixedLifetime": "string",
              "lifetimeRange": {
                "min": "string",
                "max": "string"
              },
              // end of the list of possible fields`config.clickhouse.config.userConfig.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"
              }
            }
          ],
          "graphiteRollup": [
            {
              "name": "string",
              "patterns": [
                {
                  "regexp": "string",
                  "function": "string",
                  "retention": [
                    {
                      "age": "string",
                      "precision": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "maxConnections": "integer",
          "maxConcurrentQueries": "integer",
          "keepAliveTimeout": "integer",
          "uncompressedCacheSize": "integer",
          "markCacheSize": "integer",
          "maxTableSizeToDrop": "integer",
          "maxPartitionSizeToDrop": "integer",
          "builtinDictionariesReloadInterval": "integer",
          "timezone": "string"
        },
        "defaultConfig": {
          "logLevel": "string",
          "mergeTree": {
            "replicatedDeduplicationWindow": "integer",
            "replicatedDeduplicationWindowSeconds": "integer"
          },
          "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
                    }
                  ]
                },
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "layout": {
                "type": "string",
                "sizeInCells": "string"
              },

              // `config.clickhouse.config.defaultConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`
              "fixedLifetime": "string",
              "lifetimeRange": {
                "min": "string",
                "max": "string"
              },
              // end of the list of possible fields`config.clickhouse.config.defaultConfig.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"
              }
            }
          ],
          "graphiteRollup": [
            {
              "name": "string",
              "patterns": [
                {
                  "regexp": "string",
                  "function": "string",
                  "retention": [
                    {
                      "age": "string",
                      "precision": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "maxConnections": "integer",
          "maxConcurrentQueries": "integer",
          "keepAliveTimeout": "integer",
          "uncompressedCacheSize": "integer",
          "markCacheSize": "integer",
          "maxTableSizeToDrop": "integer",
          "maxPartitionSizeToDrop": "integer",
          "builtinDictionariesReloadInterval": "integer",
          "timezone": "string"
        }
      },
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "zookeeper": {
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}

A ClickHouse Cluster resource. For more information, see the Cluster section in the Developer's Guide.

Field Description
id string

ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.

folderId string

ID of the folder that the ClickHouse cluster belongs to.

createdAt string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

name string

Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.

description string

Description of the ClickHouse cluster. 0-256 characters long.

labels object

Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.

environment string

Deployment environment of the ClickHouse cluster.

Deployment environment.

  • 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.
monitoring[] object

Monitoring system metadata.

monitoring[].
name
string

Name of the monitoring system.

monitoring[].
description
string

Description of the monitoring system.

monitoring[].
link
string

Link to the monitoring system charts for the ClickHouse cluster.

config object

Configuration of the ClickHouse cluster.

config.
version
string

Version of the ClickHouse server software.

config.
clickhouse
object

Configuration and resource allocation for ClickHouse hosts.

config.
clickhouse.
config
object

Configuration settings of a ClickHouse server.

config.
clickhouse.
config.
effectiveConfig
object

Required. Effective settings for a ClickHouse cluster (a combination of settings defined in userConfig and [default_config]).

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

Any options not listed here are not supported.

config.
clickhouse.
config.
effectiveConfig.
logLevel
string

Logging level for the ClickHouse cluster.

config.
clickhouse.
config.
effectiveConfig.
mergeTree
object

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

Options specific to the MergeTree table engine.

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

Number of blocks of hashes to keep in ZooKeeper. See detailed description in ClickHouse sources.

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

Period of time to keep blocks of hashes for. See detailed description in ClickHouse sources.

config.
clickhouse.
config.
effectiveConfig.
compression[]
object

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

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

Compression method to use for the specified combination of min_part_size and min_part_size_ratio.

config.
clickhouse.
config.
effectiveConfig.
compression[].
minPartSize
string (int64)

Minimum size of a part of a table.

The minimum value is 1.

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

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

config.
clickhouse.
config.
effectiveConfig.
dictionaries[]
object

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

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

Required. Name of the external dictionary.

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

Single numeric key column for the dictionary.

Numeric key.

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

Required. Name of the numeric key.

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

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

Complex key.

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

Required. Attributes of a complex key.

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

Indication of hierarchy support. Default value: "false".

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

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

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

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

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

Indication of hierarchy support. Default value: "false".

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

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

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

Layout determining how to store the dictionary in memory.

config.
clickhouse.
config.
effectiveConfig.
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.
config.
clickhouse.
config.
effectiveConfig.
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.

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

Fixed interval between dictionary updates.

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange
object
Range of intervals between dictionary updates for ClickHouse to choose from.
config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Minimum dictionary lifetime.

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

Maximum dictionary lifetime.

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

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
httpSource.
url
string

Required. URL of the source dictionary available over HTTP.

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

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

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

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
db
string

Required. Name of the MySQL database to connect to.

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

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

config.
clickhouse.
config.
effectiveConfig.
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.

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

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

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

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

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

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

Must contain at least one element.

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

Required. MySQL host of the replica.

The maximum string length in characters is 253.

config.
clickhouse.
config.
effectiveConfig.
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.

config.
clickhouse.
config.
effectiveConfig.
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.

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

Name of the MySQL database user.

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

Password of the MySQL database user.

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

Selection criteria for the data in the specified MySQL table.

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

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

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

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
db
string

Required. Name of the ClickHouse database.

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

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

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

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the ClickHouse database user.

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

Password of the ClickHouse database user.

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

Selection criteria for the data in the specified ClickHouse table.

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

config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
db
string

Required. Name of the MongoDB database.

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

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

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

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the MongoDB database user.

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

Password of the MongoDB database user.

config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[]
object

Rollup settings for the GraphiteMergeTree table engine.

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

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

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

Required. Pattern to use for the rollup.

Must contain at least one element.

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

Pattern for metric names.

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

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

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

Required. Age of data to use for thinning.

Must contain at least one element.

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

Minimum age of the data in seconds.

Value must be greater than 0.

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

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

Value must be greater than 0.

config.
clickhouse.
config.
effectiveConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

config.
clickhouse.
config.
effectiveConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

config.
clickhouse.
config.
effectiveConfig.
keepAliveTimeout
integer (int64)

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

config.
clickhouse.
config.
effectiveConfig.
uncompressedCacheSize
integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
effectiveConfig.
markCacheSize
integer (int64)

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

Value must be greater than 5368709120.

config.
clickhouse.
config.
effectiveConfig.
maxTableSizeToDrop
integer (int64)

Maximum size of the table that can be deleted using a DROP query. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
effectiveConfig.
maxPartitionSizeToDrop
integer (int64)

Maximum size of the partition that can be deleted using a DROP query. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
effectiveConfig.
builtinDictionariesReloadInterval
integer (int64)

Time interval for reloading built-in dictionaries. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
effectiveConfig.
timezone
string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
userConfig
object

User-defined settings for a ClickHouse cluster.

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

Any options not listed here are not supported.

config.
clickhouse.
config.
userConfig.
logLevel
string

Logging level for the ClickHouse cluster.

config.
clickhouse.
config.
userConfig.
mergeTree
object

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

Options specific to the MergeTree table engine.

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

Number of blocks of hashes to keep in ZooKeeper. See detailed description in ClickHouse sources.

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

Period of time to keep blocks of hashes for. See detailed description in ClickHouse sources.

config.
clickhouse.
config.
userConfig.
compression[]
object

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

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

Compression method to use for the specified combination of min_part_size and min_part_size_ratio.

config.
clickhouse.
config.
userConfig.
compression[].
minPartSize
string (int64)

Minimum size of a part of a table.

The minimum value is 1.

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

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

config.
clickhouse.
config.
userConfig.
dictionaries[]
object

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

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

Required. Name of the external dictionary.

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

Single numeric key column for the dictionary.

Numeric key.

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

Required. Name of the numeric key.

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

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

Complex key.

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

Required. Attributes of a complex key.

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

Indication of hierarchy support. Default value: "false".

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

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

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

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

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

Indication of hierarchy support. Default value: "false".

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

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

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

Layout determining how to store the dictionary in memory.

config.
clickhouse.
config.
userConfig.
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.
config.
clickhouse.
config.
userConfig.
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.

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

Fixed interval between dictionary updates.

config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange
object
Range of intervals between dictionary updates for ClickHouse to choose from.
config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Minimum dictionary lifetime.

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

Maximum dictionary lifetime.

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

config.
clickhouse.
config.
userConfig.
dictionaries[].
httpSource.
url
string

Required. URL of the source dictionary available over HTTP.

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

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

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

config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
db
string

Required. Name of the MySQL database to connect to.

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

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

config.
clickhouse.
config.
userConfig.
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.

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

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

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

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

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

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

Must contain at least one element.

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

Required. MySQL host of the replica.

The maximum string length in characters is 253.

config.
clickhouse.
config.
userConfig.
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.

config.
clickhouse.
config.
userConfig.
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.

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

Name of the MySQL database user.

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

Password of the MySQL database user.

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

Selection criteria for the data in the specified MySQL table.

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

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

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

config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
db
string

Required. Name of the ClickHouse database.

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

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

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

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the ClickHouse database user.

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

Password of the ClickHouse database user.

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

Selection criteria for the data in the specified ClickHouse table.

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

config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
db
string

Required. Name of the MongoDB database.

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

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

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

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the MongoDB database user.

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

Password of the MongoDB database user.

config.
clickhouse.
config.
userConfig.
graphiteRollup[]
object

Rollup settings for the GraphiteMergeTree table engine.

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

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

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

Required. Pattern to use for the rollup.

Must contain at least one element.

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

Pattern for metric names.

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

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

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

Required. Age of data to use for thinning.

Must contain at least one element.

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

Minimum age of the data in seconds.

Value must be greater than 0.

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

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

Value must be greater than 0.

config.
clickhouse.
config.
userConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

config.
clickhouse.
config.
userConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

config.
clickhouse.
config.
userConfig.
keepAliveTimeout
integer (int64)

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

config.
clickhouse.
config.
userConfig.
uncompressedCacheSize
integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
userConfig.
markCacheSize
integer (int64)

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

Value must be greater than 5368709120.

config.
clickhouse.
config.
userConfig.
maxTableSizeToDrop
integer (int64)

Maximum size of the table that can be deleted using a DROP query. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
userConfig.
maxPartitionSizeToDrop
integer (int64)

Maximum size of the partition that can be deleted using a DROP query. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
userConfig.
builtinDictionariesReloadInterval
integer (int64)

Time interval for reloading built-in dictionaries. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
userConfig.
timezone
string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
defaultConfig
object

Default configuration for a ClickHouse cluster.

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

Any options not listed here are not supported.

config.
clickhouse.
config.
defaultConfig.
logLevel
string

Logging level for the ClickHouse cluster.

config.
clickhouse.
config.
defaultConfig.
mergeTree
object

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

Options specific to the MergeTree table engine.

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

Number of blocks of hashes to keep in ZooKeeper. See detailed description in ClickHouse sources.

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

Period of time to keep blocks of hashes for. See detailed description in ClickHouse sources.

config.
clickhouse.
config.
defaultConfig.
compression[]
object

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

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

Compression method to use for the specified combination of min_part_size and min_part_size_ratio.

config.
clickhouse.
config.
defaultConfig.
compression[].
minPartSize
string (int64)

Minimum size of a part of a table.

The minimum value is 1.

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

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

config.
clickhouse.
config.
defaultConfig.
dictionaries[]
object

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

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

Required. Name of the external dictionary.

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

Single numeric key column for the dictionary.

Numeric key.

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

Required. Name of the numeric key.

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

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

Complex key.

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

Required. Attributes of a complex key.

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

Indication of hierarchy support. Default value: "false".

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

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

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

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

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

Indication of hierarchy support. Default value: "false".

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

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

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

Layout determining how to store the dictionary in memory.

config.
clickhouse.
config.
defaultConfig.
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.
config.
clickhouse.
config.
defaultConfig.
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.

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

Fixed interval between dictionary updates.

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange
object
Range of intervals between dictionary updates for ClickHouse to choose from.
config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Minimum dictionary lifetime.

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

Maximum dictionary lifetime.

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

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
httpSource.
url
string

Required. URL of the source dictionary available over HTTP.

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

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

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

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
db
string

Required. Name of the MySQL database to connect to.

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

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

config.
clickhouse.
config.
defaultConfig.
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.

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

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

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

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

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

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

Must contain at least one element.

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

Required. MySQL host of the replica.

The maximum string length in characters is 253.

config.
clickhouse.
config.
defaultConfig.
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.

config.
clickhouse.
config.
defaultConfig.
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.

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

Name of the MySQL database user.

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

Password of the MySQL database user.

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

Selection criteria for the data in the specified MySQL table.

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

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

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

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
db
string

Required. Name of the ClickHouse database.

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

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

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

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the ClickHouse database user.

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

Password of the ClickHouse database user.

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

Selection criteria for the data in the specified ClickHouse table.

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

config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
db
string

Required. Name of the MongoDB database.

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

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

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

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the MongoDB database user.

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

Password of the MongoDB database user.

config.
clickhouse.
config.
defaultConfig.
graphiteRollup[]
object

Rollup settings for the GraphiteMergeTree table engine.

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

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

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

Required. Pattern to use for the rollup.

Must contain at least one element.

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

Pattern for metric names.

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

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

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

Required. Age of data to use for thinning.

Must contain at least one element.

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

Minimum age of the data in seconds.

Value must be greater than 0.

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

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

Value must be greater than 0.

config.
clickhouse.
config.
defaultConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

config.
clickhouse.
config.
defaultConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

config.
clickhouse.
config.
defaultConfig.
keepAliveTimeout
integer (int64)

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

config.
clickhouse.
config.
defaultConfig.
uncompressedCacheSize
integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
defaultConfig.
markCacheSize
integer (int64)

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

Value must be greater than 5368709120.

config.
clickhouse.
config.
defaultConfig.
maxTableSizeToDrop
integer (int64)

Maximum size of the table that can be deleted using a DROP query. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
defaultConfig.
maxPartitionSizeToDrop
integer (int64)

Maximum size of the partition that can be deleted using a DROP query. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
defaultConfig.
builtinDictionariesReloadInterval
integer (int64)

Time interval for reloading built-in dictionaries. See in-depth description in ClickHouse documentation.

config.
clickhouse.
config.
defaultConfig.
timezone
string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. See in-depth description in ClickHouse documentation.

config.
clickhouse.
resources
object

Resources allocated to ClickHouse hosts.

config.
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

config.
clickhouse.
resources.
diskSize
string (int64)

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

config.
clickhouse.
resources.
diskTypeId
string

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

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
config.
zookeeper
object

Configuration and resource allocation for ZooKeeper hosts.

config.
zookeeper.
resources
object

Resources allocated to ZooKeeper hosts.

config.
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

config.
zookeeper.
resources.
diskSize
string (int64)

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

config.
zookeeper.
resources.
diskTypeId
string

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

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
config.
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][google.type.Date] and google.protobuf.Timestamp.

config.
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.

config.
backupWindowStart.
minutes
integer (int32)

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

config.
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.

config.
backupWindowStart.
nanos
integer (int32)

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

networkId string

ID of the network that the cluster belongs to.

health string

Aggregated cluster health.

  • HEALTH_UNKNOWN: State of the cluster is unknown ([Host.health] for every host in the cluster is UNKNOWN).
  • ALIVE: Cluster is alive and well ([Host.health] for every host in the cluster is ALIVE).
  • DEAD: Cluster is inoperable ([Host.health] for every host in the cluster is DEAD).
  • DEGRADED: Cluster is working below capacity ([Host.health] for at least one host in the cluster is not ALIVE).
status string

Current state of the cluster.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • UPDATING: Cluster is being updated.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster stopped.
  • STARTING: Cluster is starting.