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",
"partsToDelayInsert": "integer",
"partsToThrowInsert": "integer",
"maxReplicatedMergesInQueue": "integer",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
"maxBytesToMergeAtMinSpaceInPool": "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
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string"
},
// `shards[].config.clickhouse.config.effectiveConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"fixedLifetime": "string",
"lifetimeRange": {
"min": "string",
"max": "string"
},
// end of the list of possible fields`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"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "string",
"precision": "string"
}
]
}
]
}
],
"kafka": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string"
},
"maxConnections": "integer",
"maxConcurrentQueries": "integer",
"keepAliveTimeout": "integer",
"uncompressedCacheSize": "integer",
"markCacheSize": "integer",
"maxTableSizeToDrop": "integer",
"maxPartitionSizeToDrop": "integer",
"builtinDictionariesReloadInterval": "integer",
"timezone": "string",
"geobaseUri": "string",
"queryLogRetentionSize": "integer",
"queryLogRetentionTime": "integer",
"queryThreadLogEnabled": true,
"queryThreadLogRetentionSize": "integer",
"queryThreadLogRetentionTime": "integer",
"partLogRetentionSize": "integer",
"partLogRetentionTime": "integer",
"metricLogEnabled": true,
"metricLogRetentionSize": "integer",
"metricLogRetentionTime": "integer",
"traceLogEnabled": true,
"traceLogRetentionSize": "integer",
"traceLogRetentionTime": "integer",
"textLogEnabled": true,
"textLogRetentionSize": "integer",
"textLogRetentionTime": "integer",
"textLogLevel": "string",
"backgroundPoolSize": "integer",
"backgroundSchedulePoolSize": "integer"
},
"userConfig": {
"logLevel": "string",
"mergeTree": {
"replicatedDeduplicationWindow": "integer",
"replicatedDeduplicationWindowSeconds": "integer",
"partsToDelayInsert": "integer",
"partsToThrowInsert": "integer",
"maxReplicatedMergesInQueue": "integer",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
"maxBytesToMergeAtMinSpaceInPool": "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
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string"
},
// `shards[].config.clickhouse.config.userConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"fixedLifetime": "string",
"lifetimeRange": {
"min": "string",
"max": "string"
},
// end of the list of possible fields`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"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "string",
"precision": "string"
}
]
}
]
}
],
"kafka": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string"
},
"maxConnections": "integer",
"maxConcurrentQueries": "integer",
"keepAliveTimeout": "integer",
"uncompressedCacheSize": "integer",
"markCacheSize": "integer",
"maxTableSizeToDrop": "integer",
"maxPartitionSizeToDrop": "integer",
"builtinDictionariesReloadInterval": "integer",
"timezone": "string",
"geobaseUri": "string",
"queryLogRetentionSize": "integer",
"queryLogRetentionTime": "integer",
"queryThreadLogEnabled": true,
"queryThreadLogRetentionSize": "integer",
"queryThreadLogRetentionTime": "integer",
"partLogRetentionSize": "integer",
"partLogRetentionTime": "integer",
"metricLogEnabled": true,
"metricLogRetentionSize": "integer",
"metricLogRetentionTime": "integer",
"traceLogEnabled": true,
"traceLogRetentionSize": "integer",
"traceLogRetentionTime": "integer",
"textLogEnabled": true,
"textLogRetentionSize": "integer",
"textLogRetentionTime": "integer",
"textLogLevel": "string",
"backgroundPoolSize": "integer",
"backgroundSchedulePoolSize": "integer"
},
"defaultConfig": {
"logLevel": "string",
"mergeTree": {
"replicatedDeduplicationWindow": "integer",
"replicatedDeduplicationWindowSeconds": "integer",
"partsToDelayInsert": "integer",
"partsToThrowInsert": "integer",
"maxReplicatedMergesInQueue": "integer",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
"maxBytesToMergeAtMinSpaceInPool": "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
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string"
},
// `shards[].config.clickhouse.config.defaultConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"fixedLifetime": "string",
"lifetimeRange": {
"min": "string",
"max": "string"
},
// end of the list of possible fields`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"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "string",
"precision": "string"
}
]
}
]
}
],
"kafka": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string"
},
"maxConnections": "integer",
"maxConcurrentQueries": "integer",
"keepAliveTimeout": "integer",
"uncompressedCacheSize": "integer",
"markCacheSize": "integer",
"maxTableSizeToDrop": "integer",
"maxPartitionSizeToDrop": "integer",
"builtinDictionariesReloadInterval": "integer",
"timezone": "string",
"geobaseUri": "string",
"queryLogRetentionSize": "integer",
"queryLogRetentionTime": "integer",
"queryThreadLogEnabled": true,
"queryThreadLogRetentionSize": "integer",
"queryThreadLogRetentionTime": "integer",
"partLogRetentionSize": "integer",
"partLogRetentionTime": "integer",
"metricLogEnabled": true,
"metricLogRetentionSize": "integer",
"metricLogRetentionTime": "integer",
"traceLogEnabled": true,
"traceLogRetentionSize": "integer",
"traceLogRetentionTime": "integer",
"textLogEnabled": true,
"textLogRetentionSize": "integer",
"textLogRetentionTime": "integer",
"textLogLevel": "string",
"backgroundPoolSize": "integer",
"backgroundSchedulePoolSize": "integer"
}
},
"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 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. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
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. |
shards[]. config. clickhouse. config. effectiveConfig. mergeTree. replicatedDeduplicationWindowSeconds |
integer (int64) Period of time to keep blocks of hashes for. |
shards[]. config. clickhouse. config. effectiveConfig. mergeTree. partsToDelayInsert |
integer (int64) If table contains at least that many active parts in single partition, artificially slow down insert into table. |
shards[]. config. clickhouse. config. effectiveConfig. mergeTree. partsToThrowInsert |
integer (int64) If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
shards[]. config. clickhouse. config. effectiveConfig. mergeTree. maxReplicatedMergesInQueue |
integer (int64) How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
shards[]. config. clickhouse. config. effectiveConfig. mergeTree. numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge |
integer (int64) If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process. |
shards[]. config. clickhouse. config. effectiveConfig. mergeTree. maxBytesToMergeAtMinSpaceInPool |
integer (int64) Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue). |
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
|
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: |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin |
object Field holding the beginning of the range for dictionaries with |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. name |
string Required. Name of the column. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. type |
string Required. Type of the column. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. nullValue |
string Default value for an element without data (for example, an empty string). |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. expression |
string Expression, describing the attribute, if applicable. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax |
object Field holding the end of the range for dictionaries with |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. name |
string Required. Name of the column. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. type |
string Required. Type of the column. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. nullValue |
string Default value for an element without data (for example, an empty string). |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. expression |
string Expression, describing the attribute, if applicable. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
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: |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
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.
|
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 , postgresqlSource |
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 , postgresqlSource |
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 , postgresqlSource |
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 , postgresqlSource |
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. dictionaries[]. postgresqlSource |
object PostgreSQL source for the dictionary. shards[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. db |
string Required. Name of the PostrgreSQL database. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. hosts[] |
string Required. Name of the PostrgreSQL host Must contain at least one element. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. user |
string Required. Name of the PostrgreSQL database user. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. password |
string Password of the PostrgreSQL database user. |
shards[]. config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. 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[]. postgresqlSource. sslMode |
string Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.
|
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 |
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. kafka |
object |
shards[]. config. clickhouse. config. effectiveConfig. kafka. securityProtocol |
string |
shards[]. config. clickhouse. config. effectiveConfig. kafka. saslMechanism |
string |
shards[]. config. clickhouse. config. effectiveConfig. kafka. saslUsername |
string |
shards[]. config. clickhouse. config. effectiveConfig. kafka. saslPassword |
string |
shards[]. config. clickhouse. config. effectiveConfig. kafkaTopics[] |
object |
shards[]. config. clickhouse. config. effectiveConfig. kafkaTopics[]. name |
string Required. |
shards[]. config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings |
object Required. |
shards[]. config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. securityProtocol |
string |
shards[]. config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. saslMechanism |
string |
shards[]. config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. saslUsername |
string |
shards[]. config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. saslPassword |
string |
shards[]. config. clickhouse. config. effectiveConfig. rabbitmq |
object |
shards[]. config. clickhouse. config. effectiveConfig. rabbitmq. username |
string |
shards[]. config. clickhouse. config. effectiveConfig. rabbitmq. password |
string |
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. |
shards[]. config. clickhouse. config. effectiveConfig. markCacheSize |
integer (int64) Approximate size (in bytes) of the cache of "marks" used by MergeTree tables. Value must be greater than 0. |
shards[]. config. clickhouse. config. effectiveConfig. maxTableSizeToDrop |
integer (int64) Maximum size of the table that can be deleted using a DROP query. |
shards[]. config. clickhouse. config. effectiveConfig. maxPartitionSizeToDrop |
integer (int64) Maximum size of the partition that can be deleted using a DROP query. |
shards[]. config. clickhouse. config. effectiveConfig. builtinDictionariesReloadInterval |
integer (int64) The setting is deprecated and has no effect. |
shards[]. config. clickhouse. config. effectiveConfig. timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
shards[]. config. clickhouse. config. effectiveConfig. geobaseUri |
string Address of the archive with the user geobase in Object Storage. |
shards[]. config. clickhouse. config. effectiveConfig. queryLogRetentionSize |
integer (int64) The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. queryLogRetentionTime |
integer (int64) The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. queryThreadLogEnabled |
boolean (boolean) Whether query_thread_log system table is enabled. |
shards[]. config. clickhouse. config. effectiveConfig. queryThreadLogRetentionSize |
integer (int64) The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. queryThreadLogRetentionTime |
integer (int64) The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. partLogRetentionSize |
integer (int64) The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. partLogRetentionTime |
integer (int64) The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. metricLogEnabled |
boolean (boolean) Whether metric_log system table is enabled. |
shards[]. config. clickhouse. config. effectiveConfig. metricLogRetentionSize |
integer (int64) The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. metricLogRetentionTime |
integer (int64) The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. traceLogEnabled |
boolean (boolean) Whether trace_log system table is enabled. |
shards[]. config. clickhouse. config. effectiveConfig. traceLogRetentionSize |
integer (int64) The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. traceLogRetentionTime |
integer (int64) The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. textLogEnabled |
boolean (boolean) Whether text_log system table is enabled. |
shards[]. config. clickhouse. config. effectiveConfig. textLogRetentionSize |
integer (int64) The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. textLogRetentionTime |
integer (int64) The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled. |
shards[]. config. clickhouse. config. effectiveConfig. textLogLevel |
string Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
shards[]. config. clickhouse. config. effectiveConfig. backgroundPoolSize |
integer (int64) Value must be greater than 0. |
shards[]. config. clickhouse. config. effectiveConfig. backgroundSchedulePoolSize |
integer (int64) Value must be greater than 0. |
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. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
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. |
shards[]. config. clickhouse. config. userConfig. mergeTree. replicatedDeduplicationWindowSeconds |
integer (int64) Period of time to keep blocks of hashes for. |
shards[]. config. clickhouse. config. userConfig. mergeTree. partsToDelayInsert |
integer (int64) If table contains at least that many active parts in single partition, artificially slow down insert into table. |
shards[]. config. clickhouse. config. userConfig. mergeTree. partsToThrowInsert |
integer (int64) If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
shards[]. config. clickhouse. config. userConfig. mergeTree. maxReplicatedMergesInQueue |
integer (int64) How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
shards[]. config. clickhouse. config. userConfig. mergeTree. numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge |
integer (int64) If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process. |
shards[]. config. clickhouse. config. userConfig. mergeTree. maxBytesToMergeAtMinSpaceInPool |
integer (int64) Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue). |
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
|
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: |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin |
object Field holding the beginning of the range for dictionaries with |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. name |
string Required. Name of the column. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. type |
string Required. Type of the column. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. nullValue |
string Default value for an element without data (for example, an empty string). |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. expression |
string Expression, describing the attribute, if applicable. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax |
object Field holding the end of the range for dictionaries with |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. name |
string Required. Name of the column. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. type |
string Required. Type of the column. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. nullValue |
string Default value for an element without data (for example, an empty string). |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. expression |
string Expression, describing the attribute, if applicable. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
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: |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
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.
|
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 , postgresqlSource |
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 , postgresqlSource |
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 , postgresqlSource |
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 , postgresqlSource |
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. dictionaries[]. postgresqlSource |
object PostgreSQL source for the dictionary. shards[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. db |
string Required. Name of the PostrgreSQL database. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. hosts[] |
string Required. Name of the PostrgreSQL host Must contain at least one element. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. user |
string Required. Name of the PostrgreSQL database user. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. password |
string Password of the PostrgreSQL database user. |
shards[]. config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. 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[]. postgresqlSource. sslMode |
string Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.
|
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 |
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. kafka |
object |
shards[]. config. clickhouse. config. userConfig. kafka. securityProtocol |
string |
shards[]. config. clickhouse. config. userConfig. kafka. saslMechanism |
string |
shards[]. config. clickhouse. config. userConfig. kafka. saslUsername |
string |
shards[]. config. clickhouse. config. userConfig. kafka. saslPassword |
string |
shards[]. config. clickhouse. config. userConfig. kafkaTopics[] |
object |
shards[]. config. clickhouse. config. userConfig. kafkaTopics[]. name |
string Required. |
shards[]. config. clickhouse. config. userConfig. kafkaTopics[]. settings |
object Required. |
shards[]. config. clickhouse. config. userConfig. kafkaTopics[]. settings. securityProtocol |
string |
shards[]. config. clickhouse. config. userConfig. kafkaTopics[]. settings. saslMechanism |
string |
shards[]. config. clickhouse. config. userConfig. kafkaTopics[]. settings. saslUsername |
string |
shards[]. config. clickhouse. config. userConfig. kafkaTopics[]. settings. saslPassword |
string |
shards[]. config. clickhouse. config. userConfig. rabbitmq |
object |
shards[]. config. clickhouse. config. userConfig. rabbitmq. username |
string |
shards[]. config. clickhouse. config. userConfig. rabbitmq. password |
string |
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. |
shards[]. config. clickhouse. config. userConfig. markCacheSize |
integer (int64) Approximate size (in bytes) of the cache of "marks" used by MergeTree tables. Value must be greater than 0. |
shards[]. config. clickhouse. config. userConfig. maxTableSizeToDrop |
integer (int64) Maximum size of the table that can be deleted using a DROP query. |
shards[]. config. clickhouse. config. userConfig. maxPartitionSizeToDrop |
integer (int64) Maximum size of the partition that can be deleted using a DROP query. |
shards[]. config. clickhouse. config. userConfig. builtinDictionariesReloadInterval |
integer (int64) The setting is deprecated and has no effect. |
shards[]. config. clickhouse. config. userConfig. timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
shards[]. config. clickhouse. config. userConfig. geobaseUri |
string Address of the archive with the user geobase in Object Storage. |
shards[]. config. clickhouse. config. userConfig. queryLogRetentionSize |
integer (int64) The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled. |
shards[]. config. clickhouse. config. userConfig. queryLogRetentionTime |
integer (int64) The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled. |
shards[]. config. clickhouse. config. userConfig. queryThreadLogEnabled |
boolean (boolean) Whether query_thread_log system table is enabled. |
shards[]. config. clickhouse. config. userConfig. queryThreadLogRetentionSize |
integer (int64) The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled. |
shards[]. config. clickhouse. config. userConfig. queryThreadLogRetentionTime |
integer (int64) The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled. |
shards[]. config. clickhouse. config. userConfig. partLogRetentionSize |
integer (int64) The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled. |
shards[]. config. clickhouse. config. userConfig. partLogRetentionTime |
integer (int64) The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled. |
shards[]. config. clickhouse. config. userConfig. metricLogEnabled |
boolean (boolean) Whether metric_log system table is enabled. |
shards[]. config. clickhouse. config. userConfig. metricLogRetentionSize |
integer (int64) The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled. |
shards[]. config. clickhouse. config. userConfig. metricLogRetentionTime |
integer (int64) The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled. |
shards[]. config. clickhouse. config. userConfig. traceLogEnabled |
boolean (boolean) Whether trace_log system table is enabled. |
shards[]. config. clickhouse. config. userConfig. traceLogRetentionSize |
integer (int64) The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled. |
shards[]. config. clickhouse. config. userConfig. traceLogRetentionTime |
integer (int64) The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled. |
shards[]. config. clickhouse. config. userConfig. textLogEnabled |
boolean (boolean) Whether text_log system table is enabled. |
shards[]. config. clickhouse. config. userConfig. textLogRetentionSize |
integer (int64) The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled. |
shards[]. config. clickhouse. config. userConfig. textLogRetentionTime |
integer (int64) The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled. |
shards[]. config. clickhouse. config. userConfig. textLogLevel |
string Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
shards[]. config. clickhouse. config. userConfig. backgroundPoolSize |
integer (int64) Value must be greater than 0. |
shards[]. config. clickhouse. config. userConfig. backgroundSchedulePoolSize |
integer (int64) Value must be greater than 0. |
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. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
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. |
shards[]. config. clickhouse. config. defaultConfig. mergeTree. replicatedDeduplicationWindowSeconds |
integer (int64) Period of time to keep blocks of hashes for. |
shards[]. config. clickhouse. config. defaultConfig. mergeTree. partsToDelayInsert |
integer (int64) If table contains at least that many active parts in single partition, artificially slow down insert into table. |
shards[]. config. clickhouse. config. defaultConfig. mergeTree. partsToThrowInsert |
integer (int64) If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
shards[]. config. clickhouse. config. defaultConfig. mergeTree. maxReplicatedMergesInQueue |
integer (int64) How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
shards[]. config. clickhouse. config. defaultConfig. mergeTree. numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge |
integer (int64) If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process. |
shards[]. config. clickhouse. config. defaultConfig. mergeTree. maxBytesToMergeAtMinSpaceInPool |
integer (int64) Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue). |
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
|
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: |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin |
object Field holding the beginning of the range for dictionaries with |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. name |
string Required. Name of the column. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. type |
string Required. Type of the column. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. nullValue |
string Default value for an element without data (for example, an empty string). |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. expression |
string Expression, describing the attribute, if applicable. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax |
object Field holding the end of the range for dictionaries with |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. name |
string Required. Name of the column. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. type |
string Required. Type of the column. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. nullValue |
string Default value for an element without data (for example, an empty string). |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. expression |
string Expression, describing the attribute, if applicable. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
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: |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
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.
|
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 , postgresqlSource |
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 , postgresqlSource |
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 , postgresqlSource |
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 , postgresqlSource |
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. dictionaries[]. postgresqlSource |
object PostgreSQL source for the dictionary. shards[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. db |
string Required. Name of the PostrgreSQL database. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. hosts[] |
string Required. Name of the PostrgreSQL host Must contain at least one element. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. user |
string Required. Name of the PostrgreSQL database user. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. password |
string Password of the PostrgreSQL database user. |
shards[]. config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. 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[]. postgresqlSource. sslMode |
string Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.
|
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 |
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. kafka |
object |
shards[]. config. clickhouse. config. defaultConfig. kafka. securityProtocol |
string |
shards[]. config. clickhouse. config. defaultConfig. kafka. saslMechanism |
string |
shards[]. config. clickhouse. config. defaultConfig. kafka. saslUsername |
string |
shards[]. config. clickhouse. config. defaultConfig. kafka. saslPassword |
string |
shards[]. config. clickhouse. config. defaultConfig. kafkaTopics[] |
object |
shards[]. config. clickhouse. config. defaultConfig. kafkaTopics[]. name |
string Required. |
shards[]. config. clickhouse. config. defaultConfig. kafkaTopics[]. settings |
object Required. |
shards[]. config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. securityProtocol |
string |
shards[]. config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. saslMechanism |
string |
shards[]. config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. saslUsername |
string |
shards[]. config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. saslPassword |
string |
shards[]. config. clickhouse. config. defaultConfig. rabbitmq |
object |
shards[]. config. clickhouse. config. defaultConfig. rabbitmq. username |
string |
shards[]. config. clickhouse. config. defaultConfig. rabbitmq. password |
string |
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. |
shards[]. config. clickhouse. config. defaultConfig. markCacheSize |
integer (int64) Approximate size (in bytes) of the cache of "marks" used by MergeTree tables. Value must be greater than 0. |
shards[]. config. clickhouse. config. defaultConfig. maxTableSizeToDrop |
integer (int64) Maximum size of the table that can be deleted using a DROP query. |
shards[]. config. clickhouse. config. defaultConfig. maxPartitionSizeToDrop |
integer (int64) Maximum size of the partition that can be deleted using a DROP query. |
shards[]. config. clickhouse. config. defaultConfig. builtinDictionariesReloadInterval |
integer (int64) The setting is deprecated and has no effect. |
shards[]. config. clickhouse. config. defaultConfig. timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
shards[]. config. clickhouse. config. defaultConfig. geobaseUri |
string Address of the archive with the user geobase in Object Storage. |
shards[]. config. clickhouse. config. defaultConfig. queryLogRetentionSize |
integer (int64) The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled. |
shards[]. config. clickhouse. config. defaultConfig. queryLogRetentionTime |
integer (int64) The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled. |
shards[]. config. clickhouse. config. defaultConfig. queryThreadLogEnabled |
boolean (boolean) Whether query_thread_log system table is enabled. |
shards[]. config. clickhouse. config. defaultConfig. queryThreadLogRetentionSize |
integer (int64) The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled. |
shards[]. config. clickhouse. config. defaultConfig. queryThreadLogRetentionTime |
integer (int64) The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled. |
shards[]. config. clickhouse. config. defaultConfig. partLogRetentionSize |
integer (int64) The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled. |
shards[]. config. clickhouse. config. defaultConfig. partLogRetentionTime |
integer (int64) The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled. |
shards[]. config. clickhouse. config. defaultConfig. metricLogEnabled |
boolean (boolean) Whether metric_log system table is enabled. |
shards[]. config. clickhouse. config. defaultConfig. metricLogRetentionSize |
integer (int64) The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled. |
shards[]. config. clickhouse. config. defaultConfig. metricLogRetentionTime |
integer (int64) The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled. |
shards[]. config. clickhouse. config. defaultConfig. traceLogEnabled |
boolean (boolean) Whether trace_log system table is enabled. |
shards[]. config. clickhouse. config. defaultConfig. traceLogRetentionSize |
integer (int64) The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled. |
shards[]. config. clickhouse. config. defaultConfig. traceLogRetentionTime |
integer (int64) The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled. |
shards[]. config. clickhouse. config. defaultConfig. textLogEnabled |
boolean (boolean) Whether text_log system table is enabled. |
shards[]. config. clickhouse. config. defaultConfig. textLogRetentionSize |
integer (int64) The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled. |
shards[]. config. clickhouse. config. defaultConfig. textLogRetentionTime |
integer (int64) The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled. |
shards[]. config. clickhouse. config. defaultConfig. textLogLevel |
string Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
shards[]. config. clickhouse. config. defaultConfig. backgroundPoolSize |
integer (int64) Value must be greater than 0. |
shards[]. config. clickhouse. config. defaultConfig. backgroundSchedulePoolSize |
integer (int64) Value must be greater than 0. |
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:
|
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. |