Method listShards

Retrieves a list of shards that belong to the specified cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the ClickHouse cluster to list shards in. To get the cluster ID, use a [List] request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. to get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "shards": [
    {
      "name": "string",
      "clusterId": "string",
      "config": {
        "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"
                  },

                  // `shards[].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`shards[].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"
                  },

                  // `shards[].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`shards[].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"
                  },

                  // `shards[].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`shards[].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"
          },
          "weight": "integer"
        }
      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
shards[] object

List of ClickHouse shards.

shards[].
name
string

Name of the shard.

shards[].
clusterId
string

ID of the cluster that the shard belongs to.

shards[].
config
object

Configuration of the shard.

shards[].
config.
clickhouse
object

ClickHouse configuration for a shard.

shards[].
config.
clickhouse.
config
object

ClickHouse settings for a shard.

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
logLevel
string

Logging level for the ClickHouse cluster.

shards[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree
object

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

Options specific to the MergeTree table engine.

shards[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

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

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

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

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

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

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

Minimum size of a part of a table.

The minimum value is 1.

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

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

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

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

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

Required. Name of the external dictionary.

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

Single numeric key column for the dictionary.

Numeric key.

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

Required. Name of the numeric key.

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

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

Required. Attributes of a complex key.

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

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

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

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

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

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

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

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

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

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

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

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

Fixed interval between dictionary updates.

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

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

Minimum dictionary lifetime.

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

Maximum dictionary lifetime.

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

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

Required. URL of the source dictionary available over HTTP.

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

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

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

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

Required. Name of the MySQL database to connect to.

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

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

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

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

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

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

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

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

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

Required. MySQL host of the replica.

The maximum string length in characters is 253.

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

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

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

Name of the MySQL database user.

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

Password of the MySQL database user.

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

Selection criteria for the data in the specified MySQL table.

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

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

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

Required. Name of the ClickHouse database.

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

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

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

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the ClickHouse database user.

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

Password of the ClickHouse database user.

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

Selection criteria for the data in the specified ClickHouse table.

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

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

Required. Name of the MongoDB database.

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

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

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

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the MongoDB database user.

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

Password of the MongoDB database user.

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

Rollup settings for the GraphiteMergeTree table engine.

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

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

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

Required. Pattern to use for the rollup.

Must contain at least one element.

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

Pattern for metric names.

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

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

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

Required. Age of data to use for thinning.

Must contain at least one element.

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

Minimum age of the data in seconds.

Value must be greater than 0.

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

shards[].
config.
clickhouse.
config.
effectiveConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

shards[].
config.
clickhouse.
config.
effectiveConfig.
keepAliveTimeout
integer (int64)

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

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

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

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

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

shards[].
config.
clickhouse.
config.
effectiveConfig.
builtinDictionariesReloadInterval
integer (int64)

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

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

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

shards[].
config.
clickhouse.
config.
userConfig.
logLevel
string

Logging level for the ClickHouse cluster.

shards[].
config.
clickhouse.
config.
userConfig.
mergeTree
object

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

Options specific to the MergeTree table engine.

shards[].
config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

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

shards[].
config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

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

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

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

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

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

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

Minimum size of a part of a table.

The minimum value is 1.

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

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

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

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

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

Required. Name of the external dictionary.

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

Single numeric key column for the dictionary.

Numeric key.

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

Required. Name of the numeric key.

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

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

Required. Attributes of a complex key.

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

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

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

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

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

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

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

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

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

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

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

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

Fixed interval between dictionary updates.

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

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

Minimum dictionary lifetime.

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

Maximum dictionary lifetime.

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

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

Required. URL of the source dictionary available over HTTP.

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

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

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

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

Required. Name of the MySQL database to connect to.

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

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

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

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

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

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

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

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

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

Required. MySQL host of the replica.

The maximum string length in characters is 253.

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

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

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

Name of the MySQL database user.

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

Password of the MySQL database user.

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

Selection criteria for the data in the specified MySQL table.

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

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

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

Required. Name of the ClickHouse database.

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

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

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

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the ClickHouse database user.

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

Password of the ClickHouse database user.

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

Selection criteria for the data in the specified ClickHouse table.

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

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

Required. Name of the MongoDB database.

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

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

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

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the MongoDB database user.

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

Password of the MongoDB database user.

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

Rollup settings for the GraphiteMergeTree table engine.

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

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

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

Required. Pattern to use for the rollup.

Must contain at least one element.

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

Pattern for metric names.

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

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

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

Required. Age of data to use for thinning.

Must contain at least one element.

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

Minimum age of the data in seconds.

Value must be greater than 0.

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

shards[].
config.
clickhouse.
config.
userConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

shards[].
config.
clickhouse.
config.
userConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

shards[].
config.
clickhouse.
config.
userConfig.
keepAliveTimeout
integer (int64)

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

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

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

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

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

shards[].
config.
clickhouse.
config.
userConfig.
builtinDictionariesReloadInterval
integer (int64)

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

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
logLevel
string

Logging level for the ClickHouse cluster.

shards[].
config.
clickhouse.
config.
defaultConfig.
mergeTree
object

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

Options specific to the MergeTree table engine.

shards[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

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

shards[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

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

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

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

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

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

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

Minimum size of a part of a table.

The minimum value is 1.

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

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

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

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

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

Required. Name of the external dictionary.

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

Single numeric key column for the dictionary.

Numeric key.

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

Required. Name of the numeric key.

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

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

Required. Attributes of a complex key.

Must contain at least one element.

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

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

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

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

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

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

Required. Name of the column.

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

Required. Type of the column.

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

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

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

Expression, describing the attribute, if applicable.

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

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

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

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

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

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

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

Fixed interval between dictionary updates.

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

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

Minimum dictionary lifetime.

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

Maximum dictionary lifetime.

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

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

Required. URL of the source dictionary available over HTTP.

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

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

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

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

Required. Name of the MySQL database to connect to.

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

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

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

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

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

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

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

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

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

Required. MySQL host of the replica.

The maximum string length in characters is 253.

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

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

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

Name of the MySQL database user.

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

Password of the MySQL database user.

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

Selection criteria for the data in the specified MySQL table.

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

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

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

Required. Name of the ClickHouse database.

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

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

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

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the ClickHouse database user.

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

Password of the ClickHouse database user.

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

Selection criteria for the data in the specified ClickHouse table.

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

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

Required. Name of the MongoDB database.

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

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

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

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

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

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

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

Required. Name of the MongoDB database user.

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

Password of the MongoDB database user.

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

Rollup settings for the GraphiteMergeTree table engine.

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

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

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

Required. Pattern to use for the rollup.

Must contain at least one element.

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

Pattern for metric names.

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

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

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

Required. Age of data to use for thinning.

Must contain at least one element.

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

Minimum age of the data in seconds.

Value must be greater than 0.

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

shards[].
config.
clickhouse.
config.
defaultConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

shards[].
config.
clickhouse.
config.
defaultConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

shards[].
config.
clickhouse.
config.
defaultConfig.
keepAliveTimeout
integer (int64)

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

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

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

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

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

shards[].
config.
clickhouse.
config.
defaultConfig.
builtinDictionariesReloadInterval
integer (int64)

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

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

shards[].
config.
clickhouse.
resources
object

Computational resources for a shard.

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

shards[].
config.
clickhouse.
resources.
diskSize
string (int64)

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

shards[].
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.
shards[].
config.
clickhouse.
weight
integer (int64)

Relative weight of a shard considered when writing data to the cluster. For details, see ClickHouse documentation.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.