Managed Service for ClickHouse API, gRPC: ClusterService.Backup
- gRPC request
- BackupClusterRequest
- operation.Operation
- BackupClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Clickhouse
- ClickhouseConfigSet
- ClickhouseConfig
- MergeTree
- Compression
- ExternalDictionary
- Structure
- Id
- Key
- Attribute
- Layout
- Range
- HttpSource
- Header
- MysqlSource
- Replica
- ClickhouseSource
- MongodbSource
- PostgresqlSource
- GraphiteRollup
- Pattern
- Retention
- Kafka
- KafkaTopic
- Rabbitmq
- QueryMaskingRule
- QueryCache
- Resources
- Zookeeper
- Access
- CloudStorage
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Creates a backup for the specified ClickHouse cluster.
gRPC request
rpc Backup (BackupClusterRequest) returns (operation.Operation)
BackupClusterRequest
{
"clusterId": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the ClickHouse cluster to back up. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"environment": "Environment",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"clickhouse": {
"config": {
"effectiveConfig": {
"logLevel": "LogLevel",
"mergeTree": {
"replicatedDeduplicationWindow": "google.protobuf.Int64Value",
"replicatedDeduplicationWindowSeconds": "google.protobuf.Int64Value",
"partsToDelayInsert": "google.protobuf.Int64Value",
"partsToThrowInsert": "google.protobuf.Int64Value",
"inactivePartsToDelayInsert": "google.protobuf.Int64Value",
"inactivePartsToThrowInsert": "google.protobuf.Int64Value",
"maxReplicatedMergesInQueue": "google.protobuf.Int64Value",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "google.protobuf.Int64Value",
"maxBytesToMergeAtMinSpaceInPool": "google.protobuf.Int64Value",
"maxBytesToMergeAtMaxSpaceInPool": "google.protobuf.Int64Value",
"minBytesForWidePart": "google.protobuf.Int64Value",
"minRowsForWidePart": "google.protobuf.Int64Value",
"ttlOnlyDropParts": "google.protobuf.BoolValue",
"allowRemoteFsZeroCopyReplication": "google.protobuf.BoolValue",
"mergeWithTtlTimeout": "google.protobuf.Int64Value",
"mergeWithRecompressionTtlTimeout": "google.protobuf.Int64Value",
"maxPartsInTotal": "google.protobuf.Int64Value",
"maxNumberOfMergesWithTtlInPool": "google.protobuf.Int64Value",
"cleanupDelayPeriod": "google.protobuf.Int64Value",
"numberOfFreeEntriesInPoolToExecuteMutation": "google.protobuf.Int64Value",
"maxAvgPartSizeForTooManyParts": "google.protobuf.Int64Value",
"minAgeToForceMergeSeconds": "google.protobuf.Int64Value",
"minAgeToForceMergeOnPartitionOnly": "google.protobuf.BoolValue",
"mergeSelectingSleepMs": "google.protobuf.Int64Value",
"mergeMaxBlockSize": "google.protobuf.Int64Value",
"checkSampleColumnIsCorrect": "google.protobuf.BoolValue",
"maxMergeSelectingSleepMs": "google.protobuf.Int64Value",
"maxCleanupDelayPeriod": "google.protobuf.Int64Value"
},
"compression": [
{
"method": "Method",
"minPartSize": "int64",
"minPartSizeRatio": "double",
"level": "google.protobuf.Int64Value"
}
],
"dictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"layout": {
"type": "Type",
"sizeInCells": "int64",
"maxArraySize": "int64"
},
// Includes only one of the fields `fixedLifetime`, `lifetimeRange`
"fixedLifetime": "int64",
"lifetimeRange": {
"min": "int64",
"max": "int64"
},
// end of the list of possible fields
// Includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"httpSource": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "int64",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "int64",
"port": "int64",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string",
"closeConnection": "google.protobuf.BoolValue",
"shareConnection": "google.protobuf.BoolValue"
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"where": "string",
"secure": "google.protobuf.BoolValue"
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "int64",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "SslMode"
}
// end of the list of possible fields
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "int64",
"precision": "int64"
}
]
}
],
"pathColumnName": "string",
"timeColumnName": "string",
"valueColumnName": "string",
"versionColumnName": "string"
}
],
"kafka": {
"securityProtocol": "SecurityProtocol",
"saslMechanism": "SaslMechanism",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": "google.protobuf.BoolValue",
"maxPollIntervalMs": "google.protobuf.Int64Value",
"sessionTimeoutMs": "google.protobuf.Int64Value",
"debug": "Debug",
"autoOffsetReset": "AutoOffsetReset"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "SecurityProtocol",
"saslMechanism": "SaslMechanism",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": "google.protobuf.BoolValue",
"maxPollIntervalMs": "google.protobuf.Int64Value",
"sessionTimeoutMs": "google.protobuf.Int64Value",
"debug": "Debug",
"autoOffsetReset": "AutoOffsetReset"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string",
"vhost": "string"
},
"maxConnections": "google.protobuf.Int64Value",
"maxConcurrentQueries": "google.protobuf.Int64Value",
"keepAliveTimeout": "google.protobuf.Int64Value",
"uncompressedCacheSize": "google.protobuf.Int64Value",
"markCacheSize": "google.protobuf.Int64Value",
"maxTableSizeToDrop": "google.protobuf.Int64Value",
"maxPartitionSizeToDrop": "google.protobuf.Int64Value",
"builtinDictionariesReloadInterval": "google.protobuf.Int64Value",
"timezone": "string",
"geobaseEnabled": "google.protobuf.BoolValue",
"geobaseUri": "string",
"queryLogRetentionSize": "google.protobuf.Int64Value",
"queryLogRetentionTime": "google.protobuf.Int64Value",
"queryThreadLogEnabled": "google.protobuf.BoolValue",
"queryThreadLogRetentionSize": "google.protobuf.Int64Value",
"queryThreadLogRetentionTime": "google.protobuf.Int64Value",
"partLogRetentionSize": "google.protobuf.Int64Value",
"partLogRetentionTime": "google.protobuf.Int64Value",
"metricLogEnabled": "google.protobuf.BoolValue",
"metricLogRetentionSize": "google.protobuf.Int64Value",
"metricLogRetentionTime": "google.protobuf.Int64Value",
"traceLogEnabled": "google.protobuf.BoolValue",
"traceLogRetentionSize": "google.protobuf.Int64Value",
"traceLogRetentionTime": "google.protobuf.Int64Value",
"textLogEnabled": "google.protobuf.BoolValue",
"textLogRetentionSize": "google.protobuf.Int64Value",
"textLogRetentionTime": "google.protobuf.Int64Value",
"textLogLevel": "LogLevel",
"opentelemetrySpanLogEnabled": "google.protobuf.BoolValue",
"opentelemetrySpanLogRetentionSize": "google.protobuf.Int64Value",
"opentelemetrySpanLogRetentionTime": "google.protobuf.Int64Value",
"queryViewsLogEnabled": "google.protobuf.BoolValue",
"queryViewsLogRetentionSize": "google.protobuf.Int64Value",
"queryViewsLogRetentionTime": "google.protobuf.Int64Value",
"asynchronousMetricLogEnabled": "google.protobuf.BoolValue",
"asynchronousMetricLogRetentionSize": "google.protobuf.Int64Value",
"asynchronousMetricLogRetentionTime": "google.protobuf.Int64Value",
"sessionLogEnabled": "google.protobuf.BoolValue",
"sessionLogRetentionSize": "google.protobuf.Int64Value",
"sessionLogRetentionTime": "google.protobuf.Int64Value",
"zookeeperLogEnabled": "google.protobuf.BoolValue",
"zookeeperLogRetentionSize": "google.protobuf.Int64Value",
"zookeeperLogRetentionTime": "google.protobuf.Int64Value",
"asynchronousInsertLogEnabled": "google.protobuf.BoolValue",
"asynchronousInsertLogRetentionSize": "google.protobuf.Int64Value",
"asynchronousInsertLogRetentionTime": "google.protobuf.Int64Value",
"backgroundPoolSize": "google.protobuf.Int64Value",
"backgroundMergesMutationsConcurrencyRatio": "google.protobuf.Int64Value",
"backgroundSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundFetchesPoolSize": "google.protobuf.Int64Value",
"backgroundMovePoolSize": "google.protobuf.Int64Value",
"backgroundDistributedSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundBufferFlushSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundMessageBrokerSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundCommonPoolSize": "google.protobuf.Int64Value",
"defaultDatabase": "google.protobuf.StringValue",
"totalMemoryProfilerStep": "google.protobuf.Int64Value",
"totalMemoryTrackerSampleProbability": "google.protobuf.DoubleValue",
"queryMaskingRules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionariesLazyLoad": "google.protobuf.BoolValue",
"queryCache": {
"maxSizeInBytes": "google.protobuf.Int64Value",
"maxEntries": "google.protobuf.Int64Value",
"maxEntrySizeInBytes": "google.protobuf.Int64Value",
"maxEntrySizeInRows": "google.protobuf.Int64Value"
}
},
"userConfig": {
"logLevel": "LogLevel",
"mergeTree": {
"replicatedDeduplicationWindow": "google.protobuf.Int64Value",
"replicatedDeduplicationWindowSeconds": "google.protobuf.Int64Value",
"partsToDelayInsert": "google.protobuf.Int64Value",
"partsToThrowInsert": "google.protobuf.Int64Value",
"inactivePartsToDelayInsert": "google.protobuf.Int64Value",
"inactivePartsToThrowInsert": "google.protobuf.Int64Value",
"maxReplicatedMergesInQueue": "google.protobuf.Int64Value",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "google.protobuf.Int64Value",
"maxBytesToMergeAtMinSpaceInPool": "google.protobuf.Int64Value",
"maxBytesToMergeAtMaxSpaceInPool": "google.protobuf.Int64Value",
"minBytesForWidePart": "google.protobuf.Int64Value",
"minRowsForWidePart": "google.protobuf.Int64Value",
"ttlOnlyDropParts": "google.protobuf.BoolValue",
"allowRemoteFsZeroCopyReplication": "google.protobuf.BoolValue",
"mergeWithTtlTimeout": "google.protobuf.Int64Value",
"mergeWithRecompressionTtlTimeout": "google.protobuf.Int64Value",
"maxPartsInTotal": "google.protobuf.Int64Value",
"maxNumberOfMergesWithTtlInPool": "google.protobuf.Int64Value",
"cleanupDelayPeriod": "google.protobuf.Int64Value",
"numberOfFreeEntriesInPoolToExecuteMutation": "google.protobuf.Int64Value",
"maxAvgPartSizeForTooManyParts": "google.protobuf.Int64Value",
"minAgeToForceMergeSeconds": "google.protobuf.Int64Value",
"minAgeToForceMergeOnPartitionOnly": "google.protobuf.BoolValue",
"mergeSelectingSleepMs": "google.protobuf.Int64Value",
"mergeMaxBlockSize": "google.protobuf.Int64Value",
"checkSampleColumnIsCorrect": "google.protobuf.BoolValue",
"maxMergeSelectingSleepMs": "google.protobuf.Int64Value",
"maxCleanupDelayPeriod": "google.protobuf.Int64Value"
},
"compression": [
{
"method": "Method",
"minPartSize": "int64",
"minPartSizeRatio": "double",
"level": "google.protobuf.Int64Value"
}
],
"dictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"layout": {
"type": "Type",
"sizeInCells": "int64",
"maxArraySize": "int64"
},
// Includes only one of the fields `fixedLifetime`, `lifetimeRange`
"fixedLifetime": "int64",
"lifetimeRange": {
"min": "int64",
"max": "int64"
},
// end of the list of possible fields
// Includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"httpSource": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "int64",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "int64",
"port": "int64",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string",
"closeConnection": "google.protobuf.BoolValue",
"shareConnection": "google.protobuf.BoolValue"
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"where": "string",
"secure": "google.protobuf.BoolValue"
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "int64",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "SslMode"
}
// end of the list of possible fields
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "int64",
"precision": "int64"
}
]
}
],
"pathColumnName": "string",
"timeColumnName": "string",
"valueColumnName": "string",
"versionColumnName": "string"
}
],
"kafka": {
"securityProtocol": "SecurityProtocol",
"saslMechanism": "SaslMechanism",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": "google.protobuf.BoolValue",
"maxPollIntervalMs": "google.protobuf.Int64Value",
"sessionTimeoutMs": "google.protobuf.Int64Value",
"debug": "Debug",
"autoOffsetReset": "AutoOffsetReset"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "SecurityProtocol",
"saslMechanism": "SaslMechanism",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": "google.protobuf.BoolValue",
"maxPollIntervalMs": "google.protobuf.Int64Value",
"sessionTimeoutMs": "google.protobuf.Int64Value",
"debug": "Debug",
"autoOffsetReset": "AutoOffsetReset"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string",
"vhost": "string"
},
"maxConnections": "google.protobuf.Int64Value",
"maxConcurrentQueries": "google.protobuf.Int64Value",
"keepAliveTimeout": "google.protobuf.Int64Value",
"uncompressedCacheSize": "google.protobuf.Int64Value",
"markCacheSize": "google.protobuf.Int64Value",
"maxTableSizeToDrop": "google.protobuf.Int64Value",
"maxPartitionSizeToDrop": "google.protobuf.Int64Value",
"builtinDictionariesReloadInterval": "google.protobuf.Int64Value",
"timezone": "string",
"geobaseEnabled": "google.protobuf.BoolValue",
"geobaseUri": "string",
"queryLogRetentionSize": "google.protobuf.Int64Value",
"queryLogRetentionTime": "google.protobuf.Int64Value",
"queryThreadLogEnabled": "google.protobuf.BoolValue",
"queryThreadLogRetentionSize": "google.protobuf.Int64Value",
"queryThreadLogRetentionTime": "google.protobuf.Int64Value",
"partLogRetentionSize": "google.protobuf.Int64Value",
"partLogRetentionTime": "google.protobuf.Int64Value",
"metricLogEnabled": "google.protobuf.BoolValue",
"metricLogRetentionSize": "google.protobuf.Int64Value",
"metricLogRetentionTime": "google.protobuf.Int64Value",
"traceLogEnabled": "google.protobuf.BoolValue",
"traceLogRetentionSize": "google.protobuf.Int64Value",
"traceLogRetentionTime": "google.protobuf.Int64Value",
"textLogEnabled": "google.protobuf.BoolValue",
"textLogRetentionSize": "google.protobuf.Int64Value",
"textLogRetentionTime": "google.protobuf.Int64Value",
"textLogLevel": "LogLevel",
"opentelemetrySpanLogEnabled": "google.protobuf.BoolValue",
"opentelemetrySpanLogRetentionSize": "google.protobuf.Int64Value",
"opentelemetrySpanLogRetentionTime": "google.protobuf.Int64Value",
"queryViewsLogEnabled": "google.protobuf.BoolValue",
"queryViewsLogRetentionSize": "google.protobuf.Int64Value",
"queryViewsLogRetentionTime": "google.protobuf.Int64Value",
"asynchronousMetricLogEnabled": "google.protobuf.BoolValue",
"asynchronousMetricLogRetentionSize": "google.protobuf.Int64Value",
"asynchronousMetricLogRetentionTime": "google.protobuf.Int64Value",
"sessionLogEnabled": "google.protobuf.BoolValue",
"sessionLogRetentionSize": "google.protobuf.Int64Value",
"sessionLogRetentionTime": "google.protobuf.Int64Value",
"zookeeperLogEnabled": "google.protobuf.BoolValue",
"zookeeperLogRetentionSize": "google.protobuf.Int64Value",
"zookeeperLogRetentionTime": "google.protobuf.Int64Value",
"asynchronousInsertLogEnabled": "google.protobuf.BoolValue",
"asynchronousInsertLogRetentionSize": "google.protobuf.Int64Value",
"asynchronousInsertLogRetentionTime": "google.protobuf.Int64Value",
"backgroundPoolSize": "google.protobuf.Int64Value",
"backgroundMergesMutationsConcurrencyRatio": "google.protobuf.Int64Value",
"backgroundSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundFetchesPoolSize": "google.protobuf.Int64Value",
"backgroundMovePoolSize": "google.protobuf.Int64Value",
"backgroundDistributedSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundBufferFlushSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundMessageBrokerSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundCommonPoolSize": "google.protobuf.Int64Value",
"defaultDatabase": "google.protobuf.StringValue",
"totalMemoryProfilerStep": "google.protobuf.Int64Value",
"totalMemoryTrackerSampleProbability": "google.protobuf.DoubleValue",
"queryMaskingRules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionariesLazyLoad": "google.protobuf.BoolValue",
"queryCache": {
"maxSizeInBytes": "google.protobuf.Int64Value",
"maxEntries": "google.protobuf.Int64Value",
"maxEntrySizeInBytes": "google.protobuf.Int64Value",
"maxEntrySizeInRows": "google.protobuf.Int64Value"
}
},
"defaultConfig": {
"logLevel": "LogLevel",
"mergeTree": {
"replicatedDeduplicationWindow": "google.protobuf.Int64Value",
"replicatedDeduplicationWindowSeconds": "google.protobuf.Int64Value",
"partsToDelayInsert": "google.protobuf.Int64Value",
"partsToThrowInsert": "google.protobuf.Int64Value",
"inactivePartsToDelayInsert": "google.protobuf.Int64Value",
"inactivePartsToThrowInsert": "google.protobuf.Int64Value",
"maxReplicatedMergesInQueue": "google.protobuf.Int64Value",
"numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "google.protobuf.Int64Value",
"maxBytesToMergeAtMinSpaceInPool": "google.protobuf.Int64Value",
"maxBytesToMergeAtMaxSpaceInPool": "google.protobuf.Int64Value",
"minBytesForWidePart": "google.protobuf.Int64Value",
"minRowsForWidePart": "google.protobuf.Int64Value",
"ttlOnlyDropParts": "google.protobuf.BoolValue",
"allowRemoteFsZeroCopyReplication": "google.protobuf.BoolValue",
"mergeWithTtlTimeout": "google.protobuf.Int64Value",
"mergeWithRecompressionTtlTimeout": "google.protobuf.Int64Value",
"maxPartsInTotal": "google.protobuf.Int64Value",
"maxNumberOfMergesWithTtlInPool": "google.protobuf.Int64Value",
"cleanupDelayPeriod": "google.protobuf.Int64Value",
"numberOfFreeEntriesInPoolToExecuteMutation": "google.protobuf.Int64Value",
"maxAvgPartSizeForTooManyParts": "google.protobuf.Int64Value",
"minAgeToForceMergeSeconds": "google.protobuf.Int64Value",
"minAgeToForceMergeOnPartitionOnly": "google.protobuf.BoolValue",
"mergeSelectingSleepMs": "google.protobuf.Int64Value",
"mergeMaxBlockSize": "google.protobuf.Int64Value",
"checkSampleColumnIsCorrect": "google.protobuf.BoolValue",
"maxMergeSelectingSleepMs": "google.protobuf.Int64Value",
"maxCleanupDelayPeriod": "google.protobuf.Int64Value"
},
"compression": [
{
"method": "Method",
"minPartSize": "int64",
"minPartSizeRatio": "double",
"level": "google.protobuf.Int64Value"
}
],
"dictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"rangeMin": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"rangeMax": {
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"attributes": [
{
"name": "string",
"type": "string",
"nullValue": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"layout": {
"type": "Type",
"sizeInCells": "int64",
"maxArraySize": "int64"
},
// Includes only one of the fields `fixedLifetime`, `lifetimeRange`
"fixedLifetime": "int64",
"lifetimeRange": {
"min": "int64",
"max": "int64"
},
// end of the list of possible fields
// Includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
"httpSource": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysqlSource": {
"db": "string",
"table": "string",
"port": "int64",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "int64",
"port": "int64",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidateQuery": "string",
"closeConnection": "google.protobuf.BoolValue",
"shareConnection": "google.protobuf.BoolValue"
},
"clickhouseSource": {
"db": "string",
"table": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"where": "string",
"secure": "google.protobuf.BoolValue"
},
"mongodbSource": {
"db": "string",
"collection": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"options": "string"
},
"postgresqlSource": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "int64",
"user": "string",
"password": "string",
"invalidateQuery": "string",
"sslMode": "SslMode"
}
// end of the list of possible fields
}
],
"graphiteRollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "int64",
"precision": "int64"
}
]
}
],
"pathColumnName": "string",
"timeColumnName": "string",
"valueColumnName": "string",
"versionColumnName": "string"
}
],
"kafka": {
"securityProtocol": "SecurityProtocol",
"saslMechanism": "SaslMechanism",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": "google.protobuf.BoolValue",
"maxPollIntervalMs": "google.protobuf.Int64Value",
"sessionTimeoutMs": "google.protobuf.Int64Value",
"debug": "Debug",
"autoOffsetReset": "AutoOffsetReset"
},
"kafkaTopics": [
{
"name": "string",
"settings": {
"securityProtocol": "SecurityProtocol",
"saslMechanism": "SaslMechanism",
"saslUsername": "string",
"saslPassword": "string",
"enableSslCertificateVerification": "google.protobuf.BoolValue",
"maxPollIntervalMs": "google.protobuf.Int64Value",
"sessionTimeoutMs": "google.protobuf.Int64Value",
"debug": "Debug",
"autoOffsetReset": "AutoOffsetReset"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string",
"vhost": "string"
},
"maxConnections": "google.protobuf.Int64Value",
"maxConcurrentQueries": "google.protobuf.Int64Value",
"keepAliveTimeout": "google.protobuf.Int64Value",
"uncompressedCacheSize": "google.protobuf.Int64Value",
"markCacheSize": "google.protobuf.Int64Value",
"maxTableSizeToDrop": "google.protobuf.Int64Value",
"maxPartitionSizeToDrop": "google.protobuf.Int64Value",
"builtinDictionariesReloadInterval": "google.protobuf.Int64Value",
"timezone": "string",
"geobaseEnabled": "google.protobuf.BoolValue",
"geobaseUri": "string",
"queryLogRetentionSize": "google.protobuf.Int64Value",
"queryLogRetentionTime": "google.protobuf.Int64Value",
"queryThreadLogEnabled": "google.protobuf.BoolValue",
"queryThreadLogRetentionSize": "google.protobuf.Int64Value",
"queryThreadLogRetentionTime": "google.protobuf.Int64Value",
"partLogRetentionSize": "google.protobuf.Int64Value",
"partLogRetentionTime": "google.protobuf.Int64Value",
"metricLogEnabled": "google.protobuf.BoolValue",
"metricLogRetentionSize": "google.protobuf.Int64Value",
"metricLogRetentionTime": "google.protobuf.Int64Value",
"traceLogEnabled": "google.protobuf.BoolValue",
"traceLogRetentionSize": "google.protobuf.Int64Value",
"traceLogRetentionTime": "google.protobuf.Int64Value",
"textLogEnabled": "google.protobuf.BoolValue",
"textLogRetentionSize": "google.protobuf.Int64Value",
"textLogRetentionTime": "google.protobuf.Int64Value",
"textLogLevel": "LogLevel",
"opentelemetrySpanLogEnabled": "google.protobuf.BoolValue",
"opentelemetrySpanLogRetentionSize": "google.protobuf.Int64Value",
"opentelemetrySpanLogRetentionTime": "google.protobuf.Int64Value",
"queryViewsLogEnabled": "google.protobuf.BoolValue",
"queryViewsLogRetentionSize": "google.protobuf.Int64Value",
"queryViewsLogRetentionTime": "google.protobuf.Int64Value",
"asynchronousMetricLogEnabled": "google.protobuf.BoolValue",
"asynchronousMetricLogRetentionSize": "google.protobuf.Int64Value",
"asynchronousMetricLogRetentionTime": "google.protobuf.Int64Value",
"sessionLogEnabled": "google.protobuf.BoolValue",
"sessionLogRetentionSize": "google.protobuf.Int64Value",
"sessionLogRetentionTime": "google.protobuf.Int64Value",
"zookeeperLogEnabled": "google.protobuf.BoolValue",
"zookeeperLogRetentionSize": "google.protobuf.Int64Value",
"zookeeperLogRetentionTime": "google.protobuf.Int64Value",
"asynchronousInsertLogEnabled": "google.protobuf.BoolValue",
"asynchronousInsertLogRetentionSize": "google.protobuf.Int64Value",
"asynchronousInsertLogRetentionTime": "google.protobuf.Int64Value",
"backgroundPoolSize": "google.protobuf.Int64Value",
"backgroundMergesMutationsConcurrencyRatio": "google.protobuf.Int64Value",
"backgroundSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundFetchesPoolSize": "google.protobuf.Int64Value",
"backgroundMovePoolSize": "google.protobuf.Int64Value",
"backgroundDistributedSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundBufferFlushSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundMessageBrokerSchedulePoolSize": "google.protobuf.Int64Value",
"backgroundCommonPoolSize": "google.protobuf.Int64Value",
"defaultDatabase": "google.protobuf.StringValue",
"totalMemoryProfilerStep": "google.protobuf.Int64Value",
"totalMemoryTrackerSampleProbability": "google.protobuf.DoubleValue",
"queryMaskingRules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionariesLazyLoad": "google.protobuf.BoolValue",
"queryCache": {
"maxSizeInBytes": "google.protobuf.Int64Value",
"maxEntries": "google.protobuf.Int64Value",
"maxEntrySizeInBytes": "google.protobuf.Int64Value",
"maxEntrySizeInRows": "google.protobuf.Int64Value"
}
}
},
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"zookeeper": {
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"backupWindowStart": "google.type.TimeOfDay",
"access": {
"dataLens": "bool",
"webSql": "bool",
"metrika": "bool",
"serverless": "bool",
"dataTransfer": "bool",
"yandexQuery": "bool"
},
"cloudStorage": {
"enabled": "bool",
"moveFactor": "google.protobuf.DoubleValue",
"dataCacheEnabled": "google.protobuf.BoolValue",
"dataCacheMaxSize": "google.protobuf.Int64Value",
"preferNotToMerge": "google.protobuf.BoolValue"
},
"sqlDatabaseManagement": "google.protobuf.BoolValue",
"sqlUserManagement": "google.protobuf.BoolValue",
"embeddedKeeper": "google.protobuf.BoolValue",
"backupRetainPeriodDays": "google.protobuf.Int64Value"
},
"networkId": "string",
"health": "Health",
"status": "Status",
"serviceAccountId": "string",
"maintenanceWindow": {
// Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": "AnytimeMaintenanceWindow",
"weeklyMaintenanceWindow": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"plannedOperation": {
"info": "string",
"delayedUntil": "google.protobuf.Timestamp"
},
"securityGroupIds": [
"string"
],
"deletionProtection": "bool"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
createdAt |
Creation timestamp. |
|
createdBy |
string ID of the user or service account who initiated the operation. |
|
modifiedAt |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
BackupClusterMetadata
|
Field |
Description |
|
clusterId |
string ID of the ClickHouse cluster that is being backed up. |
Cluster
A ClickHouse Cluster resource. For more information, see the
Cluster section in the Developer's Guide.
|
Field |
Description |
|
id |
string ID of the ClickHouse cluster. |
|
folderId |
string ID of the folder that the ClickHouse cluster belongs to. |
|
createdAt |
Creation timestamp in RFC3339 text format. |
|
name |
string Name of the ClickHouse cluster. |
|
description |
string Description of the ClickHouse cluster. 0-256 characters long. |
|
labels |
string Custom labels for the ClickHouse cluster as |
|
environment |
enum Environment Deployment environment of the ClickHouse cluster.
|
|
monitoring[] |
Description of monitoring systems relevant to the ClickHouse cluster. |
|
config |
Configuration of the ClickHouse cluster. |
|
networkId |
string ID of the network that the cluster belongs to. |
|
health |
enum Health Aggregated cluster health.
|
|
status |
enum Status Current state of the cluster.
|
|
serviceAccountId |
string ID of the service account used for access to Object Storage. |
|
maintenanceWindow |
Maintenance window for the cluster. |
|
plannedOperation |
Planned maintenance operation to be started for the cluster within the nearest |
|
securityGroupIds[] |
string User security groups |
|
deletionProtection |
bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Monitoring system metadata.
|
Field |
Description |
|
name |
string Name of the monitoring system. |
|
description |
string Description of the monitoring system. |
|
link |
string Link to the monitoring system charts for the ClickHouse cluster. |
ClusterConfig
|
Field |
Description |
|
version |
string Version of the ClickHouse server software. |
|
clickhouse |
Configuration and resource allocation for ClickHouse hosts. |
|
zookeeper |
Configuration and resource allocation for ZooKeeper hosts. |
|
backupWindowStart |
Time to start the daily backup, in the UTC timezone. |
|
access |
Access policy for external services. |
|
cloudStorage |
|
|
sqlDatabaseManagement |
Whether database management through SQL commands is enabled. |
|
sqlUserManagement |
Whether user management through SQL commands is enabled. |
|
embeddedKeeper |
Whether cluster should use embedded Keeper instead of Zookeeper. |
|
backupRetainPeriodDays |
Retain period of automatically created backup in days |
Clickhouse
|
Field |
Description |
|
config |
Configuration settings of a ClickHouse server. |
|
resources |
Resources allocated to ClickHouse hosts. |
ClickhouseConfigSet
|
Field |
Description |
|
effectiveConfig |
Required field. Effective settings for a ClickHouse cluster (a combination of settings defined |
|
userConfig |
User-defined settings for a ClickHouse cluster. |
|
defaultConfig |
Default configuration for a ClickHouse cluster. |
ClickhouseConfig
ClickHouse configuration options. Detailed description for each set of options
is available in ClickHouse documentation.
Any options not listed here are not supported.
|
Field |
Description |
|
logLevel |
enum LogLevel Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
|
|
mergeTree |
Settings for the MergeTree engine. |
|
compression[] |
Compression settings for the ClickHouse cluster. |
|
dictionaries[] |
Configuration of external dictionaries to be used by the ClickHouse cluster. |
|
graphiteRollup[] |
Settings for thinning Graphite data. |
|
kafka |
|
|
kafkaTopics[] |
|
|
rabbitmq |
|
|
maxConnections |
Maximum number of inbound connections. |
|
maxConcurrentQueries |
Maximum number of simultaneously processed requests. |
|
keepAliveTimeout |
Number of milliseconds that ClickHouse waits for incoming requests before closing the connection. |
|
uncompressedCacheSize |
Cache size (in bytes) for uncompressed data used by MergeTree tables. |
|
markCacheSize |
Approximate size (in bytes) of the cache of "marks" used by MergeTree tables. |
|
maxTableSizeToDrop |
Maximum size of the table that can be deleted using a DROP query. |
|
maxPartitionSizeToDrop |
Maximum size of the partition that can be deleted using a DROP query. |
|
builtinDictionariesReloadInterval |
The setting is deprecated and has no effect. |
|
timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
|
geobaseEnabled |
Enable or disable geobase. |
|
geobaseUri |
string Address of the archive with the user geobase in Object Storage. |
|
queryLogRetentionSize |
The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
queryLogRetentionTime |
The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of |
|
queryThreadLogEnabled |
Whether query_thread_log system table is enabled. |
|
queryThreadLogRetentionSize |
The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
queryThreadLogRetentionTime |
The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of |
|
partLogRetentionSize |
The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
partLogRetentionTime |
The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of |
|
metricLogEnabled |
Whether metric_log system table is enabled. |
|
metricLogRetentionSize |
The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
metricLogRetentionTime |
The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of |
|
traceLogEnabled |
Whether trace_log system table is enabled. |
|
traceLogRetentionSize |
The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
traceLogRetentionTime |
The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of |
|
textLogEnabled |
Whether text_log system table is enabled. |
|
textLogRetentionSize |
The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
textLogRetentionTime |
The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of |
|
textLogLevel |
enum LogLevel Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
|
|
opentelemetrySpanLogEnabled |
Enable or disable opentelemetry_span_log system table. Default value: false. |
|
opentelemetrySpanLogRetentionSize |
The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0 (default), |
|
opentelemetrySpanLogRetentionTime |
The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, |
|
queryViewsLogEnabled |
Enable or disable query_views_log system table. Default value: false. |
|
queryViewsLogRetentionSize |
The maximum size that query_views_log can grow to before old data will be removed. If set to 0 (default), |
|
queryViewsLogRetentionTime |
The maximum time that query_views_log records will be retained before removal. If set to 0, |
|
asynchronousMetricLogEnabled |
Enable or disable asynchronous_metric_log system table. Default value: false. |
|
asynchronousMetricLogRetentionSize |
The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0 (default), |
|
asynchronousMetricLogRetentionTime |
The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, |
|
sessionLogEnabled |
Enable or disable session_log system table. Default value: false. |
|
sessionLogRetentionSize |
The maximum size that session_log can grow to before old data will be removed. If set to 0 (default), |
|
sessionLogRetentionTime |
The maximum time that session_log records will be retained before removal. If set to 0, |
|
zookeeperLogEnabled |
Enable or disable zookeeper_log system table. Default value: false. |
|
zookeeperLogRetentionSize |
The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0 (default), |
|
zookeeperLogRetentionTime |
The maximum time that zookeeper_log records will be retained before removal. If set to 0, |
|
asynchronousInsertLogEnabled |
Enable or disable asynchronous_insert_log system table. Default value: false. |
|
asynchronousInsertLogRetentionSize |
The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0 (default), |
|
asynchronousInsertLogRetentionTime |
The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, |
|
backgroundPoolSize |
|
|
backgroundMergesMutationsConcurrencyRatio |
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. |
|
backgroundSchedulePoolSize |
|
|
backgroundFetchesPoolSize |
Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8. More info see in ClickHouse documentation. |
|
backgroundMovePoolSize |
|
|
backgroundDistributedSchedulePoolSize |
|
|
backgroundBufferFlushSchedulePoolSize |
|
|
backgroundMessageBrokerSchedulePoolSize |
|
|
backgroundCommonPoolSize |
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. |
|
defaultDatabase |
The default database. To get a list of cluster databases, see Yandex Managed ClickHouse documentation. |
|
totalMemoryProfilerStep |
Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304. More info see in ClickHouse documentation. |
|
totalMemoryTrackerSampleProbability |
|
|
queryMaskingRules[] |
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. |
|
dictionariesLazyLoad |
Lazy loading of dictionaries. |
|
queryCache |
Query cache configuration. |
MergeTree
Options specific to the MergeTree table engine.
|
Field |
Description |
|
replicatedDeduplicationWindow |
Number of blocks of hashes to keep in ZooKeeper. |
|
replicatedDeduplicationWindowSeconds |
Period of time to keep blocks of hashes for. |
|
partsToDelayInsert |
If table contains at least that many active parts in single partition, artificially slow down insert into table. |
|
partsToThrowInsert |
If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
|
inactivePartsToDelayInsert |
|
|
inactivePartsToThrowInsert |
|
|
maxReplicatedMergesInQueue |
How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
|
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge |
If there is less than specified number of free entries in background pool (or replicated queue), start to lower |
|
maxBytesToMergeAtMinSpaceInPool |
Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries |
|
maxBytesToMergeAtMaxSpaceInPool |
|
|
minBytesForWidePart |
Minimum number of bytes in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
|
minRowsForWidePart |
Minimum number of rows in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
|
ttlOnlyDropParts |
Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables. More info see in ClickHouse documentation. |
|
allowRemoteFsZeroCopyReplication |
|
|
mergeWithTtlTimeout |
|
|
mergeWithRecompressionTtlTimeout |
|
|
maxPartsInTotal |
|
|
maxNumberOfMergesWithTtlInPool |
|
|
cleanupDelayPeriod |
|
|
numberOfFreeEntriesInPoolToExecuteMutation |
|
|
maxAvgPartSizeForTooManyParts |
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. |
|
minAgeToForceMergeSeconds |
Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds. |
|
minAgeToForceMergeOnPartitionOnly |
Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. |
|
mergeSelectingSleepMs |
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. |
|
mergeMaxBlockSize |
The number of rows that are read from the merged parts into memory. |
|
checkSampleColumnIsCorrect |
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. |
|
maxMergeSelectingSleepMs |
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. |
|
maxCleanupDelayPeriod |
Maximum period to clean old queue logs, blocks hashes and parts. |
Compression
|
Field |
Description |
|
method |
enum Method Compression method to use for the specified combination of
|
|
minPartSize |
int64 Minimum size of a part of a table. |
|
minPartSizeRatio |
double Minimum ratio of a part relative to the size of all the data in the table. |
|
level |
ExternalDictionary
|
Field |
Description |
|
name |
string Required field. Name of the external dictionary. |
|
structure |
Required field. Set of attributes for the external dictionary. |
|
layout |
Required field. Layout for storing the dictionary in memory. |
|
fixedLifetime |
int64 Fixed interval between dictionary updates. Includes only one of the fields Setting for the period of time between dictionary updates. |
|
lifetimeRange |
Range of intervals between dictionary updates for ClickHouse to choose from. Includes only one of the fields Setting for the period of time between dictionary updates. |
|
httpSource |
HTTP source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
mysqlSource |
MySQL source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
clickhouseSource |
ClickHouse source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
mongodbSource |
MongoDB source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
postgresqlSource |
PostgreSQL source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
Structure
|
Field |
Description |
|
id |
Single numeric key column for the dictionary. |
|
key |
Composite key for the dictionary, containing of one or more key columns. |
|
rangeMin |
Field holding the beginning of the range for dictionaries with |
|
rangeMax |
Field holding the end of the range for dictionaries with |
|
attributes[] |
Description of the fields available for database queries. |
Id
Numeric key.
|
Field |
Description |
|
name |
string Required field. Name of the numeric key. |
Key
Complex key.
|
Field |
Description |
|
attributes[] |
Attributes of a complex key. |
Attribute
|
Field |
Description |
|
name |
string Required field. Name of the column. |
|
type |
string Required field. Type of the column. |
|
nullValue |
string Default value for an element without data (for example, an empty string). |
|
expression |
string Expression, describing the attribute, if applicable. |
|
hierarchical |
bool Indication of hierarchy support. |
|
injective |
bool Indication of injective mapping "id -> attribute". |
Layout
Layout determining how to store the dictionary in memory.
|
Field |
Description |
|
type |
enum Type Required field. Layout type for an external dictionary.
|
|
sizeInCells |
int64 Number of cells in the cache. Rounded up to a power of two. |
|
maxArraySize |
int64 Maximum dictionary key size. |
Range
|
Field |
Description |
|
min |
int64 Minimum dictionary lifetime. |
|
max |
int64 Maximum dictionary lifetime. |
HttpSource
|
Field |
Description |
|
url |
string Required field. URL of the source dictionary available over HTTP. |
|
format |
string Required field. The data format. Valid values are all formats supported by ClickHouse SQL dialect. |
|
headers[] |
HTTP headers. |
Header
|
Field |
Description |
|
name |
string Required field. |
|
value |
string Required field. |
MysqlSource
|
Field |
Description |
|
db |
string Required field. Name of the MySQL database to connect to. |
|
table |
string Required field. Name of the database table to use as a ClickHouse dictionary. |
|
port |
int64 Default port to use when connecting to a replica of the dictionary source. |
|
user |
string Name of the default user for replicas of the dictionary source. |
|
password |
string Password of the default user for replicas of the dictionary source. |
|
replicas[] |
List of MySQL replicas of the database used as dictionary source. |
|
where |
string Selection criteria for the data in the specified MySQL table. |
|
invalidateQuery |
string Query for checking the dictionary status, to pull only updated data. |
|
closeConnection |
Should the connection be closed after each request. |
|
shareConnection |
Should a connection be shared for some requests. |
Replica
|
Field |
Description |
|
host |
string Required field. MySQL host of the replica. |
|
priority |
int64 Required field. The priority of the replica that ClickHouse takes into account when connecting. |
|
port |
int64 Port to use when connecting to the replica. |
|
user |
string Name of the MySQL database user. |
|
password |
string Password of the MySQL database user. |
ClickhouseSource
|
Field |
Description |
|
db |
string Required field. Name of the ClickHouse database. |
|
table |
string Required field. Name of the table in the specified database to be used as the dictionary source. |
|
host |
string ClickHouse host of the specified database. |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the ClickHouse database user. |
|
password |
string Password of the ClickHouse database user. |
|
where |
string Selection criteria for the data in the specified ClickHouse table. |
|
secure |
Use ssl for connection. |
MongodbSource
|
Field |
Description |
|
db |
string Required field. Name of the MongoDB database. |
|
collection |
string Required field. Name of the collection in the specified database to be used as the dictionary source. |
|
host |
string MongoDB host of the specified database. |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the MongoDB database user. |
|
password |
string Password of the MongoDB database user. |
|
options |
string |
PostgresqlSource
|
Field |
Description |
|
db |
string Required field. Name of the PostrgreSQL database. |
|
table |
string Required field. Name of the table in the specified database to be used as the dictionary source. |
|
hosts[] |
string Name of the PostrgreSQL host |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the PostrgreSQL database user. |
|
password |
string Password of the PostrgreSQL database user. |
|
invalidateQuery |
string Query for checking the dictionary status, to pull only updated data. |
|
sslMode |
enum SslMode Mode of SSL TCP/IP connection to the PostgreSQL host.
|
GraphiteRollup
Rollup settings for the GraphiteMergeTree table engine.
|
Field |
Description |
|
name |
string Required field. Name for the specified combination of settings for Graphite rollup. |
|
patterns[] |
Pattern to use for the rollup. |
|
pathColumnName |
string The name of the column storing the metric name (Graphite sensor). |
|
timeColumnName |
string The name of the column storing the time of measuring the metric. |
|
valueColumnName |
string The name of the column storing the value of the metric at the time set in time_column_name. |
|
versionColumnName |
string The name of the column storing the version of the metric. |
Pattern
|
Field |
Description |
|
regexp |
string Pattern for metric names. |
|
function |
string Required field. Name of the aggregating function to apply to data of the age specified in |
|
retention[] |
Age of data to use for thinning. |
Retention
|
Field |
Description |
|
age |
int64 Minimum age of the data in seconds. |
|
precision |
int64 Precision of determining the age of the data, in seconds. |
Kafka
|
Field |
Description |
|
securityProtocol |
enum SecurityProtocol
|
|
saslMechanism |
enum SaslMechanism
|
|
saslUsername |
string |
|
saslPassword |
string |
|
enableSslCertificateVerification |
|
|
maxPollIntervalMs |
|
|
sessionTimeoutMs |
|
|
debug |
enum Debug
|
|
autoOffsetReset |
enum AutoOffsetReset
|
KafkaTopic
|
Field |
Description |
|
name |
string Required field. |
|
settings |
Required field. |
Rabbitmq
|
Field |
Description |
|
username |
string RabbitMQ username |
|
password |
string RabbitMQ password |
|
vhost |
string RabbitMQ virtual host |
QueryMaskingRule
|
Field |
Description |
|
name |
string Name for the rule. |
|
regexp |
string Required field. RE2 compatible regular expression. |
|
replace |
string Substitution string for sensitive data. |
QueryCache
|
Field |
Description |
|
maxSizeInBytes |
The maximum cache size in bytes. |
|
maxEntries |
The maximum number of SELECT query results stored in the cache. |
|
maxEntrySizeInBytes |
The maximum size in bytes SELECT query results may have to be saved in the cache. |
|
maxEntrySizeInRows |
The maximum number of rows SELECT query results may have to be saved in the cache. |
Resources
|
Field |
Description |
|
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
|
diskSize |
int64 Volume of the storage available to a host, in bytes. |
|
diskTypeId |
string Type of the storage environment for the host.
|
Zookeeper
|
Field |
Description |
|
resources |
Resources allocated to ZooKeeper hosts. |
Access
|
Field |
Description |
|
dataLens |
bool Allow to export data from the cluster to DataLens. |
|
webSql |
bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
|
metrika |
bool Allow to import data from Yandex Metrica and AppMetrica to the cluster. See AppMetrica documentation for more details. |
|
serverless |
bool Allow access to cluster for Serverless. |
|
dataTransfer |
bool Allow access for DataTransfer |
|
yandexQuery |
bool Allow access for Query |
CloudStorage
|
Field |
Description |
|
enabled |
bool Whether to use Object Storage for storing ClickHouse data. |
|
moveFactor |
|
|
dataCacheEnabled |
|
|
dataCacheMaxSize |
|
|
preferNotToMerge |
MaintenanceWindow
A maintenance window settings.
|
Field |
Description |
|
anytime |
Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
|
weeklyMaintenanceWindow |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
Weelky maintenance window settings.
|
Field |
Description |
|
day |
enum WeekDay Day of the week (in
|
|
hour |
int64 Hour of the day in UTC (in |
MaintenanceOperation
A planned maintenance operation.
|
Field |
Description |
|
info |
string Information about this maintenance operation. |
|
delayedUntil |
Time until which this maintenance operation is delayed. |