Managed Service for ClickHouse API, REST: Cluster methods
A set of methods for managing ClickHouse clusters.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"clickhouse": {
"config": {
"effectiveConfig": {
"logLevel": "string",
"mergeTree": {
"replicatedDeduplicationWindow": "integer",
"replicatedDeduplicationWindowSeconds": "integer",
"partsToDelayInsert": "integer",
"partsToThrowInsert": "integer",
"inactivePartsToDelayInsert": "integer",
"inactivePartsToThrowInsert": "integer",
"maxReplicatedMergesInQueue": "integer",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
"maxBytesToMergeAtMinSpaceInPool": "integer",
"maxBytesToMergeAtMaxSpaceInPool": "integer",
"minBytesForWidePart": "integer",
"minRowsForWidePart": "integer",
"ttlOnlyDropParts": true,
"allowRemoteFsZeroCopyReplication": true,
"mergeWithTtlTimeout": "integer",
"mergeWithRecompressionTtlTimeout": "integer",
"maxPartsInTotal": "integer",
"maxNumberOfMergesWithTtlInPool": "integer",
"cleanupDelayPeriod": "integer",
"numberOfFreeEntriesInPoolToExecuteMutation": "integer",
"maxAvgPartSizeForTooManyParts": "integer",
"minAgeToForceMergeSeconds": "integer",
"minAgeToForceMergeOnPartitionOnly": true,
"mergeSelectingSleepMs": "integer",
"mergeMaxBlockSize": "integer",
"checkSampleColumnIsCorrect": true,
"maxMergeSelectingSleepMs": "integer",
"maxCleanupDelayPeriod": "integer"
},
"compression": [
{
"method": "string",
"minPartSize": "string",
"minPartSizeRatio": "number",
"level": "integer"
}
],
"dictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string",
"maxArraySize": "string"
},
// `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`config.clickhouse.config.effectiveConfig.dictionaries[]`
"httpSource": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "string",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "string",
"port": "string",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string",
"closeConnection": true,
"shareConnection": true
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"where": "string",
"secure": true
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "string",
"precision": "string"
}
]
}
],
"pathColumnName": "string",
"timeColumnName": "string",
"valueColumnName": "string",
"versionColumnName": "string"
}
],
"kafka": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": true,
"maxPollIntervalMs": "integer",
"sessionTimeoutMs": "integer",
"debug": "string",
"autoOffsetReset": "string"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": true,
"maxPollIntervalMs": "integer",
"sessionTimeoutMs": "integer",
"debug": "string",
"autoOffsetReset": "string"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string",
"vhost": "string"
},
"maxConnections": "integer",
"maxConcurrentQueries": "integer",
"keepAliveTimeout": "integer",
"uncompressedCacheSize": "integer",
"markCacheSize": "integer",
"maxTableSizeToDrop": "integer",
"maxPartitionSizeToDrop": "integer",
"builtinDictionariesReloadInterval": "integer",
"timezone": "string",
"geobaseEnabled": true,
"geobaseUri": "string",
"queryLogRetentionSize": "integer",
"queryLogRetentionTime": "integer",
"queryThreadLogEnabled": true,
"queryThreadLogRetentionSize": "integer",
"queryThreadLogRetentionTime": "integer",
"partLogRetentionSize": "integer",
"partLogRetentionTime": "integer",
"metricLogEnabled": true,
"metricLogRetentionSize": "integer",
"metricLogRetentionTime": "integer",
"traceLogEnabled": true,
"traceLogRetentionSize": "integer",
"traceLogRetentionTime": "integer",
"textLogEnabled": true,
"textLogRetentionSize": "integer",
"textLogRetentionTime": "integer",
"textLogLevel": "string",
"opentelemetrySpanLogEnabled": true,
"opentelemetrySpanLogRetentionSize": "integer",
"opentelemetrySpanLogRetentionTime": "integer",
"queryViewsLogEnabled": true,
"queryViewsLogRetentionSize": "integer",
"queryViewsLogRetentionTime": "integer",
"asynchronousMetricLogEnabled": true,
"asynchronousMetricLogRetentionSize": "integer",
"asynchronousMetricLogRetentionTime": "integer",
"sessionLogEnabled": true,
"sessionLogRetentionSize": "integer",
"sessionLogRetentionTime": "integer",
"zookeeperLogEnabled": true,
"zookeeperLogRetentionSize": "integer",
"zookeeperLogRetentionTime": "integer",
"asynchronousInsertLogEnabled": true,
"asynchronousInsertLogRetentionSize": "integer",
"asynchronousInsertLogRetentionTime": "integer",
"backgroundPoolSize": "integer",
"backgroundMergesMutationsConcurrencyRatio": "integer",
"backgroundSchedulePoolSize": "integer",
"backgroundFetchesPoolSize": "integer",
"backgroundMovePoolSize": "integer",
"backgroundDistributedSchedulePoolSize": "integer",
"backgroundBufferFlushSchedulePoolSize": "integer",
"backgroundMessageBrokerSchedulePoolSize": "integer",
"backgroundCommonPoolSize": "integer",
"defaultDatabase": "string",
"totalMemoryProfilerStep": "integer",
"totalMemoryTrackerSampleProbability": "number",
"queryMaskingRules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionariesLazyLoad": true,
"queryCache": {
"maxSizeInBytes": "integer",
"maxEntries": "integer",
"maxEntrySizeInBytes": "integer",
"maxEntrySizeInRows": "integer"
}
},
"userConfig": {
"logLevel": "string",
"mergeTree": {
"replicatedDeduplicationWindow": "integer",
"replicatedDeduplicationWindowSeconds": "integer",
"partsToDelayInsert": "integer",
"partsToThrowInsert": "integer",
"inactivePartsToDelayInsert": "integer",
"inactivePartsToThrowInsert": "integer",
"maxReplicatedMergesInQueue": "integer",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
"maxBytesToMergeAtMinSpaceInPool": "integer",
"maxBytesToMergeAtMaxSpaceInPool": "integer",
"minBytesForWidePart": "integer",
"minRowsForWidePart": "integer",
"ttlOnlyDropParts": true,
"allowRemoteFsZeroCopyReplication": true,
"mergeWithTtlTimeout": "integer",
"mergeWithRecompressionTtlTimeout": "integer",
"maxPartsInTotal": "integer",
"maxNumberOfMergesWithTtlInPool": "integer",
"cleanupDelayPeriod": "integer",
"numberOfFreeEntriesInPoolToExecuteMutation": "integer",
"maxAvgPartSizeForTooManyParts": "integer",
"minAgeToForceMergeSeconds": "integer",
"minAgeToForceMergeOnPartitionOnly": true,
"mergeSelectingSleepMs": "integer",
"mergeMaxBlockSize": "integer",
"checkSampleColumnIsCorrect": true,
"maxMergeSelectingSleepMs": "integer",
"maxCleanupDelayPeriod": "integer"
},
"compression": [
{
"method": "string",
"minPartSize": "string",
"minPartSizeRatio": "number",
"level": "integer"
}
],
"dictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string",
"maxArraySize": "string"
},
// `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`config.clickhouse.config.userConfig.dictionaries[]`
"httpSource": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "string",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "string",
"port": "string",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string",
"closeConnection": true,
"shareConnection": true
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"where": "string",
"secure": true
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "string",
"precision": "string"
}
]
}
],
"pathColumnName": "string",
"timeColumnName": "string",
"valueColumnName": "string",
"versionColumnName": "string"
}
],
"kafka": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": true,
"maxPollIntervalMs": "integer",
"sessionTimeoutMs": "integer",
"debug": "string",
"autoOffsetReset": "string"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": true,
"maxPollIntervalMs": "integer",
"sessionTimeoutMs": "integer",
"debug": "string",
"autoOffsetReset": "string"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string",
"vhost": "string"
},
"maxConnections": "integer",
"maxConcurrentQueries": "integer",
"keepAliveTimeout": "integer",
"uncompressedCacheSize": "integer",
"markCacheSize": "integer",
"maxTableSizeToDrop": "integer",
"maxPartitionSizeToDrop": "integer",
"builtinDictionariesReloadInterval": "integer",
"timezone": "string",
"geobaseEnabled": true,
"geobaseUri": "string",
"queryLogRetentionSize": "integer",
"queryLogRetentionTime": "integer",
"queryThreadLogEnabled": true,
"queryThreadLogRetentionSize": "integer",
"queryThreadLogRetentionTime": "integer",
"partLogRetentionSize": "integer",
"partLogRetentionTime": "integer",
"metricLogEnabled": true,
"metricLogRetentionSize": "integer",
"metricLogRetentionTime": "integer",
"traceLogEnabled": true,
"traceLogRetentionSize": "integer",
"traceLogRetentionTime": "integer",
"textLogEnabled": true,
"textLogRetentionSize": "integer",
"textLogRetentionTime": "integer",
"textLogLevel": "string",
"opentelemetrySpanLogEnabled": true,
"opentelemetrySpanLogRetentionSize": "integer",
"opentelemetrySpanLogRetentionTime": "integer",
"queryViewsLogEnabled": true,
"queryViewsLogRetentionSize": "integer",
"queryViewsLogRetentionTime": "integer",
"asynchronousMetricLogEnabled": true,
"asynchronousMetricLogRetentionSize": "integer",
"asynchronousMetricLogRetentionTime": "integer",
"sessionLogEnabled": true,
"sessionLogRetentionSize": "integer",
"sessionLogRetentionTime": "integer",
"zookeeperLogEnabled": true,
"zookeeperLogRetentionSize": "integer",
"zookeeperLogRetentionTime": "integer",
"asynchronousInsertLogEnabled": true,
"asynchronousInsertLogRetentionSize": "integer",
"asynchronousInsertLogRetentionTime": "integer",
"backgroundPoolSize": "integer",
"backgroundMergesMutationsConcurrencyRatio": "integer",
"backgroundSchedulePoolSize": "integer",
"backgroundFetchesPoolSize": "integer",
"backgroundMovePoolSize": "integer",
"backgroundDistributedSchedulePoolSize": "integer",
"backgroundBufferFlushSchedulePoolSize": "integer",
"backgroundMessageBrokerSchedulePoolSize": "integer",
"backgroundCommonPoolSize": "integer",
"defaultDatabase": "string",
"totalMemoryProfilerStep": "integer",
"totalMemoryTrackerSampleProbability": "number",
"queryMaskingRules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionariesLazyLoad": true,
"queryCache": {
"maxSizeInBytes": "integer",
"maxEntries": "integer",
"maxEntrySizeInBytes": "integer",
"maxEntrySizeInRows": "integer"
}
},
"defaultConfig": {
"logLevel": "string",
"mergeTree": {
"replicatedDeduplicationWindow": "integer",
"replicatedDeduplicationWindowSeconds": "integer",
"partsToDelayInsert": "integer",
"partsToThrowInsert": "integer",
"inactivePartsToDelayInsert": "integer",
"inactivePartsToThrowInsert": "integer",
"maxReplicatedMergesInQueue": "integer",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
"maxBytesToMergeAtMinSpaceInPool": "integer",
"maxBytesToMergeAtMaxSpaceInPool": "integer",
"minBytesForWidePart": "integer",
"minRowsForWidePart": "integer",
"ttlOnlyDropParts": true,
"allowRemoteFsZeroCopyReplication": true,
"mergeWithTtlTimeout": "integer",
"mergeWithRecompressionTtlTimeout": "integer",
"maxPartsInTotal": "integer",
"maxNumberOfMergesWithTtlInPool": "integer",
"cleanupDelayPeriod": "integer",
"numberOfFreeEntriesInPoolToExecuteMutation": "integer",
"maxAvgPartSizeForTooManyParts": "integer",
"minAgeToForceMergeSeconds": "integer",
"minAgeToForceMergeOnPartitionOnly": true,
"mergeSelectingSleepMs": "integer",
"mergeMaxBlockSize": "integer",
"checkSampleColumnIsCorrect": true,
"maxMergeSelectingSleepMs": "integer",
"maxCleanupDelayPeriod": "integer"
},
"compression": [
{
"method": "string",
"minPartSize": "string",
"minPartSizeRatio": "number",
"level": "integer"
}
],
"dictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": true,
"injective": true
}
]
},
"layout": {
"type": "string",
"sizeInCells": "string",
"maxArraySize": "string"
},
// `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`config.clickhouse.config.defaultConfig.dictionaries[]`
"httpSource": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "string",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "string",
"port": "string",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string",
"closeConnection": true,
"shareConnection": true
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"where": "string",
"secure": true
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "string",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "string",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "string"
}
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "string",
"precision": "string"
}
]
}
],
"pathColumnName": "string",
"timeColumnName": "string",
"valueColumnName": "string",
"versionColumnName": "string"
}
],
"kafka": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": true,
"maxPollIntervalMs": "integer",
"sessionTimeoutMs": "integer",
"debug": "string",
"autoOffsetReset": "string"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "string",
"saslMechanism": "string",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": true,
"maxPollIntervalMs": "integer",
"sessionTimeoutMs": "integer",
"debug": "string",
"autoOffsetReset": "string"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string",
"vhost": "string"
},
"maxConnections": "integer",
"maxConcurrentQueries": "integer",
"keepAliveTimeout": "integer",
"uncompressedCacheSize": "integer",
"markCacheSize": "integer",
"maxTableSizeToDrop": "integer",
"maxPartitionSizeToDrop": "integer",
"builtinDictionariesReloadInterval": "integer",
"timezone": "string",
"geobaseEnabled": true,
"geobaseUri": "string",
"queryLogRetentionSize": "integer",
"queryLogRetentionTime": "integer",
"queryThreadLogEnabled": true,
"queryThreadLogRetentionSize": "integer",
"queryThreadLogRetentionTime": "integer",
"partLogRetentionSize": "integer",
"partLogRetentionTime": "integer",
"metricLogEnabled": true,
"metricLogRetentionSize": "integer",
"metricLogRetentionTime": "integer",
"traceLogEnabled": true,
"traceLogRetentionSize": "integer",
"traceLogRetentionTime": "integer",
"textLogEnabled": true,
"textLogRetentionSize": "integer",
"textLogRetentionTime": "integer",
"textLogLevel": "string",
"opentelemetrySpanLogEnabled": true,
"opentelemetrySpanLogRetentionSize": "integer",
"opentelemetrySpanLogRetentionTime": "integer",
"queryViewsLogEnabled": true,
"queryViewsLogRetentionSize": "integer",
"queryViewsLogRetentionTime": "integer",
"asynchronousMetricLogEnabled": true,
"asynchronousMetricLogRetentionSize": "integer",
"asynchronousMetricLogRetentionTime": "integer",
"sessionLogEnabled": true,
"sessionLogRetentionSize": "integer",
"sessionLogRetentionTime": "integer",
"zookeeperLogEnabled": true,
"zookeeperLogRetentionSize": "integer",
"zookeeperLogRetentionTime": "integer",
"asynchronousInsertLogEnabled": true,
"asynchronousInsertLogRetentionSize": "integer",
"asynchronousInsertLogRetentionTime": "integer",
"backgroundPoolSize": "integer",
"backgroundMergesMutationsConcurrencyRatio": "integer",
"backgroundSchedulePoolSize": "integer",
"backgroundFetchesPoolSize": "integer",
"backgroundMovePoolSize": "integer",
"backgroundDistributedSchedulePoolSize": "integer",
"backgroundBufferFlushSchedulePoolSize": "integer",
"backgroundMessageBrokerSchedulePoolSize": "integer",
"backgroundCommonPoolSize": "integer",
"defaultDatabase": "string",
"totalMemoryProfilerStep": "integer",
"totalMemoryTrackerSampleProbability": "number",
"queryMaskingRules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionariesLazyLoad": true,
"queryCache": {
"maxSizeInBytes": "integer",
"maxEntries": "integer",
"maxEntrySizeInBytes": "integer",
"maxEntrySizeInRows": "integer"
}
}
},
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"zookeeper": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"access": {
"dataLens": true,
"webSql": true,
"metrika": true,
"serverless": true,
"dataTransfer": true,
"yandexQuery": true
},
"cloudStorage": {
"enabled": true,
"moveFactor": "number",
"dataCacheEnabled": true,
"dataCacheMaxSize": "integer",
"preferNotToMerge": true
},
"sqlDatabaseManagement": true,
"sqlUserManagement": true,
"embeddedKeeper": true,
"backupRetainPeriodDays": "integer"
},
"networkId": "string",
"health": "string",
"status": "string",
"serviceAccountId": "string",
"maintenanceWindow": {
// `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": {},
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
},
// end of the list of possible fields`maintenanceWindow`
},
"plannedOperation": {
"info": "string",
"delayedUntil": "string"
},
"securityGroupIds": [
"string"
],
"deletionProtection": true
}
Field | Description |
---|---|
id | string ID of the ClickHouse cluster. This ID is assigned by MDB at creation time. |
folderId | string ID of the folder that the ClickHouse cluster belongs to. |
createdAt | string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the ClickHouse cluster. 0-256 characters long. |
labels | object Custom labels for the ClickHouse cluster as |
environment | string Deployment environment of the ClickHouse cluster.
|
monitoring[] | object Description of monitoring systems relevant to the ClickHouse cluster. |
monitoring[]. name |
string Name of the monitoring system. |
monitoring[]. description |
string Description of the monitoring system. |
monitoring[]. link |
string Link to the monitoring system charts for the ClickHouse cluster. |
config | object Configuration of the ClickHouse cluster. |
config. version |
string Version of the ClickHouse server software. |
config. clickhouse |
object Configuration and resource allocation for ClickHouse hosts. |
config. clickhouse. config |
object Configuration settings of a ClickHouse server. |
config. clickhouse. config. effectiveConfig |
object Required. Effective settings for a ClickHouse cluster (a combination of settings defined in ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation. Any options not listed here are not supported. |
config. clickhouse. config. effectiveConfig. logLevel |
string Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
config. clickhouse. config. effectiveConfig. mergeTree |
object Settings for the MergeTree engine. See description in ClickHouse documentation. Options specific to the MergeTree table engine. |
config. clickhouse. config. effectiveConfig. mergeTree. replicatedDeduplicationWindow |
integer (int64) Number of blocks of hashes to keep in ZooKeeper. |
config. clickhouse. config. effectiveConfig. mergeTree. replicatedDeduplicationWindowSeconds |
integer (int64) Period of time to keep blocks of hashes for. |
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. |
config. clickhouse. config. effectiveConfig. mergeTree. partsToThrowInsert |
integer (int64) If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
config. clickhouse. config. effectiveConfig. mergeTree. inactivePartsToDelayInsert |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. inactivePartsToThrowInsert |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. maxReplicatedMergesInQueue |
integer (int64) How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
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. |
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). |
config. clickhouse. config. effectiveConfig. mergeTree. maxBytesToMergeAtMaxSpaceInPool |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. minBytesForWidePart |
integer (int64) Minimum number of bytes in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. mergeTree. minRowsForWidePart |
integer (int64) Minimum number of rows in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. mergeTree. ttlOnlyDropParts |
boolean (boolean) Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables. More info see in ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. mergeTree. allowRemoteFsZeroCopyReplication |
boolean (boolean) |
config. clickhouse. config. effectiveConfig. mergeTree. mergeWithTtlTimeout |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. mergeWithRecompressionTtlTimeout |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. maxPartsInTotal |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. maxNumberOfMergesWithTtlInPool |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. cleanupDelayPeriod |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. numberOfFreeEntriesInPoolToExecuteMutation |
integer (int64) |
config. clickhouse. config. effectiveConfig. mergeTree. maxAvgPartSizeForTooManyParts |
integer (int64) The 'too many parts' check according to 'parts_to_delay_insert' and 'parts_to_throw_insert' will be active only if the average part size (in the relevant partition) is not larger than the specified threshold. If it is larger than the specified threshold, the INSERTs will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. Default: 1 GiB Min version: 22.10 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. effectiveConfig. mergeTree. minAgeToForceMergeSeconds |
integer (int64) Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds. Default: 0 - disabled Min_version: 22.10 See in-depth description in ClickHouse documentation The minimum value is 0. |
config. clickhouse. config. effectiveConfig. mergeTree. minAgeToForceMergeOnPartitionOnly |
boolean (boolean) Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. Default: false Min_version: 22.11 See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. mergeTree. mergeSelectingSleepMs |
integer (int64) Sleep time for merge selecting when no part is selected. A lower setting triggers selecting tasks in background_schedule_pool frequently, which results in a large number of requests to ClickHouse Keeper in large-scale clusters. Default: 5000 Min_version: 21.10 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. mergeTree. mergeMaxBlockSize |
integer (int64) The number of rows that are read from the merged parts into memory. Default: 8192 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. mergeTree. checkSampleColumnIsCorrect |
boolean (boolean) Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. Default: true See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. mergeTree. maxMergeSelectingSleepMs |
integer (int64) Maximum sleep time for merge selecting, a lower setting will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to zookeeper in large-scale clusters. Default: 60000 Min_version: 23.6 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. effectiveConfig. mergeTree. maxCleanupDelayPeriod |
integer (int64) Maximum period to clean old queue logs, blocks hashes and parts. Default: 300 Min_version: 23.6 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. effectiveConfig. compression[] |
object Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. compression[]. method |
string Compression method to use for the specified combination of
|
config. clickhouse. config. effectiveConfig. compression[]. minPartSize |
string (int64) Minimum size of a part of a table. The minimum value is 1. |
config. clickhouse. config. effectiveConfig. compression[]. minPartSizeRatio |
number (double) Minimum ratio of a part relative to the size of all the data in the table. |
config. clickhouse. config. effectiveConfig. compression[]. level |
integer (int64) The minimum value is 0. |
config. clickhouse. config. effectiveConfig. dictionaries[] |
object Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. dictionaries[]. name |
string Required. Name of the external dictionary. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure |
object Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. id |
object Single numeric key column for the dictionary. Numeric key. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. id. name |
string Required. Name of the numeric key. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key |
object Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation. Complex key. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[] |
object Required. Attributes of a complex key. Must contain at least one element. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[]. name |
string Required. Name of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[]. type |
string Required. Type of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. key. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin |
object Field holding the beginning of the range for dictionaries with |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. name |
string Required. Name of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. type |
string Required. Type of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMin. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax |
object Field holding the end of the range for dictionaries with |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. name |
string Required. Name of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. type |
string Required. Type of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. rangeMax. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[] |
object Required. Description of the fields available for database queries. For details, see ClickHouse documentation. Must contain at least one element. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[]. name |
string Required. Name of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[]. type |
string Required. Type of the column. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. structure. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. effectiveConfig. dictionaries[]. layout |
object Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation |
config. clickhouse. config. effectiveConfig. dictionaries[]. layout. type |
string Required. Layout type for an external dictionary.
|
config. clickhouse. config. effectiveConfig. dictionaries[]. layout. sizeInCells |
string (int64) Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. |
config. clickhouse. config. effectiveConfig. dictionaries[]. layout. maxArraySize |
string (int64) Maximum dictionary key size. Applicable only for FLAT layout type. |
config. clickhouse. config. effectiveConfig. dictionaries[]. fixedLifetime |
string (int64) config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields fixedLifetime , lifetimeRange Fixed interval between dictionary updates. |
config. clickhouse. config. effectiveConfig. dictionaries[]. lifetimeRange |
object Range of intervals between dictionary updates for ClickHouse to choose from. config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields fixedLifetime , lifetimeRange |
config. clickhouse. config. effectiveConfig. dictionaries[]. lifetimeRange. min |
string (int64) Minimum dictionary lifetime. |
config. clickhouse. config. effectiveConfig. dictionaries[]. lifetimeRange. max |
string (int64) Maximum dictionary lifetime. |
config. clickhouse. config. effectiveConfig. dictionaries[]. httpSource |
object HTTP source for the dictionary. config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. effectiveConfig. dictionaries[]. httpSource. url |
string Required. URL of the source dictionary available over HTTP. |
config. clickhouse. config. effectiveConfig. dictionaries[]. httpSource. format |
string Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect. |
config. clickhouse. config. effectiveConfig. dictionaries[]. httpSource. headers[] |
object HTTP headers. |
config. clickhouse. config. effectiveConfig. dictionaries[]. httpSource. headers[]. name |
string Required. |
config. clickhouse. config. effectiveConfig. dictionaries[]. httpSource. headers[]. value |
string Required. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource |
object MySQL source for the dictionary. config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. db |
string Required. Name of the MySQL database to connect to. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. table |
string Required. Name of the database table to use as a ClickHouse dictionary. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. port |
string (int64) Default port to use when connecting to a replica of the dictionary source. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. user |
string Name of the default user for replicas of the dictionary source. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. password |
string Password of the default user for replicas of the dictionary source. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. replicas[] |
object Required. List of MySQL replicas of the database used as dictionary source. Must contain at least one element. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. replicas[]. host |
string Required. MySQL host of the replica. The maximum string length in characters is 253. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. replicas[]. priority |
string (int64) Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number. Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. replicas[]. port |
string (int64) Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. replicas[]. user |
string Name of the MySQL database user. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. replicas[]. password |
string Password of the MySQL database user. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. where |
string Selection criteria for the data in the specified MySQL table. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. invalidateQuery |
string Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. closeConnection |
boolean (boolean) Should the connection be closed after each request. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mysqlSource. shareConnection |
boolean (boolean) Should a connection be shared for some requests. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource |
object ClickHouse source for the dictionary. config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. db |
string Required. Name of the ClickHouse database. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. host |
string ClickHouse host of the specified database. The maximum string length in characters is 253. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. user |
string Required. Name of the ClickHouse database user. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. password |
string Password of the ClickHouse database user. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. where |
string Selection criteria for the data in the specified ClickHouse table. |
config. clickhouse. config. effectiveConfig. dictionaries[]. clickhouseSource. secure |
boolean (boolean) Use ssl for connection. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource |
object MongoDB source for the dictionary. config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource. db |
string Required. Name of the MongoDB database. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource. collection |
string Required. Name of the collection in the specified database to be used as the dictionary source. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource. host |
string MongoDB host of the specified database. The maximum string length in characters is 253. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource. user |
string Required. Name of the MongoDB database user. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource. password |
string Password of the MongoDB database user. |
config. clickhouse. config. effectiveConfig. dictionaries[]. mongodbSource. options |
string |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource |
object PostgreSQL source for the dictionary. config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. db |
string Required. Name of the PostrgreSQL database. |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. hosts[] |
string Required. Name of the PostrgreSQL host Must contain at least one element. |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. user |
string Required. Name of the PostrgreSQL database user. |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. password |
string Password of the PostrgreSQL database user. |
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. |
config. clickhouse. config. effectiveConfig. dictionaries[]. postgresqlSource. sslMode |
string Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.
|
config. clickhouse. config. effectiveConfig. graphiteRollup[] |
object Settings for thinning Graphite data. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. name |
string Required. Name for the specified combination of settings for Graphite rollup. |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. patterns[] |
object Required. Pattern to use for the rollup. Must contain at least one element. |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. patterns[]. regexp |
string Pattern for metric names. |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. patterns[]. function |
string Required. Name of the aggregating function to apply to data of the age specified in |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. patterns[]. retention[] |
object Required. Age of data to use for thinning. Must contain at least one element. |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. patterns[]. retention[]. age |
string (int64) Minimum age of the data in seconds. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. patterns[]. retention[]. precision |
string (int64) Precision of determining the age of the data, in seconds. Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. pathColumnName |
string The name of the column storing the metric name (Graphite sensor). Default: Path See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. timeColumnName |
string The name of the column storing the time of measuring the metric. Default: Time See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. valueColumnName |
string The name of the column storing the value of the metric at the time set in time_column_name. Default: Value See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. graphiteRollup[]. versionColumnName |
string The name of the column storing the version of the metric. Default: Timestamp See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. kafka |
object |
config. clickhouse. config. effectiveConfig. kafka. securityProtocol |
string |
config. clickhouse. config. effectiveConfig. kafka. saslMechanism |
string |
config. clickhouse. config. effectiveConfig. kafka. saslUsername |
string |
config. clickhouse. config. effectiveConfig. kafka. saslPassword |
string |
config. clickhouse. config. effectiveConfig. kafka. enableSslCertificateVerification |
boolean (boolean) |
config. clickhouse. config. effectiveConfig. kafka. maxPollIntervalMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. effectiveConfig. kafka. sessionTimeoutMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. effectiveConfig. kafka. debug |
string |
config. clickhouse. config. effectiveConfig. kafka. autoOffsetReset |
string |
config. clickhouse. config. effectiveConfig. kafkaTopics[] |
object |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. name |
string Required. |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings |
object Required. |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. securityProtocol |
string |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. saslMechanism |
string |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. saslUsername |
string |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. saslPassword |
string |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. enableSslCertificateVerification |
boolean (boolean) |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. maxPollIntervalMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. sessionTimeoutMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. debug |
string |
config. clickhouse. config. effectiveConfig. kafkaTopics[]. settings. autoOffsetReset |
string |
config. clickhouse. config. effectiveConfig. rabbitmq |
object |
config. clickhouse. config. effectiveConfig. rabbitmq. username |
string RabbitMQ username |
config. clickhouse. config. effectiveConfig. rabbitmq. password |
string RabbitMQ password |
config. clickhouse. config. effectiveConfig. rabbitmq. vhost |
string RabbitMQ virtual host |
config. clickhouse. config. effectiveConfig. maxConnections |
integer (int64) Maximum number of inbound connections. The minimum value is 10. |
config. clickhouse. config. effectiveConfig. maxConcurrentQueries |
integer (int64) Maximum number of simultaneously processed requests. The minimum value is 10. |
config. clickhouse. config. effectiveConfig. keepAliveTimeout |
integer (int64) Number of milliseconds that ClickHouse waits for incoming requests before closing the connection. |
config. clickhouse. config. effectiveConfig. uncompressedCacheSize |
integer (int64) Cache size (in bytes) for uncompressed data used by MergeTree tables. |
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. |
config. clickhouse. config. effectiveConfig. maxTableSizeToDrop |
integer (int64) Maximum size of the table that can be deleted using a DROP query. |
config. clickhouse. config. effectiveConfig. maxPartitionSizeToDrop |
integer (int64) Maximum size of the partition that can be deleted using a DROP query. |
config. clickhouse. config. effectiveConfig. builtinDictionariesReloadInterval |
integer (int64) The setting is deprecated and has no effect. |
config. clickhouse. config. effectiveConfig. timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
config. clickhouse. config. effectiveConfig. geobaseEnabled |
boolean (boolean) Enable or disable geobase. |
config. clickhouse. config. effectiveConfig. geobaseUri |
string Address of the archive with the user geobase in Object Storage. |
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. |
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. |
config. clickhouse. config. effectiveConfig. queryThreadLogEnabled |
boolean (boolean) Whether query_thread_log system table is enabled. |
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. |
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. |
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. |
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. |
config. clickhouse. config. effectiveConfig. metricLogEnabled |
boolean (boolean) Whether metric_log system table is enabled. |
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. |
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. |
config. clickhouse. config. effectiveConfig. traceLogEnabled |
boolean (boolean) Whether trace_log system table is enabled. |
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. |
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. |
config. clickhouse. config. effectiveConfig. textLogEnabled |
boolean (boolean) Whether text_log system table is enabled. |
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. |
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. |
config. clickhouse. config. effectiveConfig. textLogLevel |
string Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
config. clickhouse. config. effectiveConfig. opentelemetrySpanLogEnabled |
boolean (boolean) Enable or disable opentelemetry_span_log system table. Default value: false. |
config. clickhouse. config. effectiveConfig. opentelemetrySpanLogRetentionSize |
integer (int64) The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0 (default), automatic removal of opentelemetry_span_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. opentelemetrySpanLogRetentionTime |
integer (int64) The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, automatic removal of opentelemetry_span_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. queryViewsLogEnabled |
boolean (boolean) Enable or disable query_views_log system table. Default value: false. |
config. clickhouse. config. effectiveConfig. queryViewsLogRetentionSize |
integer (int64) The maximum size that query_views_log can grow to before old data will be removed. If set to 0 (default), automatic removal of query_views_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. queryViewsLogRetentionTime |
integer (int64) The maximum time that query_views_log records will be retained before removal. If set to 0, automatic removal of query_views_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. asynchronousMetricLogEnabled |
boolean (boolean) Enable or disable asynchronous_metric_log system table. Default value: false. |
config. clickhouse. config. effectiveConfig. asynchronousMetricLogRetentionSize |
integer (int64) The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0 (default), automatic removal of asynchronous_metric_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. asynchronousMetricLogRetentionTime |
integer (int64) The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, automatic removal of asynchronous_metric_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. sessionLogEnabled |
boolean (boolean) Enable or disable session_log system table. Default value: false. |
config. clickhouse. config. effectiveConfig. sessionLogRetentionSize |
integer (int64) The maximum size that session_log can grow to before old data will be removed. If set to 0 (default), automatic removal of session_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. sessionLogRetentionTime |
integer (int64) The maximum time that session_log records will be retained before removal. If set to 0, automatic removal of session_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. zookeeperLogEnabled |
boolean (boolean) Enable or disable zookeeper_log system table. Default value: false. |
config. clickhouse. config. effectiveConfig. zookeeperLogRetentionSize |
integer (int64) The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0 (default), automatic removal of zookeeper_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. zookeeperLogRetentionTime |
integer (int64) The maximum time that zookeeper_log records will be retained before removal. If set to 0, automatic removal of zookeeper_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. asynchronousInsertLogEnabled |
boolean (boolean) Enable or disable asynchronous_insert_log system table. Default value: false. Minimal required ClickHouse version: 22.10. |
config. clickhouse. config. effectiveConfig. asynchronousInsertLogRetentionSize |
integer (int64) The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0 (default), automatic removal of asynchronous_insert_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. asynchronousInsertLogRetentionTime |
integer (int64) The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, automatic removal of asynchronous_insert_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. effectiveConfig. backgroundPoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundMergesMutationsConcurrencyRatio |
integer (int64) Sets a ratio between the number of threads and the number of background merges and mutations that can be executed concurrently. For example, if the ratio equals to 2 and background_pool_size is set to 16 then ClickHouse can execute 32 background merges concurrently. This is possible, because background operations could be suspended and postponed. This is needed to give small merges more execution priority. You can only increase this ratio at runtime. To lower it you have to restart the server. The same as for background_pool_size setting background_merges_mutations_concurrency_ratio could be applied from the default profile for backward compatibility. Default: 2 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundFetchesPoolSize |
integer (int64) Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8. More info see in ClickHouse documentation. Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundMovePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundDistributedSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundBufferFlushSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundMessageBrokerSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. backgroundCommonPoolSize |
integer (int64) The maximum number of threads that will be used for performing a variety of operations (mostly garbage collection) for *MergeTree-engine tables in a background. Default: 8 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. effectiveConfig. defaultDatabase |
string The default database. To get a list of cluster databases, see Yandex Managed ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. totalMemoryProfilerStep |
integer (int64) Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304. More info see in ClickHouse documentation. |
config. clickhouse. config. effectiveConfig. totalMemoryTrackerSampleProbability |
number (double) |
config. clickhouse. config. effectiveConfig. queryMaskingRules[] |
object Required. Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, system.query_log, system.text_log, system.processes tables, and in logs sent to the client. That allows preventing sensitive data leakage from SQL queries (like names, emails, personal identifiers or credit card numbers) to logs. Change of these settings is applied with ClickHouse restart See in-depth description in ClickHouse documentation Must contain at least one element. |
config. clickhouse. config. effectiveConfig. queryMaskingRules[]. name |
string Name for the rule. |
config. clickhouse. config. effectiveConfig. queryMaskingRules[]. regexp |
string Required. RE2 compatible regular expression. Required. |
config. clickhouse. config. effectiveConfig. queryMaskingRules[]. replace |
string Substitution string for sensitive data. Default: six asterisks |
config. clickhouse. config. effectiveConfig. dictionariesLazyLoad |
boolean (boolean) Lazy loading of dictionaries. Default: true See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. queryCache |
object Query cache configuration. Min version: 23.5 See in-depth description in ClickHouse documentation |
config. clickhouse. config. effectiveConfig. queryCache. maxSizeInBytes |
integer (int64) The maximum cache size in bytes. Default: 1073741824 (1 GiB) The minimum value is 0. |
config. clickhouse. config. effectiveConfig. queryCache. maxEntries |
integer (int64) The maximum number of SELECT query results stored in the cache. Default: 1024 The minimum value is 0. |
config. clickhouse. config. effectiveConfig. queryCache. maxEntrySizeInBytes |
integer (int64) The maximum size in bytes SELECT query results may have to be saved in the cache. Dafault: 1048576 (1 MiB) The minimum value is 0. |
config. clickhouse. config. effectiveConfig. queryCache. maxEntrySizeInRows |
integer (int64) The maximum number of rows SELECT query results may have to be saved in the cache. Default: 30000000 (30 mil) The minimum value is 0. |
config. clickhouse. config. userConfig |
object User-defined settings for a ClickHouse cluster. ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation. Any options not listed here are not supported. |
config. clickhouse. config. userConfig. logLevel |
string Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
config. clickhouse. config. userConfig. mergeTree |
object Settings for the MergeTree engine. See description in ClickHouse documentation. Options specific to the MergeTree table engine. |
config. clickhouse. config. userConfig. mergeTree. replicatedDeduplicationWindow |
integer (int64) Number of blocks of hashes to keep in ZooKeeper. |
config. clickhouse. config. userConfig. mergeTree. replicatedDeduplicationWindowSeconds |
integer (int64) Period of time to keep blocks of hashes for. |
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. |
config. clickhouse. config. userConfig. mergeTree. partsToThrowInsert |
integer (int64) If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
config. clickhouse. config. userConfig. mergeTree. inactivePartsToDelayInsert |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. inactivePartsToThrowInsert |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. maxReplicatedMergesInQueue |
integer (int64) How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
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. |
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). |
config. clickhouse. config. userConfig. mergeTree. maxBytesToMergeAtMaxSpaceInPool |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. minBytesForWidePart |
integer (int64) Minimum number of bytes in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
config. clickhouse. config. userConfig. mergeTree. minRowsForWidePart |
integer (int64) Minimum number of rows in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
config. clickhouse. config. userConfig. mergeTree. ttlOnlyDropParts |
boolean (boolean) Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables. More info see in ClickHouse documentation. |
config. clickhouse. config. userConfig. mergeTree. allowRemoteFsZeroCopyReplication |
boolean (boolean) |
config. clickhouse. config. userConfig. mergeTree. mergeWithTtlTimeout |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. mergeWithRecompressionTtlTimeout |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. maxPartsInTotal |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. maxNumberOfMergesWithTtlInPool |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. cleanupDelayPeriod |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. numberOfFreeEntriesInPoolToExecuteMutation |
integer (int64) |
config. clickhouse. config. userConfig. mergeTree. maxAvgPartSizeForTooManyParts |
integer (int64) The 'too many parts' check according to 'parts_to_delay_insert' and 'parts_to_throw_insert' will be active only if the average part size (in the relevant partition) is not larger than the specified threshold. If it is larger than the specified threshold, the INSERTs will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. Default: 1 GiB Min version: 22.10 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. userConfig. mergeTree. minAgeToForceMergeSeconds |
integer (int64) Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds. Default: 0 - disabled Min_version: 22.10 See in-depth description in ClickHouse documentation The minimum value is 0. |
config. clickhouse. config. userConfig. mergeTree. minAgeToForceMergeOnPartitionOnly |
boolean (boolean) Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. Default: false Min_version: 22.11 See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. mergeTree. mergeSelectingSleepMs |
integer (int64) Sleep time for merge selecting when no part is selected. A lower setting triggers selecting tasks in background_schedule_pool frequently, which results in a large number of requests to ClickHouse Keeper in large-scale clusters. Default: 5000 Min_version: 21.10 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. userConfig. mergeTree. mergeMaxBlockSize |
integer (int64) The number of rows that are read from the merged parts into memory. Default: 8192 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. userConfig. mergeTree. checkSampleColumnIsCorrect |
boolean (boolean) Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. Default: true See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. mergeTree. maxMergeSelectingSleepMs |
integer (int64) Maximum sleep time for merge selecting, a lower setting will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to zookeeper in large-scale clusters. Default: 60000 Min_version: 23.6 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. userConfig. mergeTree. maxCleanupDelayPeriod |
integer (int64) Maximum period to clean old queue logs, blocks hashes and parts. Default: 300 Min_version: 23.6 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. userConfig. compression[] |
object Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. userConfig. compression[]. method |
string Compression method to use for the specified combination of
|
config. clickhouse. config. userConfig. compression[]. minPartSize |
string (int64) Minimum size of a part of a table. The minimum value is 1. |
config. clickhouse. config. userConfig. compression[]. minPartSizeRatio |
number (double) Minimum ratio of a part relative to the size of all the data in the table. |
config. clickhouse. config. userConfig. compression[]. level |
integer (int64) The minimum value is 0. |
config. clickhouse. config. userConfig. dictionaries[] |
object Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. userConfig. dictionaries[]. name |
string Required. Name of the external dictionary. |
config. clickhouse. config. userConfig. dictionaries[]. structure |
object Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation |
config. clickhouse. config. userConfig. dictionaries[]. structure. id |
object Single numeric key column for the dictionary. Numeric key. |
config. clickhouse. config. userConfig. dictionaries[]. structure. id. name |
string Required. Name of the numeric key. |
config. clickhouse. config. userConfig. dictionaries[]. structure. key |
object Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation. Complex key. |
config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[] |
object Required. Attributes of a complex key. Must contain at least one element. |
config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[]. name |
string Required. Name of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[]. type |
string Required. Type of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. userConfig. dictionaries[]. structure. key. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin |
object Field holding the beginning of the range for dictionaries with |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. name |
string Required. Name of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. type |
string Required. Type of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMin. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax |
object Field holding the end of the range for dictionaries with |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. name |
string Required. Name of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. type |
string Required. Type of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. userConfig. dictionaries[]. structure. rangeMax. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[] |
object Required. Description of the fields available for database queries. For details, see ClickHouse documentation. Must contain at least one element. |
config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[]. name |
string Required. Name of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[]. type |
string Required. Type of the column. |
config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. userConfig. dictionaries[]. structure. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. userConfig. dictionaries[]. layout |
object Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation |
config. clickhouse. config. userConfig. dictionaries[]. layout. type |
string Required. Layout type for an external dictionary.
|
config. clickhouse. config. userConfig. dictionaries[]. layout. sizeInCells |
string (int64) Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. |
config. clickhouse. config. userConfig. dictionaries[]. layout. maxArraySize |
string (int64) Maximum dictionary key size. Applicable only for FLAT layout type. |
config. clickhouse. config. userConfig. dictionaries[]. fixedLifetime |
string (int64) config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields fixedLifetime , lifetimeRange Fixed interval between dictionary updates. |
config. clickhouse. config. userConfig. dictionaries[]. lifetimeRange |
object Range of intervals between dictionary updates for ClickHouse to choose from. config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields fixedLifetime , lifetimeRange |
config. clickhouse. config. userConfig. dictionaries[]. lifetimeRange. min |
string (int64) Minimum dictionary lifetime. |
config. clickhouse. config. userConfig. dictionaries[]. lifetimeRange. max |
string (int64) Maximum dictionary lifetime. |
config. clickhouse. config. userConfig. dictionaries[]. httpSource |
object HTTP source for the dictionary. config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. userConfig. dictionaries[]. httpSource. url |
string Required. URL of the source dictionary available over HTTP. |
config. clickhouse. config. userConfig. dictionaries[]. httpSource. format |
string Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect. |
config. clickhouse. config. userConfig. dictionaries[]. httpSource. headers[] |
object HTTP headers. |
config. clickhouse. config. userConfig. dictionaries[]. httpSource. headers[]. name |
string Required. |
config. clickhouse. config. userConfig. dictionaries[]. httpSource. headers[]. value |
string Required. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource |
object MySQL source for the dictionary. config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. db |
string Required. Name of the MySQL database to connect to. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. table |
string Required. Name of the database table to use as a ClickHouse dictionary. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. port |
string (int64) Default port to use when connecting to a replica of the dictionary source. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. user |
string Name of the default user for replicas of the dictionary source. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. password |
string Password of the default user for replicas of the dictionary source. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. replicas[] |
object Required. List of MySQL replicas of the database used as dictionary source. Must contain at least one element. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. replicas[]. host |
string Required. MySQL host of the replica. The maximum string length in characters is 253. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. replicas[]. priority |
string (int64) Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number. Value must be greater than 0. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. replicas[]. port |
string (int64) Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. replicas[]. user |
string Name of the MySQL database user. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. replicas[]. password |
string Password of the MySQL database user. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. where |
string Selection criteria for the data in the specified MySQL table. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. invalidateQuery |
string Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. closeConnection |
boolean (boolean) Should the connection be closed after each request. |
config. clickhouse. config. userConfig. dictionaries[]. mysqlSource. shareConnection |
boolean (boolean) Should a connection be shared for some requests. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource |
object ClickHouse source for the dictionary. config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. db |
string Required. Name of the ClickHouse database. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. host |
string ClickHouse host of the specified database. The maximum string length in characters is 253. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. user |
string Required. Name of the ClickHouse database user. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. password |
string Password of the ClickHouse database user. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. where |
string Selection criteria for the data in the specified ClickHouse table. |
config. clickhouse. config. userConfig. dictionaries[]. clickhouseSource. secure |
boolean (boolean) Use ssl for connection. |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource |
object MongoDB source for the dictionary. config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource. db |
string Required. Name of the MongoDB database. |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource. collection |
string Required. Name of the collection in the specified database to be used as the dictionary source. |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource. host |
string MongoDB host of the specified database. The maximum string length in characters is 253. |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource. user |
string Required. Name of the MongoDB database user. |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource. password |
string Password of the MongoDB database user. |
config. clickhouse. config. userConfig. dictionaries[]. mongodbSource. options |
string |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource |
object PostgreSQL source for the dictionary. config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. db |
string Required. Name of the PostrgreSQL database. |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. hosts[] |
string Required. Name of the PostrgreSQL host Must contain at least one element. |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. user |
string Required. Name of the PostrgreSQL database user. |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. password |
string Password of the PostrgreSQL database user. |
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. |
config. clickhouse. config. userConfig. dictionaries[]. postgresqlSource. sslMode |
string Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.
|
config. clickhouse. config. userConfig. graphiteRollup[] |
object Settings for thinning Graphite data. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. userConfig. graphiteRollup[]. name |
string Required. Name for the specified combination of settings for Graphite rollup. |
config. clickhouse. config. userConfig. graphiteRollup[]. patterns[] |
object Required. Pattern to use for the rollup. Must contain at least one element. |
config. clickhouse. config. userConfig. graphiteRollup[]. patterns[]. regexp |
string Pattern for metric names. |
config. clickhouse. config. userConfig. graphiteRollup[]. patterns[]. function |
string Required. Name of the aggregating function to apply to data of the age specified in |
config. clickhouse. config. userConfig. graphiteRollup[]. patterns[]. retention[] |
object Required. Age of data to use for thinning. Must contain at least one element. |
config. clickhouse. config. userConfig. graphiteRollup[]. patterns[]. retention[]. age |
string (int64) Minimum age of the data in seconds. The minimum value is 0. |
config. clickhouse. config. userConfig. graphiteRollup[]. patterns[]. retention[]. precision |
string (int64) Precision of determining the age of the data, in seconds. Value must be greater than 0. |
config. clickhouse. config. userConfig. graphiteRollup[]. pathColumnName |
string The name of the column storing the metric name (Graphite sensor). Default: Path See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. graphiteRollup[]. timeColumnName |
string The name of the column storing the time of measuring the metric. Default: Time See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. graphiteRollup[]. valueColumnName |
string The name of the column storing the value of the metric at the time set in time_column_name. Default: Value See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. graphiteRollup[]. versionColumnName |
string The name of the column storing the version of the metric. Default: Timestamp See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. kafka |
object |
config. clickhouse. config. userConfig. kafka. securityProtocol |
string |
config. clickhouse. config. userConfig. kafka. saslMechanism |
string |
config. clickhouse. config. userConfig. kafka. saslUsername |
string |
config. clickhouse. config. userConfig. kafka. saslPassword |
string |
config. clickhouse. config. userConfig. kafka. enableSslCertificateVerification |
boolean (boolean) |
config. clickhouse. config. userConfig. kafka. maxPollIntervalMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. userConfig. kafka. sessionTimeoutMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. userConfig. kafka. debug |
string |
config. clickhouse. config. userConfig. kafka. autoOffsetReset |
string |
config. clickhouse. config. userConfig. kafkaTopics[] |
object |
config. clickhouse. config. userConfig. kafkaTopics[]. name |
string Required. |
config. clickhouse. config. userConfig. kafkaTopics[]. settings |
object Required. |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. securityProtocol |
string |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. saslMechanism |
string |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. saslUsername |
string |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. saslPassword |
string |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. enableSslCertificateVerification |
boolean (boolean) |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. maxPollIntervalMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. sessionTimeoutMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. debug |
string |
config. clickhouse. config. userConfig. kafkaTopics[]. settings. autoOffsetReset |
string |
config. clickhouse. config. userConfig. rabbitmq |
object |
config. clickhouse. config. userConfig. rabbitmq. username |
string RabbitMQ username |
config. clickhouse. config. userConfig. rabbitmq. password |
string RabbitMQ password |
config. clickhouse. config. userConfig. rabbitmq. vhost |
string RabbitMQ virtual host |
config. clickhouse. config. userConfig. maxConnections |
integer (int64) Maximum number of inbound connections. The minimum value is 10. |
config. clickhouse. config. userConfig. maxConcurrentQueries |
integer (int64) Maximum number of simultaneously processed requests. The minimum value is 10. |
config. clickhouse. config. userConfig. keepAliveTimeout |
integer (int64) Number of milliseconds that ClickHouse waits for incoming requests before closing the connection. |
config. clickhouse. config. userConfig. uncompressedCacheSize |
integer (int64) Cache size (in bytes) for uncompressed data used by MergeTree tables. |
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. |
config. clickhouse. config. userConfig. maxTableSizeToDrop |
integer (int64) Maximum size of the table that can be deleted using a DROP query. |
config. clickhouse. config. userConfig. maxPartitionSizeToDrop |
integer (int64) Maximum size of the partition that can be deleted using a DROP query. |
config. clickhouse. config. userConfig. builtinDictionariesReloadInterval |
integer (int64) The setting is deprecated and has no effect. |
config. clickhouse. config. userConfig. timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
config. clickhouse. config. userConfig. geobaseEnabled |
boolean (boolean) Enable or disable geobase. |
config. clickhouse. config. userConfig. geobaseUri |
string Address of the archive with the user geobase in Object Storage. |
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. |
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. |
config. clickhouse. config. userConfig. queryThreadLogEnabled |
boolean (boolean) Whether query_thread_log system table is enabled. |
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. |
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. |
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. |
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. |
config. clickhouse. config. userConfig. metricLogEnabled |
boolean (boolean) Whether metric_log system table is enabled. |
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. |
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. |
config. clickhouse. config. userConfig. traceLogEnabled |
boolean (boolean) Whether trace_log system table is enabled. |
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. |
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. |
config. clickhouse. config. userConfig. textLogEnabled |
boolean (boolean) Whether text_log system table is enabled. |
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. |
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. |
config. clickhouse. config. userConfig. textLogLevel |
string Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
config. clickhouse. config. userConfig. opentelemetrySpanLogEnabled |
boolean (boolean) Enable or disable opentelemetry_span_log system table. Default value: false. |
config. clickhouse. config. userConfig. opentelemetrySpanLogRetentionSize |
integer (int64) The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0 (default), automatic removal of opentelemetry_span_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. opentelemetrySpanLogRetentionTime |
integer (int64) The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, automatic removal of opentelemetry_span_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. queryViewsLogEnabled |
boolean (boolean) Enable or disable query_views_log system table. Default value: false. |
config. clickhouse. config. userConfig. queryViewsLogRetentionSize |
integer (int64) The maximum size that query_views_log can grow to before old data will be removed. If set to 0 (default), automatic removal of query_views_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. queryViewsLogRetentionTime |
integer (int64) The maximum time that query_views_log records will be retained before removal. If set to 0, automatic removal of query_views_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. asynchronousMetricLogEnabled |
boolean (boolean) Enable or disable asynchronous_metric_log system table. Default value: false. |
config. clickhouse. config. userConfig. asynchronousMetricLogRetentionSize |
integer (int64) The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0 (default), automatic removal of asynchronous_metric_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. asynchronousMetricLogRetentionTime |
integer (int64) The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, automatic removal of asynchronous_metric_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. sessionLogEnabled |
boolean (boolean) Enable or disable session_log system table. Default value: false. |
config. clickhouse. config. userConfig. sessionLogRetentionSize |
integer (int64) The maximum size that session_log can grow to before old data will be removed. If set to 0 (default), automatic removal of session_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. sessionLogRetentionTime |
integer (int64) The maximum time that session_log records will be retained before removal. If set to 0, automatic removal of session_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. zookeeperLogEnabled |
boolean (boolean) Enable or disable zookeeper_log system table. Default value: false. |
config. clickhouse. config. userConfig. zookeeperLogRetentionSize |
integer (int64) The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0 (default), automatic removal of zookeeper_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. zookeeperLogRetentionTime |
integer (int64) The maximum time that zookeeper_log records will be retained before removal. If set to 0, automatic removal of zookeeper_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. asynchronousInsertLogEnabled |
boolean (boolean) Enable or disable asynchronous_insert_log system table. Default value: false. Minimal required ClickHouse version: 22.10. |
config. clickhouse. config. userConfig. asynchronousInsertLogRetentionSize |
integer (int64) The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0 (default), automatic removal of asynchronous_insert_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. asynchronousInsertLogRetentionTime |
integer (int64) The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, automatic removal of asynchronous_insert_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. userConfig. backgroundPoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundMergesMutationsConcurrencyRatio |
integer (int64) Sets a ratio between the number of threads and the number of background merges and mutations that can be executed concurrently. For example, if the ratio equals to 2 and background_pool_size is set to 16 then ClickHouse can execute 32 background merges concurrently. This is possible, because background operations could be suspended and postponed. This is needed to give small merges more execution priority. You can only increase this ratio at runtime. To lower it you have to restart the server. The same as for background_pool_size setting background_merges_mutations_concurrency_ratio could be applied from the default profile for backward compatibility. Default: 2 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundFetchesPoolSize |
integer (int64) Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8. More info see in ClickHouse documentation. Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundMovePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundDistributedSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundBufferFlushSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundMessageBrokerSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. userConfig. backgroundCommonPoolSize |
integer (int64) The maximum number of threads that will be used for performing a variety of operations (mostly garbage collection) for *MergeTree-engine tables in a background. Default: 8 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. userConfig. defaultDatabase |
string The default database. To get a list of cluster databases, see Yandex Managed ClickHouse documentation. |
config. clickhouse. config. userConfig. totalMemoryProfilerStep |
integer (int64) Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304. More info see in ClickHouse documentation. |
config. clickhouse. config. userConfig. totalMemoryTrackerSampleProbability |
number (double) |
config. clickhouse. config. userConfig. queryMaskingRules[] |
object Required. Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, system.query_log, system.text_log, system.processes tables, and in logs sent to the client. That allows preventing sensitive data leakage from SQL queries (like names, emails, personal identifiers or credit card numbers) to logs. Change of these settings is applied with ClickHouse restart See in-depth description in ClickHouse documentation Must contain at least one element. |
config. clickhouse. config. userConfig. queryMaskingRules[]. name |
string Name for the rule. |
config. clickhouse. config. userConfig. queryMaskingRules[]. regexp |
string Required. RE2 compatible regular expression. Required. |
config. clickhouse. config. userConfig. queryMaskingRules[]. replace |
string Substitution string for sensitive data. Default: six asterisks |
config. clickhouse. config. userConfig. dictionariesLazyLoad |
boolean (boolean) Lazy loading of dictionaries. Default: true See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. queryCache |
object Query cache configuration. Min version: 23.5 See in-depth description in ClickHouse documentation |
config. clickhouse. config. userConfig. queryCache. maxSizeInBytes |
integer (int64) The maximum cache size in bytes. Default: 1073741824 (1 GiB) The minimum value is 0. |
config. clickhouse. config. userConfig. queryCache. maxEntries |
integer (int64) The maximum number of SELECT query results stored in the cache. Default: 1024 The minimum value is 0. |
config. clickhouse. config. userConfig. queryCache. maxEntrySizeInBytes |
integer (int64) The maximum size in bytes SELECT query results may have to be saved in the cache. Dafault: 1048576 (1 MiB) The minimum value is 0. |
config. clickhouse. config. userConfig. queryCache. maxEntrySizeInRows |
integer (int64) The maximum number of rows SELECT query results may have to be saved in the cache. Default: 30000000 (30 mil) The minimum value is 0. |
config. clickhouse. config. defaultConfig |
object Default configuration for a ClickHouse cluster. ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation. Any options not listed here are not supported. |
config. clickhouse. config. defaultConfig. logLevel |
string Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
config. clickhouse. config. defaultConfig. mergeTree |
object Settings for the MergeTree engine. See description in ClickHouse documentation. Options specific to the MergeTree table engine. |
config. clickhouse. config. defaultConfig. mergeTree. replicatedDeduplicationWindow |
integer (int64) Number of blocks of hashes to keep in ZooKeeper. |
config. clickhouse. config. defaultConfig. mergeTree. replicatedDeduplicationWindowSeconds |
integer (int64) Period of time to keep blocks of hashes for. |
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. |
config. clickhouse. config. defaultConfig. mergeTree. partsToThrowInsert |
integer (int64) If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
config. clickhouse. config. defaultConfig. mergeTree. inactivePartsToDelayInsert |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. inactivePartsToThrowInsert |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. maxReplicatedMergesInQueue |
integer (int64) How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
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. |
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). |
config. clickhouse. config. defaultConfig. mergeTree. maxBytesToMergeAtMaxSpaceInPool |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. minBytesForWidePart |
integer (int64) Minimum number of bytes in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
config. clickhouse. config. defaultConfig. mergeTree. minRowsForWidePart |
integer (int64) Minimum number of rows in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
config. clickhouse. config. defaultConfig. mergeTree. ttlOnlyDropParts |
boolean (boolean) Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables. More info see in ClickHouse documentation. |
config. clickhouse. config. defaultConfig. mergeTree. allowRemoteFsZeroCopyReplication |
boolean (boolean) |
config. clickhouse. config. defaultConfig. mergeTree. mergeWithTtlTimeout |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. mergeWithRecompressionTtlTimeout |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. maxPartsInTotal |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. maxNumberOfMergesWithTtlInPool |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. cleanupDelayPeriod |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. numberOfFreeEntriesInPoolToExecuteMutation |
integer (int64) |
config. clickhouse. config. defaultConfig. mergeTree. maxAvgPartSizeForTooManyParts |
integer (int64) The 'too many parts' check according to 'parts_to_delay_insert' and 'parts_to_throw_insert' will be active only if the average part size (in the relevant partition) is not larger than the specified threshold. If it is larger than the specified threshold, the INSERTs will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. Default: 1 GiB Min version: 22.10 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. defaultConfig. mergeTree. minAgeToForceMergeSeconds |
integer (int64) Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds. Default: 0 - disabled Min_version: 22.10 See in-depth description in ClickHouse documentation The minimum value is 0. |
config. clickhouse. config. defaultConfig. mergeTree. minAgeToForceMergeOnPartitionOnly |
boolean (boolean) Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. Default: false Min_version: 22.11 See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. mergeTree. mergeSelectingSleepMs |
integer (int64) Sleep time for merge selecting when no part is selected. A lower setting triggers selecting tasks in background_schedule_pool frequently, which results in a large number of requests to ClickHouse Keeper in large-scale clusters. Default: 5000 Min_version: 21.10 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. defaultConfig. mergeTree. mergeMaxBlockSize |
integer (int64) The number of rows that are read from the merged parts into memory. Default: 8192 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. defaultConfig. mergeTree. checkSampleColumnIsCorrect |
boolean (boolean) Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. Default: true See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. mergeTree. maxMergeSelectingSleepMs |
integer (int64) Maximum sleep time for merge selecting, a lower setting will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to zookeeper in large-scale clusters. Default: 60000 Min_version: 23.6 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. defaultConfig. mergeTree. maxCleanupDelayPeriod |
integer (int64) Maximum period to clean old queue logs, blocks hashes and parts. Default: 300 Min_version: 23.6 See in-depth description in ClickHouse GitHub The minimum value is 0. |
config. clickhouse. config. defaultConfig. compression[] |
object Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. defaultConfig. compression[]. method |
string Compression method to use for the specified combination of
|
config. clickhouse. config. defaultConfig. compression[]. minPartSize |
string (int64) Minimum size of a part of a table. The minimum value is 1. |
config. clickhouse. config. defaultConfig. compression[]. minPartSizeRatio |
number (double) Minimum ratio of a part relative to the size of all the data in the table. |
config. clickhouse. config. defaultConfig. compression[]. level |
integer (int64) The minimum value is 0. |
config. clickhouse. config. defaultConfig. dictionaries[] |
object Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. defaultConfig. dictionaries[]. name |
string Required. Name of the external dictionary. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure |
object Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. id |
object Single numeric key column for the dictionary. Numeric key. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. id. name |
string Required. Name of the numeric key. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key |
object Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation. Complex key. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[] |
object Required. Attributes of a complex key. Must contain at least one element. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[]. name |
string Required. Name of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[]. type |
string Required. Type of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. key. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin |
object Field holding the beginning of the range for dictionaries with |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. name |
string Required. Name of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. type |
string Required. Type of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMin. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax |
object Field holding the end of the range for dictionaries with |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. name |
string Required. Name of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. type |
string Required. Type of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. rangeMax. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[] |
object Required. Description of the fields available for database queries. For details, see ClickHouse documentation. Must contain at least one element. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[]. name |
string Required. Name of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[]. type |
string Required. Type of the column. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[]. nullValue |
string Default value for an element without data (for example, an empty string). |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[]. expression |
string Expression, describing the attribute, if applicable. |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[]. hierarchical |
boolean (boolean) Indication of hierarchy support. Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. structure. attributes[]. injective |
boolean (boolean) Indication of injective mapping "id -> attribute". Default value: |
config. clickhouse. config. defaultConfig. dictionaries[]. layout |
object Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation |
config. clickhouse. config. defaultConfig. dictionaries[]. layout. type |
string Required. Layout type for an external dictionary.
|
config. clickhouse. config. defaultConfig. dictionaries[]. layout. sizeInCells |
string (int64) Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. |
config. clickhouse. config. defaultConfig. dictionaries[]. layout. maxArraySize |
string (int64) Maximum dictionary key size. Applicable only for FLAT layout type. |
config. clickhouse. config. defaultConfig. dictionaries[]. fixedLifetime |
string (int64) config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields fixedLifetime , lifetimeRange Fixed interval between dictionary updates. |
config. clickhouse. config. defaultConfig. dictionaries[]. lifetimeRange |
object Range of intervals between dictionary updates for ClickHouse to choose from. config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields fixedLifetime , lifetimeRange |
config. clickhouse. config. defaultConfig. dictionaries[]. lifetimeRange. min |
string (int64) Minimum dictionary lifetime. |
config. clickhouse. config. defaultConfig. dictionaries[]. lifetimeRange. max |
string (int64) Maximum dictionary lifetime. |
config. clickhouse. config. defaultConfig. dictionaries[]. httpSource |
object HTTP source for the dictionary. config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. defaultConfig. dictionaries[]. httpSource. url |
string Required. URL of the source dictionary available over HTTP. |
config. clickhouse. config. defaultConfig. dictionaries[]. httpSource. format |
string Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect. |
config. clickhouse. config. defaultConfig. dictionaries[]. httpSource. headers[] |
object HTTP headers. |
config. clickhouse. config. defaultConfig. dictionaries[]. httpSource. headers[]. name |
string Required. |
config. clickhouse. config. defaultConfig. dictionaries[]. httpSource. headers[]. value |
string Required. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource |
object MySQL source for the dictionary. config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. db |
string Required. Name of the MySQL database to connect to. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. table |
string Required. Name of the database table to use as a ClickHouse dictionary. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. port |
string (int64) Default port to use when connecting to a replica of the dictionary source. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. user |
string Name of the default user for replicas of the dictionary source. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. password |
string Password of the default user for replicas of the dictionary source. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. replicas[] |
object Required. List of MySQL replicas of the database used as dictionary source. Must contain at least one element. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. replicas[]. host |
string Required. MySQL host of the replica. The maximum string length in characters is 253. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. replicas[]. priority |
string (int64) Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number. Value must be greater than 0. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. replicas[]. port |
string (int64) Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. replicas[]. user |
string Name of the MySQL database user. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. replicas[]. password |
string Password of the MySQL database user. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. where |
string Selection criteria for the data in the specified MySQL table. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. invalidateQuery |
string Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. closeConnection |
boolean (boolean) Should the connection be closed after each request. |
config. clickhouse. config. defaultConfig. dictionaries[]. mysqlSource. shareConnection |
boolean (boolean) Should a connection be shared for some requests. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource |
object ClickHouse source for the dictionary. config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. db |
string Required. Name of the ClickHouse database. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. host |
string ClickHouse host of the specified database. The maximum string length in characters is 253. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. user |
string Required. Name of the ClickHouse database user. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. password |
string Password of the ClickHouse database user. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. where |
string Selection criteria for the data in the specified ClickHouse table. |
config. clickhouse. config. defaultConfig. dictionaries[]. clickhouseSource. secure |
boolean (boolean) Use ssl for connection. |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource |
object MongoDB source for the dictionary. config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource. db |
string Required. Name of the MongoDB database. |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource. collection |
string Required. Name of the collection in the specified database to be used as the dictionary source. |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource. host |
string MongoDB host of the specified database. The maximum string length in characters is 253. |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource. user |
string Required. Name of the MongoDB database user. |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource. password |
string Password of the MongoDB database user. |
config. clickhouse. config. defaultConfig. dictionaries[]. mongodbSource. options |
string |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource |
object PostgreSQL source for the dictionary. config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource , mysqlSource , clickhouseSource , mongodbSource , postgresqlSource |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. db |
string Required. Name of the PostrgreSQL database. |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. table |
string Required. Name of the table in the specified database to be used as the dictionary source. |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. hosts[] |
string Required. Name of the PostrgreSQL host Must contain at least one element. |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. port |
string (int64) Port to use when connecting to the host. Acceptable values are 0 to 65535, inclusive. |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. user |
string Required. Name of the PostrgreSQL database user. |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. password |
string Password of the PostrgreSQL database user. |
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. |
config. clickhouse. config. defaultConfig. dictionaries[]. postgresqlSource. sslMode |
string Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.
|
config. clickhouse. config. defaultConfig. graphiteRollup[] |
object Settings for thinning Graphite data. See in-depth description in ClickHouse documentation. |
config. clickhouse. config. defaultConfig. graphiteRollup[]. name |
string Required. Name for the specified combination of settings for Graphite rollup. |
config. clickhouse. config. defaultConfig. graphiteRollup[]. patterns[] |
object Required. Pattern to use for the rollup. Must contain at least one element. |
config. clickhouse. config. defaultConfig. graphiteRollup[]. patterns[]. regexp |
string Pattern for metric names. |
config. clickhouse. config. defaultConfig. graphiteRollup[]. patterns[]. function |
string Required. Name of the aggregating function to apply to data of the age specified in |
config. clickhouse. config. defaultConfig. graphiteRollup[]. patterns[]. retention[] |
object Required. Age of data to use for thinning. Must contain at least one element. |
config. clickhouse. config. defaultConfig. graphiteRollup[]. patterns[]. retention[]. age |
string (int64) Minimum age of the data in seconds. The minimum value is 0. |
config. clickhouse. config. defaultConfig. graphiteRollup[]. patterns[]. retention[]. precision |
string (int64) Precision of determining the age of the data, in seconds. Value must be greater than 0. |
config. clickhouse. config. defaultConfig. graphiteRollup[]. pathColumnName |
string The name of the column storing the metric name (Graphite sensor). Default: Path See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. graphiteRollup[]. timeColumnName |
string The name of the column storing the time of measuring the metric. Default: Time See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. graphiteRollup[]. valueColumnName |
string The name of the column storing the value of the metric at the time set in time_column_name. Default: Value See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. graphiteRollup[]. versionColumnName |
string The name of the column storing the version of the metric. Default: Timestamp See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. kafka |
object |
config. clickhouse. config. defaultConfig. kafka. securityProtocol |
string |
config. clickhouse. config. defaultConfig. kafka. saslMechanism |
string |
config. clickhouse. config. defaultConfig. kafka. saslUsername |
string |
config. clickhouse. config. defaultConfig. kafka. saslPassword |
string |
config. clickhouse. config. defaultConfig. kafka. enableSslCertificateVerification |
boolean (boolean) |
config. clickhouse. config. defaultConfig. kafka. maxPollIntervalMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. defaultConfig. kafka. sessionTimeoutMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. defaultConfig. kafka. debug |
string |
config. clickhouse. config. defaultConfig. kafka. autoOffsetReset |
string |
config. clickhouse. config. defaultConfig. kafkaTopics[] |
object |
config. clickhouse. config. defaultConfig. kafkaTopics[]. name |
string Required. |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings |
object Required. |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. securityProtocol |
string |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. saslMechanism |
string |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. saslUsername |
string |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. saslPassword |
string |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. enableSslCertificateVerification |
boolean (boolean) |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. maxPollIntervalMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. sessionTimeoutMs |
integer (int64) The minimum value is 0. |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. debug |
string |
config. clickhouse. config. defaultConfig. kafkaTopics[]. settings. autoOffsetReset |
string |
config. clickhouse. config. defaultConfig. rabbitmq |
object |
config. clickhouse. config. defaultConfig. rabbitmq. username |
string RabbitMQ username |
config. clickhouse. config. defaultConfig. rabbitmq. password |
string RabbitMQ password |
config. clickhouse. config. defaultConfig. rabbitmq. vhost |
string RabbitMQ virtual host |
config. clickhouse. config. defaultConfig. maxConnections |
integer (int64) Maximum number of inbound connections. The minimum value is 10. |
config. clickhouse. config. defaultConfig. maxConcurrentQueries |
integer (int64) Maximum number of simultaneously processed requests. The minimum value is 10. |
config. clickhouse. config. defaultConfig. keepAliveTimeout |
integer (int64) Number of milliseconds that ClickHouse waits for incoming requests before closing the connection. |
config. clickhouse. config. defaultConfig. uncompressedCacheSize |
integer (int64) Cache size (in bytes) for uncompressed data used by MergeTree tables. |
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. |
config. clickhouse. config. defaultConfig. maxTableSizeToDrop |
integer (int64) Maximum size of the table that can be deleted using a DROP query. |
config. clickhouse. config. defaultConfig. maxPartitionSizeToDrop |
integer (int64) Maximum size of the partition that can be deleted using a DROP query. |
config. clickhouse. config. defaultConfig. builtinDictionariesReloadInterval |
integer (int64) The setting is deprecated and has no effect. |
config. clickhouse. config. defaultConfig. timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
config. clickhouse. config. defaultConfig. geobaseEnabled |
boolean (boolean) Enable or disable geobase. |
config. clickhouse. config. defaultConfig. geobaseUri |
string Address of the archive with the user geobase in Object Storage. |
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. |
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. |
config. clickhouse. config. defaultConfig. queryThreadLogEnabled |
boolean (boolean) Whether query_thread_log system table is enabled. |
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. |
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. |
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. |
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. |
config. clickhouse. config. defaultConfig. metricLogEnabled |
boolean (boolean) Whether metric_log system table is enabled. |
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. |
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. |
config. clickhouse. config. defaultConfig. traceLogEnabled |
boolean (boolean) Whether trace_log system table is enabled. |
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. |
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. |
config. clickhouse. config. defaultConfig. textLogEnabled |
boolean (boolean) Whether text_log system table is enabled. |
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. |
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. |
config. clickhouse. config. defaultConfig. textLogLevel |
string Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR. |
config. clickhouse. config. defaultConfig. opentelemetrySpanLogEnabled |
boolean (boolean) Enable or disable opentelemetry_span_log system table. Default value: false. |
config. clickhouse. config. defaultConfig. opentelemetrySpanLogRetentionSize |
integer (int64) The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0 (default), automatic removal of opentelemetry_span_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. opentelemetrySpanLogRetentionTime |
integer (int64) The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, automatic removal of opentelemetry_span_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. queryViewsLogEnabled |
boolean (boolean) Enable or disable query_views_log system table. Default value: false. |
config. clickhouse. config. defaultConfig. queryViewsLogRetentionSize |
integer (int64) The maximum size that query_views_log can grow to before old data will be removed. If set to 0 (default), automatic removal of query_views_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. queryViewsLogRetentionTime |
integer (int64) The maximum time that query_views_log records will be retained before removal. If set to 0, automatic removal of query_views_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. asynchronousMetricLogEnabled |
boolean (boolean) Enable or disable asynchronous_metric_log system table. Default value: false. |
config. clickhouse. config. defaultConfig. asynchronousMetricLogRetentionSize |
integer (int64) The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0 (default), automatic removal of asynchronous_metric_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. asynchronousMetricLogRetentionTime |
integer (int64) The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, automatic removal of asynchronous_metric_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. sessionLogEnabled |
boolean (boolean) Enable or disable session_log system table. Default value: false. |
config. clickhouse. config. defaultConfig. sessionLogRetentionSize |
integer (int64) The maximum size that session_log can grow to before old data will be removed. If set to 0 (default), automatic removal of session_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. sessionLogRetentionTime |
integer (int64) The maximum time that session_log records will be retained before removal. If set to 0, automatic removal of session_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. zookeeperLogEnabled |
boolean (boolean) Enable or disable zookeeper_log system table. Default value: false. |
config. clickhouse. config. defaultConfig. zookeeperLogRetentionSize |
integer (int64) The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0 (default), automatic removal of zookeeper_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. zookeeperLogRetentionTime |
integer (int64) The maximum time that zookeeper_log records will be retained before removal. If set to 0, automatic removal of zookeeper_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. asynchronousInsertLogEnabled |
boolean (boolean) Enable or disable asynchronous_insert_log system table. Default value: false. Minimal required ClickHouse version: 22.10. |
config. clickhouse. config. defaultConfig. asynchronousInsertLogRetentionSize |
integer (int64) The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0 (default), automatic removal of asynchronous_insert_log data based on size is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. asynchronousInsertLogRetentionTime |
integer (int64) The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, automatic removal of asynchronous_insert_log data based on time is disabled. The minimum value is 0. |
config. clickhouse. config. defaultConfig. backgroundPoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundMergesMutationsConcurrencyRatio |
integer (int64) Sets a ratio between the number of threads and the number of background merges and mutations that can be executed concurrently. For example, if the ratio equals to 2 and background_pool_size is set to 16 then ClickHouse can execute 32 background merges concurrently. This is possible, because background operations could be suspended and postponed. This is needed to give small merges more execution priority. You can only increase this ratio at runtime. To lower it you have to restart the server. The same as for background_pool_size setting background_merges_mutations_concurrency_ratio could be applied from the default profile for backward compatibility. Default: 2 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundFetchesPoolSize |
integer (int64) Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8. More info see in ClickHouse documentation. Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundMovePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundDistributedSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundBufferFlushSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundMessageBrokerSchedulePoolSize |
integer (int64) Value must be greater than 0. |
config. clickhouse. config. defaultConfig. backgroundCommonPoolSize |
integer (int64) The maximum number of threads that will be used for performing a variety of operations (mostly garbage collection) for *MergeTree-engine tables in a background. Default: 8 See in-depth description in ClickHouse documentation Value must be greater than 0. |
config. clickhouse. config. defaultConfig. defaultDatabase |
string The default database. To get a list of cluster databases, see Yandex Managed ClickHouse documentation. |
config. clickhouse. config. defaultConfig. totalMemoryProfilerStep |
integer (int64) Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304. More info see in ClickHouse documentation. |
config. clickhouse. config. defaultConfig. totalMemoryTrackerSampleProbability |
number (double) |
config. clickhouse. config. defaultConfig. queryMaskingRules[] |
object Required. Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, system.query_log, system.text_log, system.processes tables, and in logs sent to the client. That allows preventing sensitive data leakage from SQL queries (like names, emails, personal identifiers or credit card numbers) to logs. Change of these settings is applied with ClickHouse restart See in-depth description in ClickHouse documentation Must contain at least one element. |
config. clickhouse. config. defaultConfig. queryMaskingRules[]. name |
string Name for the rule. |
config. clickhouse. config. defaultConfig. queryMaskingRules[]. regexp |
string Required. RE2 compatible regular expression. Required. |
config. clickhouse. config. defaultConfig. queryMaskingRules[]. replace |
string Substitution string for sensitive data. Default: six asterisks |
config. clickhouse. config. defaultConfig. dictionariesLazyLoad |
boolean (boolean) Lazy loading of dictionaries. Default: true See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. queryCache |
object Query cache configuration. Min version: 23.5 See in-depth description in ClickHouse documentation |
config. clickhouse. config. defaultConfig. queryCache. maxSizeInBytes |
integer (int64) The maximum cache size in bytes. Default: 1073741824 (1 GiB) The minimum value is 0. |
config. clickhouse. config. defaultConfig. queryCache. maxEntries |
integer (int64) The maximum number of SELECT query results stored in the cache. Default: 1024 The minimum value is 0. |
config. clickhouse. config. defaultConfig. queryCache. maxEntrySizeInBytes |
integer (int64) The maximum size in bytes SELECT query results may have to be saved in the cache. Dafault: 1048576 (1 MiB) The minimum value is 0. |
config. clickhouse. config. defaultConfig. queryCache. maxEntrySizeInRows |
integer (int64) The maximum number of rows SELECT query results may have to be saved in the cache. Default: 30000000 (30 mil) The minimum value is 0. |
config. clickhouse. resources |
object Resources allocated to ClickHouse hosts. |
config. clickhouse. resources. resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation |
config. clickhouse. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
config. clickhouse. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
config. zookeeper |
object Configuration and resource allocation for ZooKeeper hosts. |
config. zookeeper. resources |
object Resources allocated to ZooKeeper hosts. |
config. zookeeper. resources. resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation |
config. zookeeper. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
config. zookeeper. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
config. backupWindowStart |
object Time to start the daily backup, in the UTC timezone. Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. |
config. backupWindowStart. hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
config. backupWindowStart. minutes |
integer (int32) Minutes of hour of day. Must be from 0 to 59. |
config. backupWindowStart. seconds |
integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
config. backupWindowStart. nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
config. access |
object Access policy for external services. |
config. access. dataLens |
boolean (boolean) Allow to export data from the cluster to DataLens. |
config. access. webSql |
boolean (boolean) Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
config. access. metrika |
boolean (boolean) Allow to import data from Yandex Metrica and AppMetrica to the cluster. See AppMetrica documentation for more details. |
config. access. serverless |
boolean (boolean) Allow access to cluster for Serverless. |
config. access. dataTransfer |
boolean (boolean) Allow access for DataTransfer |
config. access. yandexQuery |
boolean (boolean) Allow access for Query |
config. cloudStorage |
object |
config. cloudStorage. enabled |
boolean (boolean) Whether to use Object Storage for storing ClickHouse data. |
config. cloudStorage. moveFactor |
number (double) Acceptable values are 0 to 1, inclusive. |
config. cloudStorage. dataCacheEnabled |
boolean (boolean) |
config. cloudStorage. dataCacheMaxSize |
integer (int64) |
config. cloudStorage. preferNotToMerge |
boolean (boolean) |
config. sqlDatabaseManagement |
boolean (boolean) Whether database management through SQL commands is enabled. |
config. sqlUserManagement |
boolean (boolean) Whether user management through SQL commands is enabled. |
config. embeddedKeeper |
boolean (boolean) Whether cluster should use embedded Keeper instead of Zookeeper. |
config. backupRetainPeriodDays |
integer (int64) Retain period of automatically created backup in days |
networkId | string ID of the network that the cluster belongs to. |
health | string Aggregated cluster health.
|
status | string Current state of the cluster.
|
serviceAccountId | string ID of the service account used for access to Object Storage. |
maintenanceWindow | object Maintenance window for the cluster. A maintenance window settings. |
maintenanceWindow. anytime |
object Maintenance operation can be scheduled anytime. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow |
object Maintenance operation can be scheduled on a weekly basis. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow. day |
string Day of the week (in |
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in UTC (in Acceptable values are 1 to 24, inclusive. |
plannedOperation | object Planned maintenance operation to be started for the cluster within the nearest maintenanceWindow. A planned maintenance operation. |
plannedOperation. info |
string Information about this maintenance operation. The maximum string length in characters is 256. |
plannedOperation. delayedUntil |
string (date-time) Time until which this maintenance operation is delayed. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
securityGroupIds[] | string User security groups |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
Methods
Method | Description |
---|---|
addHosts | Creates new hosts for a cluster. |
addShard | Creates a new shard in the specified cluster. |
addShards | Creates one or more shards in the specified cluster. |
addZookeeper | Adds a ZooKeeper subcluster to the specified ClickHouse cluster. |
backup | Creates a backup for the specified ClickHouse cluster. |
create | Creates a ClickHouse cluster in the specified folder. |
createExternalDictionary | Creates an external dictionary for the specified ClickHouse cluster. |
createShardGroup | Creates a new shard group in the specified cluster. |
delete | Deletes the specified ClickHouse cluster. |
deleteExternalDictionary | Deletes the specified external dictionary. |
deleteHosts | Deletes the specified hosts for a cluster. |
deleteShard | Deletes the specified shard. |
deleteShardGroup | Deletes the specified shard group. |
deleteShards | Deletes the specified shards (one or more). |
get | Returns the specified ClickHouse cluster. |
getShard | Returns the specified shard. |
getShardGroup | Returns the specified shard group. |
list | Retrieves a list of ClickHouse clusters that belong to the specified folder. |
listBackups | Retrieves the list of available backups for the specified ClickHouse cluster. |
listExternalDictionaries | Retrieves a list of external dictionaries that belong to specified cluster. |
listHosts | Retrieves a list of hosts for the specified cluster. |
listLogs | Retrieves logs for the specified ClickHouse cluster. |
listOperations | Retrieves the list of Operation resources for the specified cluster. |
listShardGroups | Retrieves a list of shard groups that belong to specified cluster. |
listShards | Retrieves a list of shards that belong to the specified cluster. |
move | Moves a ClickHouse cluster to the specified folder. |
rescheduleMaintenance | Reschedules planned maintenance operation. |
restartHosts | |
restore | Creates a new ClickHouse cluster using the specified backup. |
start | Starts the specified ClickHouse cluster. |
stop | Stops the specified ClickHouse cluster. |
streamLogs | Same as ListLogs but using server-side streaming. Also allows for tail -f semantics. |
update | Updates the specified ClickHouse cluster. |
updateExternalDictionary | Updates an external dictionary for the specified ClickHouse cluster. |
updateHosts | Updates the specified hosts. |
updateShard | Modifies the specified shard. |
updateShardGroup | Updates the specified shard group. |