Managed Service for ClickHouse API, gRPC: ClusterService.AddShards
- gRPC request
- AddClusterShardsRequest
- ShardSpec
- ShardConfigSpec
- Clickhouse
- ClickhouseConfig
- AccessControlImprovements
- MergeTree
- Compression
- ExternalDictionary
- Structure
- Id
- Key
- Attribute
- Layout
- Range
- HttpSource
- Header
- MysqlSource
- Replica
- ClickhouseSource
- MongodbSource
- PostgresqlSource
- GraphiteRollup
- Pattern
- Retention
- Kafka
- KafkaTopic
- Rabbitmq
- QueryMaskingRule
- QueryCache
- JdbcBridge
- Macro
- Resources
- DiskSizeAutoscaling
- HostSpec
- operation.Operation
- AddClusterShardsMetadata
- Shards
- Shard
- ShardConfig
- Clickhouse
- ClickhouseConfigSet
- ClickhouseConfig
- AccessControlImprovements
- MergeTree
- Compression
- ExternalDictionary
- Structure
- Id
- Key
- Attribute
- Layout
- Range
- HttpSource
- Header
- MysqlSource
- Replica
- ClickhouseSource
- MongodbSource
- PostgresqlSource
- GraphiteRollup
- Pattern
- Retention
- Kafka
- KafkaTopic
- Rabbitmq
- QueryMaskingRule
- QueryCache
- JdbcBridge
- Macro
- Resources
- DiskSizeAutoscaling
Creates one or more shards in the specified cluster.
gRPC request
rpc AddShards (AddClusterShardsRequest) returns (operation.Operation)
AddClusterShardsRequest
{
"cluster_id": "string",
"shard_specs": [
{
"name": "string",
"config_spec": {
"clickhouse": {
"config": {
"background_pool_size": "google.protobuf.Int64Value",
"background_merges_mutations_concurrency_ratio": "google.protobuf.Int64Value",
"background_schedule_pool_size": "google.protobuf.Int64Value",
"background_fetches_pool_size": "google.protobuf.Int64Value",
"background_move_pool_size": "google.protobuf.Int64Value",
"background_distributed_schedule_pool_size": "google.protobuf.Int64Value",
"background_buffer_flush_schedule_pool_size": "google.protobuf.Int64Value",
"background_message_broker_schedule_pool_size": "google.protobuf.Int64Value",
"background_common_pool_size": "google.protobuf.Int64Value",
"dictionaries_lazy_load": "google.protobuf.BoolValue",
"log_level": "LogLevel",
"query_log_retention_size": "google.protobuf.Int64Value",
"query_log_retention_time": "google.protobuf.Int64Value",
"query_thread_log_enabled": "google.protobuf.BoolValue",
"query_thread_log_retention_size": "google.protobuf.Int64Value",
"query_thread_log_retention_time": "google.protobuf.Int64Value",
"part_log_retention_size": "google.protobuf.Int64Value",
"part_log_retention_time": "google.protobuf.Int64Value",
"metric_log_enabled": "google.protobuf.BoolValue",
"metric_log_retention_size": "google.protobuf.Int64Value",
"metric_log_retention_time": "google.protobuf.Int64Value",
"trace_log_enabled": "google.protobuf.BoolValue",
"trace_log_retention_size": "google.protobuf.Int64Value",
"trace_log_retention_time": "google.protobuf.Int64Value",
"text_log_enabled": "google.protobuf.BoolValue",
"text_log_retention_size": "google.protobuf.Int64Value",
"text_log_retention_time": "google.protobuf.Int64Value",
"text_log_level": "LogLevel",
"opentelemetry_span_log_enabled": "google.protobuf.BoolValue",
"opentelemetry_span_log_retention_size": "google.protobuf.Int64Value",
"opentelemetry_span_log_retention_time": "google.protobuf.Int64Value",
"query_views_log_enabled": "google.protobuf.BoolValue",
"query_views_log_retention_size": "google.protobuf.Int64Value",
"query_views_log_retention_time": "google.protobuf.Int64Value",
"asynchronous_metric_log_enabled": "google.protobuf.BoolValue",
"asynchronous_metric_log_retention_size": "google.protobuf.Int64Value",
"asynchronous_metric_log_retention_time": "google.protobuf.Int64Value",
"session_log_enabled": "google.protobuf.BoolValue",
"session_log_retention_size": "google.protobuf.Int64Value",
"session_log_retention_time": "google.protobuf.Int64Value",
"zookeeper_log_enabled": "google.protobuf.BoolValue",
"zookeeper_log_retention_size": "google.protobuf.Int64Value",
"zookeeper_log_retention_time": "google.protobuf.Int64Value",
"asynchronous_insert_log_enabled": "google.protobuf.BoolValue",
"asynchronous_insert_log_retention_size": "google.protobuf.Int64Value",
"asynchronous_insert_log_retention_time": "google.protobuf.Int64Value",
"processors_profile_log_enabled": "google.protobuf.BoolValue",
"processors_profile_log_retention_size": "google.protobuf.Int64Value",
"processors_profile_log_retention_time": "google.protobuf.Int64Value",
"error_log_enabled": "google.protobuf.BoolValue",
"error_log_retention_size": "google.protobuf.Int64Value",
"error_log_retention_time": "google.protobuf.Int64Value",
"access_control_improvements": {
"select_from_system_db_requires_grant": "google.protobuf.BoolValue",
"select_from_information_schema_requires_grant": "google.protobuf.BoolValue"
},
"max_connections": "google.protobuf.Int64Value",
"max_concurrent_queries": "google.protobuf.Int64Value",
"max_table_size_to_drop": "google.protobuf.Int64Value",
"max_partition_size_to_drop": "google.protobuf.Int64Value",
"keep_alive_timeout": "google.protobuf.Int64Value",
"uncompressed_cache_size": "google.protobuf.Int64Value",
"mark_cache_size": "google.protobuf.Int64Value",
"timezone": "string",
"geobase_enabled": "google.protobuf.BoolValue",
"geobase_uri": "string",
"default_database": "google.protobuf.StringValue",
"total_memory_profiler_step": "google.protobuf.Int64Value",
"total_memory_tracker_sample_probability": "google.protobuf.DoubleValue",
"async_insert_threads": "google.protobuf.Int64Value",
"backup_threads": "google.protobuf.Int64Value",
"restore_threads": "google.protobuf.Int64Value",
"merge_tree": {
"parts_to_delay_insert": "google.protobuf.Int64Value",
"parts_to_throw_insert": "google.protobuf.Int64Value",
"inactive_parts_to_delay_insert": "google.protobuf.Int64Value",
"inactive_parts_to_throw_insert": "google.protobuf.Int64Value",
"max_avg_part_size_for_too_many_parts": "google.protobuf.Int64Value",
"max_parts_in_total": "google.protobuf.Int64Value",
"max_replicated_merges_in_queue": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_lower_max_size_of_merge": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_execute_mutation": "google.protobuf.Int64Value",
"max_bytes_to_merge_at_min_space_in_pool": "google.protobuf.Int64Value",
"max_bytes_to_merge_at_max_space_in_pool": "google.protobuf.Int64Value",
"min_bytes_for_wide_part": "google.protobuf.Int64Value",
"min_rows_for_wide_part": "google.protobuf.Int64Value",
"cleanup_delay_period": "google.protobuf.Int64Value",
"max_cleanup_delay_period": "google.protobuf.Int64Value",
"merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"max_merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"min_age_to_force_merge_seconds": "google.protobuf.Int64Value",
"min_age_to_force_merge_on_partition_only": "google.protobuf.BoolValue",
"merge_max_block_size": "google.protobuf.Int64Value",
"deduplicate_merge_projection_mode": "DeduplicateMergeProjectionMode",
"lightweight_mutation_projection_mode": "LightweightMutationProjectionMode",
"replicated_deduplication_window": "google.protobuf.Int64Value",
"replicated_deduplication_window_seconds": "google.protobuf.Int64Value",
"fsync_after_insert": "google.protobuf.BoolValue",
"fsync_part_directory": "google.protobuf.BoolValue",
"min_compressed_bytes_to_fsync_after_fetch": "google.protobuf.Int64Value",
"min_compressed_bytes_to_fsync_after_merge": "google.protobuf.Int64Value",
"min_rows_to_fsync_after_merge": "google.protobuf.Int64Value",
"ttl_only_drop_parts": "google.protobuf.BoolValue",
"merge_with_ttl_timeout": "google.protobuf.Int64Value",
"merge_with_recompression_ttl_timeout": "google.protobuf.Int64Value",
"max_number_of_merges_with_ttl_in_pool": "google.protobuf.Int64Value",
"materialize_ttl_recalculate_only": "google.protobuf.BoolValue",
"check_sample_column_is_correct": "google.protobuf.BoolValue",
"allow_remote_fs_zero_copy_replication": "google.protobuf.BoolValue"
},
"compression": [
{
"method": "Method",
"min_part_size": "int64",
"min_part_size_ratio": "double",
"level": "google.protobuf.Int64Value"
}
],
"dictionaries": [
{
"name": "string",
"structure": {
"id": {
"name": "string"
},
"key": {
"attributes": [
{
"name": "string",
"type": "string",
"null_value": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"range_min": {
"name": "string",
"type": "string",
"null_value": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"range_max": {
"name": "string",
"type": "string",
"null_value": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
},
"attributes": [
{
"name": "string",
"type": "string",
"null_value": "string",
"expression": "string",
"hierarchical": "bool",
"injective": "bool"
}
]
},
"layout": {
"type": "Type",
"size_in_cells": "int64",
"allow_read_expired_keys": "google.protobuf.BoolValue",
"max_update_queue_size": "int64",
"update_queue_push_timeout_milliseconds": "int64",
"query_wait_timeout_milliseconds": "int64",
"max_threads_for_updates": "int64",
"initial_array_size": "int64",
"max_array_size": "int64",
"access_to_key_from_attributes": "google.protobuf.BoolValue"
},
// Includes only one of the fields `fixed_lifetime`, `lifetime_range`
"fixed_lifetime": "int64",
"lifetime_range": {
"min": "int64",
"max": "int64"
},
// end of the list of possible fields
// Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`
"http_source": {
"url": "string",
"format": "string",
"headers": [
{
"name": "string",
"value": "string"
}
]
},
"mysql_source": {
"db": "string",
"table": "string",
"port": "int64",
"user": "string",
"password": "string",
"replicas": [
{
"host": "string",
"priority": "int64",
"port": "int64",
"user": "string",
"password": "string"
}
],
"where": "string",
"invalidate_query": "string",
"close_connection": "google.protobuf.BoolValue",
"share_connection": "google.protobuf.BoolValue"
},
"clickhouse_source": {
"db": "string",
"table": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"where": "string",
"secure": "google.protobuf.BoolValue"
},
"mongodb_source": {
"db": "string",
"collection": "string",
"host": "string",
"port": "int64",
"user": "string",
"password": "string",
"options": "string"
},
"postgresql_source": {
"db": "string",
"table": "string",
"hosts": [
"string"
],
"port": "int64",
"user": "string",
"password": "string",
"invalidate_query": "string",
"ssl_mode": "SslMode"
}
// end of the list of possible fields
}
],
"graphite_rollup": [
{
"name": "string",
"patterns": [
{
"regexp": "string",
"function": "string",
"retention": [
{
"age": "int64",
"precision": "int64"
}
]
}
],
"path_column_name": "string",
"time_column_name": "string",
"value_column_name": "string",
"version_column_name": "string"
}
],
"kafka": {
"security_protocol": "SecurityProtocol",
"sasl_mechanism": "SaslMechanism",
"sasl_username": "string",
"sasl_password": "string",
"enable_ssl_certificate_verification": "google.protobuf.BoolValue",
"max_poll_interval_ms": "google.protobuf.Int64Value",
"session_timeout_ms": "google.protobuf.Int64Value",
"debug": "Debug",
"auto_offset_reset": "AutoOffsetReset"
},
"kafka_topics": [
{
"name": "string",
"settings": {
"security_protocol": "SecurityProtocol",
"sasl_mechanism": "SaslMechanism",
"sasl_username": "string",
"sasl_password": "string",
"enable_ssl_certificate_verification": "google.protobuf.BoolValue",
"max_poll_interval_ms": "google.protobuf.Int64Value",
"session_timeout_ms": "google.protobuf.Int64Value",
"debug": "Debug",
"auto_offset_reset": "AutoOffsetReset"
}
}
],
"rabbitmq": {
"username": "string",
"password": "string",
"vhost": "string"
},
"query_masking_rules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"query_cache": {
"max_size_in_bytes": "google.protobuf.Int64Value",
"max_entries": "google.protobuf.Int64Value",
"max_entry_size_in_bytes": "google.protobuf.Int64Value",
"max_entry_size_in_rows": "google.protobuf.Int64Value"
},
"jdbc_bridge": {
"host": "string",
"port": "google.protobuf.Int64Value"
},
"mysql_protocol": "google.protobuf.BoolValue",
"custom_macros": [
{
"name": "string",
"value": "string"
}
],
"builtin_dictionaries_reload_interval": "google.protobuf.Int64Value"
},
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
},
"weight": "google.protobuf.Int64Value",
"disk_size_autoscaling": {
"planned_usage_threshold": "google.protobuf.Int64Value",
"emergency_usage_threshold": "google.protobuf.Int64Value",
"disk_size_limit": "google.protobuf.Int64Value"
}
}
},
"shard_group_names": [
"string"
]
}
],
"host_specs": [
{
"zone_id": "string",
"type": "Type",
"subnet_id": "string",
"assign_public_ip": "bool",
"shard_name": "string"
}
],
"copy_schema": "google.protobuf.BoolValue"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the ClickHouse cluster to add shards to. |
|
shard_specs[] |
Properties of each shard to be created. |
|
host_specs[] |
Individual configurations for hosts that should be created for the shards.
|
|
copy_schema |
Whether to copy schema to hosts of the new shards. The schema is copied from hosts of an existing shard. |
ShardSpec
|
Field |
Description |
|
name |
string Required field. Name of the shard to be created. |
|
config_spec |
Configuration of the shard to be created. |
|
shard_group_names[] |
string Shard groups that contain the shard. |
ShardConfigSpec
|
Field |
Description |
|
clickhouse |
ClickHouse configuration for a shard. |
Clickhouse
|
Field |
Description |
|
config |
ClickHouse settings for the shard. |
|
resources |
Computational resources for the shard. |
|
weight |
Relative weight of the shard considered when writing data to the cluster. |
|
disk_size_autoscaling |
Disk size autoscaling settings. |
ClickhouseConfig
ClickHouse configuration settings. Supported settings are a subset of settings described
in ClickHouse documentation.
|
Field |
Description |
|
background_pool_size |
Sets the number of threads performing background merges and mutations for MergeTree-engine tables. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
background_merges_mutations_concurrency_ratio |
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. Default value: 2. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
background_schedule_pool_size |
The maximum number of threads that will be used for constantly executing some lightweight periodic operations Default value: 512. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
background_fetches_pool_size |
The maximum number of threads that will be used for fetching data parts from another replica for MergeTree-engine tables in a background. Default value: 32 for versions 25.1 and higher, 16 for versions 24.12 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
background_move_pool_size |
The maximum number of threads that will be used for moving data parts to another disk or volume for MergeTree-engine tables in a background. Default value: 8. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
background_distributed_schedule_pool_size |
The maximum number of threads that will be used for executing distributed sends. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
background_buffer_flush_schedule_pool_size |
The maximum number of threads that will be used for performing flush operations for Buffer-engine tables in the background. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
background_message_broker_schedule_pool_size |
The maximum number of threads that will be used for executing background operations for message streaming. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
background_common_pool_size |
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 value: 8. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. |
|
dictionaries_lazy_load |
Lazy loading of dictionaries. If enabled, then each dictionary is loaded on the first use. Otherwise, the server loads all dictionaries at startup. Default value: true for versions 25.1 and higher, false for versions 24.12 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
log_level |
enum LogLevel Logging level.
|
|
query_log_retention_size |
The maximum size that query_log can grow to before old data will be removed. If set to 0, Default value: 1073741824 (1 GiB). |
|
query_log_retention_time |
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. Default value: 2592000000 (30 days). |
|
query_thread_log_enabled |
Enables or disables query_thread_log system table. Default value: true. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
query_thread_log_retention_size |
The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). |
|
query_thread_log_retention_time |
The maximum time that query_thread_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
part_log_retention_size |
The maximum size that part_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). |
|
part_log_retention_time |
The maximum time that part_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
metric_log_enabled |
Enables or disables metric_log system table. Default value: false for versions 25.1 and higher, true for versions 24.12 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
metric_log_retention_size |
The maximum size that metric_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). |
|
metric_log_retention_time |
The maximum time that metric_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
trace_log_enabled |
Enables or disables trace_log system table. Default value: true for versions 25.2 and higher, false for versions 25.1 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
trace_log_retention_size |
The maximum size that trace_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). |
|
trace_log_retention_time |
The maximum time that trace_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
text_log_enabled |
Enables or disables text_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
text_log_retention_size |
The maximum size that text_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). |
|
text_log_retention_time |
The maximum time that text_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
text_log_level |
enum LogLevel Logging level for text_log system table. Default value: TRACE. Change of the setting is applied with restart.
|
|
opentelemetry_span_log_enabled |
Enables or disables opentelemetry_span_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
opentelemetry_span_log_retention_size |
The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0, Default value: 0. |
|
opentelemetry_span_log_retention_time |
The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
query_views_log_enabled |
Enables or disables query_views_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
query_views_log_retention_size |
The maximum size that query_views_log can grow to before old data will be removed. If set to 0, Default value: 0. |
|
query_views_log_retention_time |
The maximum time that query_views_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
asynchronous_metric_log_enabled |
Enables or disables asynchronous_metric_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
asynchronous_metric_log_retention_size |
The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0, Default value: 0. |
|
asynchronous_metric_log_retention_time |
The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
session_log_enabled |
Enables or disables session_log system table. Default value: true for versions 25.3 and higher, false for versions 25.2 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
session_log_retention_size |
The maximum size that session_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB) for versions 25.3 and higher, 0 for versions 25.2 and lower. |
|
session_log_retention_time |
The maximum time that session_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
zookeeper_log_enabled |
Enables or disables zookeeper_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
zookeeper_log_retention_size |
The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0, Default value: 0. |
|
zookeeper_log_retention_time |
The maximum time that zookeeper_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
asynchronous_insert_log_enabled |
Enables or disables asynchronous_insert_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
asynchronous_insert_log_retention_size |
The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0, Default value: 0. |
|
asynchronous_insert_log_retention_time |
The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
processors_profile_log_enabled |
Enables or disables processors_profile_log system table. Default value: true for versions 25.2 and higher, false for versions 25.1 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
processors_profile_log_retention_size |
The maximum size that processors_profile_log can grow to before old data will be removed. If set to 0, Default value: 0. |
|
processors_profile_log_retention_time |
The maximum time that processors_profile_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
error_log_enabled |
Enables or disables error_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
error_log_retention_size |
The maximum size that error_log can grow to before old data will be removed. If set to 0, Default value: 0. |
|
error_log_retention_time |
The maximum time that error_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). |
|
access_control_improvements |
Access control settings. |
|
max_connections |
Maximum number of inbound connections. Default value: 4096. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
max_concurrent_queries |
Maximum number of concurrently executed queries. Default value: 500. For details, see ClickHouse documentation. |
|
max_table_size_to_drop |
Maximum size of the table that can be deleted using DROP or TRUNCATE query. Default value: 50000000000 (48828125 KiB). For details, see ClickHouse documentation. |
|
max_partition_size_to_drop |
Maximum size of the partition that can be deleted using DROP or TRUNCATE query. Default value: 50000000000 (48828125 KiB). For details, see ClickHouse documentation. |
|
keep_alive_timeout |
The number of seconds that ClickHouse waits for incoming requests for HTTP protocol before closing the connection. Default value: 30. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
uncompressed_cache_size |
Cache size (in bytes) for uncompressed data used by table engines from the MergeTree family. 0 means disabled. For details, see ClickHouse documentation. |
|
mark_cache_size |
Maximum size (in bytes) of the cache of "marks" used by MergeTree tables. For details, see ClickHouse documentation. |
|
timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. Default value: Europe/Moscow. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
geobase_enabled |
Enables or disables geobase. Default value: false for versions 25.8 and higher, true for versions 25.7 and lower. Change of the setting is applied with restart. |
|
geobase_uri |
string Address of the archive with the user geobase in Object Storage. Change of the setting is applied with restart. |
|
default_database |
The default database. Default value: default. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
total_memory_profiler_step |
Whenever server memory usage becomes larger than every next step in number of bytes the memory profiler will collect Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
total_memory_tracker_sample_probability |
Allows to collect random allocations and de-allocations and writes them in the system.trace_log system table Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
async_insert_threads |
Maximum number of threads to parse and insert data in background. If set to 0, asynchronous mode is disabled. Default value: 16. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
backup_threads |
The maximum number of threads to execute BACKUP requests. Default value: 16. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
restore_threads |
The maximum number of threads to execute RESTORE requests. Default value: 16. Change of the setting is applied with restart. For details, see ClickHouse documentation. |
|
merge_tree |
Settings for the MergeTree table engine family. Change of the settings of merge_tree is applied with restart. |
|
compression[] |
Data compression settings for MergeTree engine tables. Change of the settings of compression is applied with restart. For details, see ClickHouse documentation. |
|
dictionaries[] |
Configuration of external dictionaries. Change of the settings of dictionaries is applied with restart. For details, see ClickHouse documentation. |
|
graphite_rollup[] |
Rollup settings for the GraphiteMergeTree engine tables. Change of the settings of graphite_rollup is applied with restart. For details, see ClickHouse documentation. |
|
kafka |
Kafka integration settings. Change of the settings of kafka is applied with restart. |
|
kafka_topics[] |
Per-topic Kafka integration settings. Change of the settings of kafka_topics is applied with restart. |
|
rabbitmq |
RabbitMQ integration settings. Change of the settings of rabbitmq is applied with restart. |
|
query_masking_rules[] |
Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, Change of the settings of query_masking_rules is applied with restart. For details, see ClickHouse documentation. |
|
query_cache |
Query cache configuration. Change of the settings of query_cache is applied with restart. |
|
jdbc_bridge |
JDBC bridge configuration for queries to external databases. Change of the settings of jdbc_bridge is applied with restart. For details, see ClickHouse documentation. |
|
mysql_protocol |
Enables or disables MySQL interface on ClickHouse server Default value: false. For details, see ClickHouse documentation. |
|
custom_macros[] |
Custom ClickHouse macros. |
|
builtin_dictionaries_reload_interval |
The interval in seconds before reloading built-in dictionaries. Default value: 3600. For details, see ClickHouse documentation. |
AccessControlImprovements
Access control settings.
For details, see ClickHouse documentation.
|
Field |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
select_from_system_db_requires_grant |
Sets whether SELECT * FROM system. Default value: false. select_from_information_schema_requires_grant Sets whether SELECT * FROM information_schema. Default value: false. Settings for the MergeTree table engine family. Field Description parts_to_delay_insert If the number of active parts in a single partition exceeds the parts_to_delay_insert value, an INSERT artificially slows down. Default value: 1000 for versions 25.1 and higher, 150 for versions 24.12 and lower. For details, see ClickHouse documentation. parts_to_throw_insert If the number of active parts in a single partition exceeds the parts_to_throw_insert value, an INSERT Default value: 3000 for versions 25.1 and higher, 300 for versions 24.12 and lower. For details, see ClickHouse documentation. inactive_parts_to_delay_insert If the number of inactive parts in a single partition in the table exceeds the inactive_parts_to_delay_insert value, Default value: 0. For details, see ClickHouse documentation. inactive_parts_to_throw_insert If the number of inactive parts in a single partition more than the inactive_parts_to_throw_insert value, Default value: 0. For details, see ClickHouse documentation. max_avg_part_size_for_too_many_parts The "Too many parts" check according to parts_to_delay_insert and parts_to_throw_insert will be active only if the average Default value: 1073741824 (1 GiB). For details, see ClickHouse documentation. max_parts_in_total If the total number of active parts in all partitions of a table exceeds the max_parts_in_total value, Default value: 20000 for versions 25.2 and higher, 100000 for versions 25.1 and lower. For details, see ClickHouse documentation. max_replicated_merges_in_queue How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. Default value: 32 for versions 25.8 and higher, 16 for versions 25.7 and lower. For details, see ClickHouse documentation. number_of_free_entries_in_pool_to_lower_max_size_of_merge When there is less than the specified number of free entries in pool (or replicated queue), start to lower maximum size of Default value: 8. For details, see ClickHouse documentation. number_of_free_entries_in_pool_to_execute_mutation When there is less than specified number of free entries in pool, do not execute part mutations. Default value: 20. For details, see ClickHouse documentation. max_bytes_to_merge_at_min_space_in_pool The maximum total part size (in bytes) to be merged into one part, with the minimum available resources in the background pool. Default value: 1048576 (1 MiB). For details, see ClickHouse documentation. max_bytes_to_merge_at_max_space_in_pool The maximum total parts size (in bytes) to be merged into one part, if there are enough resources available. Default value: 161061273600 (150 GiB). For details, see ClickHouse documentation. min_bytes_for_wide_part Minimum number of bytes in a data part that can be stored in Wide format. Default value: 10485760 (10 MiB). For details, see ClickHouse documentation. min_rows_for_wide_part Minimum number of rows in a data part that can be stored in Wide format. Default value: 0. For details, see ClickHouse documentation. cleanup_delay_period Minimum period to clean old queue logs, blocks hashes and parts. Default value: 30. For details, see ClickHouse documentation. max_cleanup_delay_period Maximum period to clean old queue logs, blocks hashes and parts. Default value: 300 (5 minutes). For details, see ClickHouse documentation. merge_selecting_sleep_ms Minimum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger Default value: 5000 (5 seconds). For details, see ClickHouse documentation. max_merge_selecting_sleep_ms Maximum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger Default value: 60000 (1 minute). For details, see ClickHouse documentation. min_age_to_force_merge_seconds Merge parts if every part in the range is older than the specified value. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. min_age_to_force_merge_on_partition_only Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. Default value: false. For details, see ClickHouse documentation. merge_max_block_size The number of rows that are read from the merged parts into memory. Default value: 8192. For details, see ClickHouse documentation. deduplicate_merge_projection_mode enum DeduplicateMergeProjectionMode Determines the behavior of background merges for MergeTree tables with projections. Default value: DEDUPLICATE_MERGE_PROJECTION_MODE_THROW. For details, see ClickHouse documentation. lightweight_mutation_projection_mode enum LightweightMutationProjectionMode Determines the behavior of lightweight deletes for MergeTree tables with projections. Default value: LIGHTWEIGHT_MUTATION_PROJECTION_MODE_THROW. For details, see ClickHouse documentation. replicated_deduplication_window The number of most recently inserted blocks for which ClickHouse Keeper stores hash sums to check for duplicates. Default value: 10000 for versions 25.9 and higher, 1000 for versions from 23.11 to 25.8, 100 for versions 23.10 and lower. For details, see ClickHouse documentation. replicated_deduplication_window_seconds The number of seconds after which the hash sums of the inserted blocks are removed from ClickHouse Keeper. Default value: 604800 (7 days). For details, see ClickHouse documentation. fsync_after_insert Do fsync for every inserted part. Significantly decreases performance of inserts, not recommended to use with wide parts. Default value: false. For details, see ClickHouse documentation. fsync_part_directory Do fsync for part directory after all part operations (writes, renames, etc.). Default value: false. For details, see ClickHouse documentation. min_compressed_bytes_to_fsync_after_fetch Minimal number of compressed bytes to do fsync for part after fetch. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. min_compressed_bytes_to_fsync_after_merge Minimal number of compressed bytes to do fsync for part after merge. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. min_rows_to_fsync_after_merge Minimal number of rows to do fsync for part after merge. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. ttl_only_drop_parts Controls whether data parts are fully dropped in MergeTree tables when all rows in that part have expired according to their TTL settings. Default value: false. For details, see ClickHouse documentation. merge_with_ttl_timeout Minimum delay in seconds before repeating a merge with delete TTL. Default value: 14400 (4 hours). For details, see ClickHouse documentation. merge_with_recompression_ttl_timeout Minimum delay in seconds before repeating a merge with recompression TTL. Default value: 14400 (4 hours). For details, see ClickHouse documentation. max_number_of_merges_with_ttl_in_pool When there is more than specified number of merges with TTL entries in pool, do not assign new merge with TTL. Default value: 2. For details, see ClickHouse documentation. materialize_ttl_recalculate_only Only recalculate ttl info when MATERIALIZE TTL. Default value: true for versions 25.2 and higher, false for versions 25.1 and lower. For details, see ClickHouse documentation. check_sample_column_is_correct Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. Default value: true. For details, see ClickHouse documentation. allow_remote_fs_zero_copy_replication Setting is automatically enabled if cloud storage is enabled, disabled otherwise. Default value: true. Compression settings. Field Description method enum Method Required field. Compression method to use for the specified combination of min_part_size and min_part_size_ratio. min_part_size int64 The minimum size of a data part. min_part_size_ratio double The ratio of the data part size to the table size. level Compression level. External dictionary configuration. Field Description name string Required field. Name of the external dictionary. structure Required field. Structure of the external dictionary. layout Required field. Layout determining how to store the dictionary in memory. For details, see https://clickhouse.com/docs/sql-reference/dictionaries#ways-to-store-dictionaries-in-memory. fixed_lifetime int64 Fixed interval between dictionary updates. Includes only one of the fields lifetime_range Range of intervals between dictionary updates for ClickHouse to choose from. Includes only one of the fields http_source HTTP source for the dictionary. Includes only one of the fields mysql_source MySQL source for the dictionary. Includes only one of the fields clickhouse_source ClickHouse source for the dictionary. Includes only one of the fields mongodb_source MongoDB source for the dictionary. Includes only one of the fields postgresql_source PostgreSQL source for the dictionary. Includes only one of the fields Configuration of 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. For details, see ClickHouse documentation. range_min Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation. range_max Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation. attributes[] Description of the fields available for database queries. For details, see ClickHouse documentation. Numeric key. Field Description name string Required field. Name of the numeric key. Complex key. Field Description attributes[] Attributes of a complex key. Field Description name string Required field. Name of the column. type string Required field. Type of the column. null_value 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. Default value: false. injective bool Indication of injective mapping "id -> attribute". Default value: false. Field Description type enum Type Required field. Layout type. For details, see ClickHouse documentation. size_in_cells int64 Number of cells in the cache. Rounded up to a power of two. Default value: 1000000000. For details, see ClickHouse documentation. allow_read_expired_keys Allows to read expired keys. Default value: false. For details, see ClickHouse documentation. max_update_queue_size int64 Max size of update queue. Default value: 100000. For details, see ClickHouse documentation. update_queue_push_timeout_milliseconds int64 Max timeout in milliseconds for push update task into queue. Default value: 10. For details, see ClickHouse documentation. query_wait_timeout_milliseconds int64 Max wait timeout in milliseconds for update task to complete. Default value: 60000 (1 minute). For details, see ClickHouse documentation. max_threads_for_updates int64 Max threads for cache dictionary update. Default value: 4. For details, see ClickHouse documentation. initial_array_size int64 Initial dictionary key size. Default value: 1024. For details, see ClickHouse documentation. max_array_size int64 Maximum dictionary key size. Default value: 500000. For details, see ClickHouse documentation. access_to_key_from_attributes Allows to retrieve key attribute using dictGetString function. For details, see ClickHouse documentation. Field Description min int64 Minimum dictionary lifetime. max int64 Maximum dictionary lifetime. 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. Field Description name string Required field. Header name. value string Required field. Header value. Field Description db string Required field. Database name. table string Required field. Table name. port int64 Port to use when connecting to a replica of the dictionary source. user string Required field. Name of the user for replicas of the dictionary source. password string Password of the 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. invalidate_query string Query for checking the dictionary status, to pull only updated data. close_connection Should a connection be closed after each request. share_connection Should a connection be shared for some requests. Field Description host string Required field. MySQL host of the replica. priority int64 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. Field Description db string Required field. Database name. table string Required field. Table name. host string ClickHouse host. 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 Determines whether to use TLS for connection. Field Description db string Required field. Database name. collection string Required field. Collection name. host string Required field. MongoDB host. 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 Dictionary source options. Field Description db string Required field. Database name. table string Required field. Table name. hosts[] string PostgreSQL hosts. port int64 Port to use when connecting to the PostgreSQL hosts. user string Required field. Name of the PostrgreSQL database user. password string Password of the PostrgreSQL database user. invalidate_query string Query for checking the dictionary status, to pull only updated data. ssl_mode enum SslMode Mode of SSL TCP/IP connection to the PostgreSQL host. 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. path_column_name string The name of the column storing the metric name (Graphite sensor). Default value: Path. time_column_name string The name of the column storing the time of measuring the metric. Default value: Time. value_column_name string The name of the column storing the value of the metric at the time set in time_column_name. Default value: Value. version_column_name string The name of the column storing the version of the metric. Default value: Timestamp. Field Description regexp string A pattern for the metric name (a regular or DSL). function string The name of the aggregating function to apply to data whose age falls within the range [age, age + precision]. retention[] Retention rules. Field Description age int64 The minimum age of the data in seconds. precision int64 Precision of determining the age of the data, in seconds. Should be a divisor for 86400 (seconds in a day). Kafka configuration settings. Field Description security_protocol enum SecurityProtocol Protocol used to communicate with brokers. Default value: SECURITY_PROTOCOL_PLAINTEXT. sasl_mechanism enum SaslMechanism SASL mechanism to use for authentication. Default value: SASL_MECHANISM_GSSAPI. sasl_username string SASL username for use with the PLAIN and SASL-SCRAM mechanisms. sasl_password string SASL password for use with the PLAIN and SASL-SCRAM mechanisms. enable_ssl_certificate_verification Enable OpenSSL's builtin broker (server) certificate verification. Default value: true. max_poll_interval_ms Maximum allowed time between calls to consume messages for high-level consumers. Default value: 300000 (5 minutes). session_timeout_ms Client group session and failure detection timeout. The consumer sends periodic heartbeats (heartbeat.interval.ms) Default value: 45000 (45 seconds). debug enum Debug Debug context to enable. auto_offset_reset enum AutoOffsetReset Action to take when there is no initial offset in offset store or the desired offset is out of range. Default value: AUTO_OFFSET_RESET_LARGEST. Field Description name string Required field. Kafka topic name. settings Required field. Kafka topic settings. RabbitMQ integration settings. Field Description username string RabbitMQ username. password string RabbitMQ password. vhost string RabbitMQ virtual host. Field Description name string Name for the rule. regexp string Required field. RE2 compatible regular expression. replace string Substitution string for sensitive data. Default value: six asterisks. Query cache configuration. Field Description max_size_in_bytes The maximum cache size in bytes. Default value: 1073741824 (1 GiB). max_entries The maximum number of SELECT query results stored in the cache. Default value: 1024. max_entry_size_in_bytes The maximum size in bytes SELECT query results may have to be saved in the cache. Default value: 1048576 (1 MiB). max_entry_size_in_rows The maximum number of rows SELECT query results may have to be saved in the cache. Default value: 30000000. JDBC bridge configuration for queries to external databases. Field Description host string Host of jdbc bridge. port Port of jdbc bridge. Default value: 9019. ClickHouse macro. Field Description name string Required field. Name of the macro. value string Required field. Value of the macro. Field Description resource_preset_id string ID of the preset for computational resources available to a host (CPU, memory etc.). disk_size int64 Volume of the storage available to a host, in bytes. disk_type_id string Type of the storage environment for the host. Field Description planned_usage_threshold Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. emergency_usage_threshold Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. disk_size_limit Limit on how large the storage for database instances can automatically grow, in bytes. Field Description zone_id string ID of the availability zone where the host resides. type enum Type Required field. Type of the host to be deployed. subnet_id string ID of the subnet that the host should belong to. This subnet should be a part assign_public_ip bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign Possible values: shard_name string Name of the shard that the host is assigned to. 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. created_at Creation timestamp. created_by string ID of the user or service account who initiated the operation. modified_at 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. Field Description cluster_id string ID of the cluster that the shards are being added to. shard_names[] string Names of the shards being created. Field Description shards[] Field Description name string Name of the shard. cluster_id string ID of the cluster that the shard belongs to. config Configuration of the shard. Field Description clickhouse ClickHouse configuration for a shard. Field Description config ClickHouse settings for a shard. resources Computational resources for a shard. weight Relative weight of a shard considered when writing data to the cluster. disk_size_autoscaling Disk size autoscaling settings. Field Description effective_config Required field. Effective configuration (a combination of user-defined configuration and default configuration). user_config Required field. User-defined configuration. default_config Required field. Default configuration. ClickHouse configuration settings. Supported settings are a subset of settings described Field Description background_pool_size Sets the number of threads performing background merges and mutations for MergeTree-engine tables. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. background_merges_mutations_concurrency_ratio 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. Default value: 2. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. background_schedule_pool_size The maximum number of threads that will be used for constantly executing some lightweight periodic operations Default value: 512. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. background_fetches_pool_size The maximum number of threads that will be used for fetching data parts from another replica for MergeTree-engine tables in a background. Default value: 32 for versions 25.1 and higher, 16 for versions 24.12 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. background_move_pool_size The maximum number of threads that will be used for moving data parts to another disk or volume for MergeTree-engine tables in a background. Default value: 8. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. background_distributed_schedule_pool_size The maximum number of threads that will be used for executing distributed sends. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. background_buffer_flush_schedule_pool_size The maximum number of threads that will be used for performing flush operations for Buffer-engine tables in the background. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. background_message_broker_schedule_pool_size The maximum number of threads that will be used for executing background operations for message streaming. Default value: 16. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. background_common_pool_size 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 value: 8. Change of the setting is applied with restart on value decrease and without restart on value increase. For details, see ClickHouse documentation. dictionaries_lazy_load Lazy loading of dictionaries. If enabled, then each dictionary is loaded on the first use. Otherwise, the server loads all dictionaries at startup. Default value: true for versions 25.1 and higher, false for versions 24.12 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. log_level enum LogLevel Logging level. query_log_retention_size The maximum size that query_log can grow to before old data will be removed. If set to 0, Default value: 1073741824 (1 GiB). query_log_retention_time 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. Default value: 2592000000 (30 days). query_thread_log_enabled Enables or disables query_thread_log system table. Default value: true. Change of the setting is applied with restart. For details, see ClickHouse documentation. query_thread_log_retention_size The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). query_thread_log_retention_time The maximum time that query_thread_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). part_log_retention_size The maximum size that part_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). part_log_retention_time The maximum time that part_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). metric_log_enabled Enables or disables metric_log system table. Default value: false for versions 25.1 and higher, true for versions 24.12 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. metric_log_retention_size The maximum size that metric_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). metric_log_retention_time The maximum time that metric_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). trace_log_enabled Enables or disables trace_log system table. Default value: true for versions 25.2 and higher, false for versions 25.1 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. trace_log_retention_size The maximum size that trace_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). trace_log_retention_time The maximum time that trace_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). text_log_enabled Enables or disables text_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. text_log_retention_size The maximum size that text_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB). text_log_retention_time The maximum time that text_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). text_log_level enum LogLevel Logging level for text_log system table. Default value: TRACE. Change of the setting is applied with restart. opentelemetry_span_log_enabled Enables or disables opentelemetry_span_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. opentelemetry_span_log_retention_size The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0, Default value: 0. opentelemetry_span_log_retention_time The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). query_views_log_enabled Enables or disables query_views_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. query_views_log_retention_size The maximum size that query_views_log can grow to before old data will be removed. If set to 0, Default value: 0. query_views_log_retention_time The maximum time that query_views_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). asynchronous_metric_log_enabled Enables or disables asynchronous_metric_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. asynchronous_metric_log_retention_size The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0, Default value: 0. asynchronous_metric_log_retention_time The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). session_log_enabled Enables or disables session_log system table. Default value: true for versions 25.3 and higher, false for versions 25.2 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. session_log_retention_size The maximum size that session_log can grow to before old data will be removed. If set to 0, Default value: 536870912 (512 MiB) for versions 25.3 and higher, 0 for versions 25.2 and lower. session_log_retention_time The maximum time that session_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). zookeeper_log_enabled Enables or disables zookeeper_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. zookeeper_log_retention_size The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0, Default value: 0. zookeeper_log_retention_time The maximum time that zookeeper_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). asynchronous_insert_log_enabled Enables or disables asynchronous_insert_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. asynchronous_insert_log_retention_size The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0, Default value: 0. asynchronous_insert_log_retention_time The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). processors_profile_log_enabled Enables or disables processors_profile_log system table. Default value: true for versions 25.2 and higher, false for versions 25.1 and lower. Change of the setting is applied with restart. For details, see ClickHouse documentation. processors_profile_log_retention_size The maximum size that processors_profile_log can grow to before old data will be removed. If set to 0, Default value: 0. processors_profile_log_retention_time The maximum time that processors_profile_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). error_log_enabled Enables or disables error_log system table. Default value: false. Change of the setting is applied with restart. For details, see ClickHouse documentation. error_log_retention_size The maximum size that error_log can grow to before old data will be removed. If set to 0, Default value: 0. error_log_retention_time The maximum time that error_log records will be retained before removal. If set to 0, Default value: 2592000000 (30 days). access_control_improvements Access control settings. max_connections Maximum number of inbound connections. Default value: 4096. Change of the setting is applied with restart. For details, see ClickHouse documentation. max_concurrent_queries Maximum number of concurrently executed queries. Default value: 500. For details, see ClickHouse documentation. max_table_size_to_drop Maximum size of the table that can be deleted using DROP or TRUNCATE query. Default value: 50000000000 (48828125 KiB). For details, see ClickHouse documentation. max_partition_size_to_drop Maximum size of the partition that can be deleted using DROP or TRUNCATE query. Default value: 50000000000 (48828125 KiB). For details, see ClickHouse documentation. keep_alive_timeout The number of seconds that ClickHouse waits for incoming requests for HTTP protocol before closing the connection. Default value: 30. Change of the setting is applied with restart. For details, see ClickHouse documentation. uncompressed_cache_size Cache size (in bytes) for uncompressed data used by table engines from the MergeTree family. 0 means disabled. For details, see ClickHouse documentation. mark_cache_size Maximum size (in bytes) of the cache of "marks" used by MergeTree tables. For details, see ClickHouse documentation. timezone string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. Default value: Europe/Moscow. Change of the setting is applied with restart. For details, see ClickHouse documentation. geobase_enabled Enables or disables geobase. Default value: false for versions 25.8 and higher, true for versions 25.7 and lower. Change of the setting is applied with restart. geobase_uri string Address of the archive with the user geobase in Object Storage. Change of the setting is applied with restart. default_database The default database. Default value: default. Change of the setting is applied with restart. For details, see ClickHouse documentation. total_memory_profiler_step Whenever server memory usage becomes larger than every next step in number of bytes the memory profiler will collect Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation. total_memory_tracker_sample_probability Allows to collect random allocations and de-allocations and writes them in the system.trace_log system table Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation. async_insert_threads Maximum number of threads to parse and insert data in background. If set to 0, asynchronous mode is disabled. Default value: 16. Change of the setting is applied with restart. For details, see ClickHouse documentation. backup_threads The maximum number of threads to execute BACKUP requests. Default value: 16. Change of the setting is applied with restart. For details, see ClickHouse documentation. restore_threads The maximum number of threads to execute RESTORE requests. Default value: 16. Change of the setting is applied with restart. For details, see ClickHouse documentation. merge_tree Settings for the MergeTree table engine family. Change of the settings of merge_tree is applied with restart. compression[] Data compression settings for MergeTree engine tables. Change of the settings of compression is applied with restart. For details, see ClickHouse documentation. dictionaries[] Configuration of external dictionaries. Change of the settings of dictionaries is applied with restart. For details, see ClickHouse documentation. graphite_rollup[] Rollup settings for the GraphiteMergeTree engine tables. Change of the settings of graphite_rollup is applied with restart. For details, see ClickHouse documentation. kafka Kafka integration settings. Change of the settings of kafka is applied with restart. kafka_topics[] Per-topic Kafka integration settings. Change of the settings of kafka_topics is applied with restart. rabbitmq RabbitMQ integration settings. Change of the settings of rabbitmq is applied with restart. query_masking_rules[] Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, Change of the settings of query_masking_rules is applied with restart. For details, see ClickHouse documentation. query_cache Query cache configuration. Change of the settings of query_cache is applied with restart. jdbc_bridge JDBC bridge configuration for queries to external databases. Change of the settings of jdbc_bridge is applied with restart. For details, see ClickHouse documentation. mysql_protocol Enables or disables MySQL interface on ClickHouse server Default value: false. For details, see ClickHouse documentation. custom_macros[] Custom ClickHouse macros. builtin_dictionaries_reload_interval The interval in seconds before reloading built-in dictionaries. Default value: 3600. For details, see ClickHouse documentation. Access control settings. Field Description select_from_system_db_requires_grant Sets whether SELECT * FROM system. Default value: false. select_from_information_schema_requires_grant Sets whether SELECT * FROM information_schema. Default value: false. Settings for the MergeTree table engine family. Field Description parts_to_delay_insert If the number of active parts in a single partition exceeds the parts_to_delay_insert value, an INSERT artificially slows down. Default value: 1000 for versions 25.1 and higher, 150 for versions 24.12 and lower. For details, see ClickHouse documentation. parts_to_throw_insert If the number of active parts in a single partition exceeds the parts_to_throw_insert value, an INSERT Default value: 3000 for versions 25.1 and higher, 300 for versions 24.12 and lower. For details, see ClickHouse documentation. inactive_parts_to_delay_insert If the number of inactive parts in a single partition in the table exceeds the inactive_parts_to_delay_insert value, Default value: 0. For details, see ClickHouse documentation. inactive_parts_to_throw_insert If the number of inactive parts in a single partition more than the inactive_parts_to_throw_insert value, Default value: 0. For details, see ClickHouse documentation. max_avg_part_size_for_too_many_parts The "Too many parts" check according to parts_to_delay_insert and parts_to_throw_insert will be active only if the average Default value: 1073741824 (1 GiB). For details, see ClickHouse documentation. max_parts_in_total If the total number of active parts in all partitions of a table exceeds the max_parts_in_total value, Default value: 20000 for versions 25.2 and higher, 100000 for versions 25.1 and lower. For details, see ClickHouse documentation. max_replicated_merges_in_queue How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. Default value: 32 for versions 25.8 and higher, 16 for versions 25.7 and lower. For details, see ClickHouse documentation. number_of_free_entries_in_pool_to_lower_max_size_of_merge When there is less than the specified number of free entries in pool (or replicated queue), start to lower maximum size of Default value: 8. For details, see ClickHouse documentation. number_of_free_entries_in_pool_to_execute_mutation When there is less than specified number of free entries in pool, do not execute part mutations. Default value: 20. For details, see ClickHouse documentation. max_bytes_to_merge_at_min_space_in_pool The maximum total part size (in bytes) to be merged into one part, with the minimum available resources in the background pool. Default value: 1048576 (1 MiB). For details, see ClickHouse documentation. max_bytes_to_merge_at_max_space_in_pool The maximum total parts size (in bytes) to be merged into one part, if there are enough resources available. Default value: 161061273600 (150 GiB). For details, see ClickHouse documentation. min_bytes_for_wide_part Minimum number of bytes in a data part that can be stored in Wide format. Default value: 10485760 (10 MiB). For details, see ClickHouse documentation. min_rows_for_wide_part Minimum number of rows in a data part that can be stored in Wide format. Default value: 0. For details, see ClickHouse documentation. cleanup_delay_period Minimum period to clean old queue logs, blocks hashes and parts. Default value: 30. For details, see ClickHouse documentation. max_cleanup_delay_period Maximum period to clean old queue logs, blocks hashes and parts. Default value: 300 (5 minutes). For details, see ClickHouse documentation. merge_selecting_sleep_ms Minimum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger Default value: 5000 (5 seconds). For details, see ClickHouse documentation. max_merge_selecting_sleep_ms Maximum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger Default value: 60000 (1 minute). For details, see ClickHouse documentation. min_age_to_force_merge_seconds Merge parts if every part in the range is older than the specified value. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. min_age_to_force_merge_on_partition_only Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. Default value: false. For details, see ClickHouse documentation. merge_max_block_size The number of rows that are read from the merged parts into memory. Default value: 8192. For details, see ClickHouse documentation. deduplicate_merge_projection_mode enum DeduplicateMergeProjectionMode Determines the behavior of background merges for MergeTree tables with projections. Default value: DEDUPLICATE_MERGE_PROJECTION_MODE_THROW. For details, see ClickHouse documentation. lightweight_mutation_projection_mode enum LightweightMutationProjectionMode Determines the behavior of lightweight deletes for MergeTree tables with projections. Default value: LIGHTWEIGHT_MUTATION_PROJECTION_MODE_THROW. For details, see ClickHouse documentation. replicated_deduplication_window The number of most recently inserted blocks for which ClickHouse Keeper stores hash sums to check for duplicates. Default value: 10000 for versions 25.9 and higher, 1000 for versions from 23.11 to 25.8, 100 for versions 23.10 and lower. For details, see ClickHouse documentation. replicated_deduplication_window_seconds The number of seconds after which the hash sums of the inserted blocks are removed from ClickHouse Keeper. Default value: 604800 (7 days). For details, see ClickHouse documentation. fsync_after_insert Do fsync for every inserted part. Significantly decreases performance of inserts, not recommended to use with wide parts. Default value: false. For details, see ClickHouse documentation. fsync_part_directory Do fsync for part directory after all part operations (writes, renames, etc.). Default value: false. For details, see ClickHouse documentation. min_compressed_bytes_to_fsync_after_fetch Minimal number of compressed bytes to do fsync for part after fetch. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. min_compressed_bytes_to_fsync_after_merge Minimal number of compressed bytes to do fsync for part after merge. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. min_rows_to_fsync_after_merge Minimal number of rows to do fsync for part after merge. 0 means disabled. Default value: 0. For details, see ClickHouse documentation. ttl_only_drop_parts Controls whether data parts are fully dropped in MergeTree tables when all rows in that part have expired according to their TTL settings. Default value: false. For details, see ClickHouse documentation. merge_with_ttl_timeout Minimum delay in seconds before repeating a merge with delete TTL. Default value: 14400 (4 hours). For details, see ClickHouse documentation. merge_with_recompression_ttl_timeout Minimum delay in seconds before repeating a merge with recompression TTL. Default value: 14400 (4 hours). For details, see ClickHouse documentation. max_number_of_merges_with_ttl_in_pool When there is more than specified number of merges with TTL entries in pool, do not assign new merge with TTL. Default value: 2. For details, see ClickHouse documentation. materialize_ttl_recalculate_only Only recalculate ttl info when MATERIALIZE TTL. Default value: true for versions 25.2 and higher, false for versions 25.1 and lower. For details, see ClickHouse documentation. check_sample_column_is_correct Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. Default value: true. For details, see ClickHouse documentation. allow_remote_fs_zero_copy_replication Setting is automatically enabled if cloud storage is enabled, disabled otherwise. Default value: true. Compression settings. Field Description method enum Method Required field. Compression method to use for the specified combination of min_part_size and min_part_size_ratio. min_part_size int64 The minimum size of a data part. min_part_size_ratio double The ratio of the data part size to the table size. level Compression level. External dictionary configuration. Field Description name string Required field. Name of the external dictionary. structure Required field. Structure of the external dictionary. layout Required field. Layout determining how to store the dictionary in memory. For details, see https://clickhouse.com/docs/sql-reference/dictionaries#ways-to-store-dictionaries-in-memory. fixed_lifetime int64 Fixed interval between dictionary updates. Includes only one of the fields lifetime_range Range of intervals between dictionary updates for ClickHouse to choose from. Includes only one of the fields http_source HTTP source for the dictionary. Includes only one of the fields mysql_source MySQL source for the dictionary. Includes only one of the fields clickhouse_source ClickHouse source for the dictionary. Includes only one of the fields mongodb_source MongoDB source for the dictionary. Includes only one of the fields postgresql_source PostgreSQL source for the dictionary. Includes only one of the fields Configuration of 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. For details, see ClickHouse documentation. range_min Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation. range_max Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation. attributes[] Description of the fields available for database queries. For details, see ClickHouse documentation. Numeric key. Field Description name string Required field. Name of the numeric key. Complex key. Field Description attributes[] Attributes of a complex key. Field Description name string Required field. Name of the column. type string Required field. Type of the column. null_value 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. Default value: false. injective bool Indication of injective mapping "id -> attribute". Default value: false. Field Description type enum Type Required field. Layout type. For details, see ClickHouse documentation. size_in_cells int64 Number of cells in the cache. Rounded up to a power of two. Default value: 1000000000. For details, see ClickHouse documentation. allow_read_expired_keys Allows to read expired keys. Default value: false. For details, see ClickHouse documentation. max_update_queue_size int64 Max size of update queue. Default value: 100000. For details, see ClickHouse documentation. update_queue_push_timeout_milliseconds int64 Max timeout in milliseconds for push update task into queue. Default value: 10. For details, see ClickHouse documentation. query_wait_timeout_milliseconds int64 Max wait timeout in milliseconds for update task to complete. Default value: 60000 (1 minute). For details, see ClickHouse documentation. max_threads_for_updates int64 Max threads for cache dictionary update. Default value: 4. For details, see ClickHouse documentation. initial_array_size int64 Initial dictionary key size. Default value: 1024. For details, see ClickHouse documentation. max_array_size int64 Maximum dictionary key size. Default value: 500000. For details, see ClickHouse documentation. access_to_key_from_attributes Allows to retrieve key attribute using dictGetString function. For details, see ClickHouse documentation. Field Description min int64 Minimum dictionary lifetime. max int64 Maximum dictionary lifetime. 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. Field Description name string Required field. Header name. value string Required field. Header value. Field Description db string Required field. Database name. table string Required field. Table name. port int64 Port to use when connecting to a replica of the dictionary source. user string Required field. Name of the user for replicas of the dictionary source. password string Password of the 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. invalidate_query string Query for checking the dictionary status, to pull only updated data. close_connection Should a connection be closed after each request. share_connection Should a connection be shared for some requests. Field Description host string Required field. MySQL host of the replica. priority int64 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. Field Description db string Required field. Database name. table string Required field. Table name. host string ClickHouse host. 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 Determines whether to use TLS for connection. Field Description db string Required field. Database name. collection string Required field. Collection name. host string Required field. MongoDB host. 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 Dictionary source options. Field Description db string Required field. Database name. table string Required field. Table name. hosts[] string PostgreSQL hosts. port int64 Port to use when connecting to the PostgreSQL hosts. user string Required field. Name of the PostrgreSQL database user. password string Password of the PostrgreSQL database user. invalidate_query string Query for checking the dictionary status, to pull only updated data. ssl_mode enum SslMode Mode of SSL TCP/IP connection to the PostgreSQL host. 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. path_column_name string The name of the column storing the metric name (Graphite sensor). Default value: Path. time_column_name string The name of the column storing the time of measuring the metric. Default value: Time. value_column_name string The name of the column storing the value of the metric at the time set in time_column_name. Default value: Value. version_column_name string The name of the column storing the version of the metric. Default value: Timestamp. Field Description regexp string A pattern for the metric name (a regular or DSL). function string The name of the aggregating function to apply to data whose age falls within the range [age, age + precision]. retention[] Retention rules. Field Description age int64 The minimum age of the data in seconds. precision int64 Precision of determining the age of the data, in seconds. Should be a divisor for 86400 (seconds in a day). Kafka configuration settings. Field Description security_protocol enum SecurityProtocol Protocol used to communicate with brokers. Default value: SECURITY_PROTOCOL_PLAINTEXT. sasl_mechanism enum SaslMechanism SASL mechanism to use for authentication. Default value: SASL_MECHANISM_GSSAPI. sasl_username string SASL username for use with the PLAIN and SASL-SCRAM mechanisms. sasl_password string SASL password for use with the PLAIN and SASL-SCRAM mechanisms. enable_ssl_certificate_verification Enable OpenSSL's builtin broker (server) certificate verification. Default value: true. max_poll_interval_ms Maximum allowed time between calls to consume messages for high-level consumers. Default value: 300000 (5 minutes). session_timeout_ms Client group session and failure detection timeout. The consumer sends periodic heartbeats (heartbeat.interval.ms) Default value: 45000 (45 seconds). debug enum Debug Debug context to enable. auto_offset_reset enum AutoOffsetReset Action to take when there is no initial offset in offset store or the desired offset is out of range. Default value: AUTO_OFFSET_RESET_LARGEST. Field Description name string Required field. Kafka topic name. settings Required field. Kafka topic settings. RabbitMQ integration settings. Field Description username string RabbitMQ username. password string RabbitMQ password. vhost string RabbitMQ virtual host. Field Description name string Name for the rule. regexp string Required field. RE2 compatible regular expression. replace string Substitution string for sensitive data. Default value: six asterisks. Query cache configuration. Field Description max_size_in_bytes The maximum cache size in bytes. Default value: 1073741824 (1 GiB). max_entries The maximum number of SELECT query results stored in the cache. Default value: 1024. max_entry_size_in_bytes The maximum size in bytes SELECT query results may have to be saved in the cache. Default value: 1048576 (1 MiB). max_entry_size_in_rows The maximum number of rows SELECT query results may have to be saved in the cache. Default value: 30000000. JDBC bridge configuration for queries to external databases. Field Description host string Host of jdbc bridge. port Port of jdbc bridge. Default value: 9019. ClickHouse macro. Field Description name string Required field. Name of the macro. value string Required field. Value of the macro. Field Description resource_preset_id string ID of the preset for computational resources available to a host (CPU, memory etc.). disk_size int64 Volume of the storage available to a host, in bytes. disk_type_id string Type of the storage environment for the host. Field Description planned_usage_threshold Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. emergency_usage_threshold Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. disk_size_limit Limit on how large the storage for database instances can automatically grow, in bytes. |