Managed Service for ClickHouse API, gRPC: ClusterService.UpdateShard

Written by

Yandex Cloud

Improved by

Tania L.

Updated at October 30, 2025

gRPC request
UpdateClusterShardRequest
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
operation.Operation
UpdateClusterShardMetadata
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

Modifies the specified shard.

gRPC request

rpc UpdateShard (UpdateClusterShardRequest) returns (operation.Operation)

UpdateClusterShardRequest

{
  "cluster_id": "string",
  "shard_name": "string",
  "update_mask": "google.protobuf.FieldMask",
  "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"
      }
    }
  }
}

Field	Description
cluster_id	string Required field. ID of the ClickHouse cluster the shard belongs to. To get the cluster ID, use a ClusterService.List request.
shard_name	string Required field. Name of the shard to be updated. To get the name of a shard, use a ClusterService.ListShards request.
update_mask	google.protobuf.FieldMask Field mask that specifies which attributes of the ClickHouse shard should be updated.
config_spec	ShardConfigSpec New configuration for the specified shard.

ShardConfigSpec

Field

Description

clickhouse

Clickhouse

ClickHouse configuration for a shard.

Clickhouse

Field	Description
config	ClickhouseConfig ClickHouse settings for the shard.
resources	Resources Computational resources for the shard.
weight	google.protobuf.Int64Value Relative weight of the shard considered when writing data to the cluster. For details, see ClickHouse documentation.
disk_size_autoscaling	DiskSizeAutoscaling Disk size autoscaling settings.

ClickhouseConfig

ClickHouse configuration settings. Supported settings are a subset of settings described
in ClickHouse documentation.

Field	Description
background_pool_size	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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. 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	google.protobuf.Int64Value The maximum number of threads that will be used for constantly executing some lightweight periodic operations for replicated tables, Kafka streaming, and DNS cache updates. 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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. `LOG_LEVEL_UNSPECIFIED` `TRACE` `DEBUG` `INFORMATION` `WARNING` `ERROR`
query_log_retention_size	google.protobuf.Int64Value The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled. Default value: 1073741824 (1 GiB).
query_log_retention_time	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled. Default value: 536870912 (512 MiB).
query_thread_log_retention_time	google.protobuf.Int64Value The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled. Default value: 2592000000 (30 days).
part_log_retention_size	google.protobuf.Int64Value The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled. Default value: 536870912 (512 MiB).
part_log_retention_time	google.protobuf.Int64Value The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled. Default value: 2592000000 (30 days).
metric_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled. Default value: 536870912 (512 MiB).
metric_log_retention_time	google.protobuf.Int64Value The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled. Default value: 2592000000 (30 days).
trace_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled. Default value: 536870912 (512 MiB).
trace_log_retention_time	google.protobuf.Int64Value The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled. Default value: 2592000000 (30 days).
text_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled. Default value: 536870912 (512 MiB).
text_log_retention_time	google.protobuf.Int64Value The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled. 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. `LOG_LEVEL_UNSPECIFIED` `TRACE` `DEBUG` `INFORMATION` `WARNING` `ERROR`
opentelemetry_span_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0, automatic removal of opentelemetry_span_log data based on size is disabled. Default value: 0.
opentelemetry_span_log_retention_time	google.protobuf.Int64Value The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, automatic removal of opentelemetry_span_log data based on time is disabled. Default value: 2592000000 (30 days).
query_views_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that query_views_log can grow to before old data will be removed. If set to 0, automatic removal of query_views_log data based on size is disabled. Default value: 0.
query_views_log_retention_time	google.protobuf.Int64Value The maximum time that query_views_log records will be retained before removal. If set to 0, automatic removal of query_views_log data based on time is disabled. Default value: 2592000000 (30 days).
asynchronous_metric_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0, automatic removal of asynchronous_metric_log data based on size is disabled. Default value: 0.
asynchronous_metric_log_retention_time	google.protobuf.Int64Value The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, automatic removal of asynchronous_metric_log data based on time is disabled. Default value: 2592000000 (30 days).
session_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that session_log can grow to before old data will be removed. If set to 0, automatic removal of session_log data based on size is disabled. Default value: 536870912 (512 MiB) for versions 25.3 and higher, 0 for versions 25.2 and lower.
session_log_retention_time	google.protobuf.Int64Value The maximum time that session_log records will be retained before removal. If set to 0, automatic removal of session_log data based on time is disabled. Default value: 2592000000 (30 days).
zookeeper_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0, automatic removal of zookeeper_log data based on size is disabled. Default value: 0.
zookeeper_log_retention_time	google.protobuf.Int64Value The maximum time that zookeeper_log records will be retained before removal. If set to 0, automatic removal of zookeeper_log data based on time is disabled. Default value: 2592000000 (30 days).
asynchronous_insert_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0, automatic removal of asynchronous_insert_log data based on size is disabled. Default value: 0.
asynchronous_insert_log_retention_time	google.protobuf.Int64Value The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, automatic removal of asynchronous_insert_log data based on time is disabled. Default value: 2592000000 (30 days).
processors_profile_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that processors_profile_log can grow to before old data will be removed. If set to 0, automatic removal of processors_profile_log data based on size is disabled. Default value: 0.
processors_profile_log_retention_time	google.protobuf.Int64Value The maximum time that processors_profile_log records will be retained before removal. If set to 0, automatic removal of processors_profile_log data based on time is disabled. Default value: 2592000000 (30 days).
error_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that error_log can grow to before old data will be removed. If set to 0, automatic removal of error_log data based on size is disabled. Default value: 0.
error_log_retention_time	google.protobuf.Int64Value The maximum time that error_log records will be retained before removal. If set to 0, automatic removal of error_log data based on time is disabled. Default value: 2592000000 (30 days).
access_control_improvements	AccessControlImprovements Access control settings.
max_connections	google.protobuf.Int64Value Maximum number of inbound connections. Default value: 4096. Change of the setting is applied with restart. For details, see ClickHouse documentation.
max_concurrent_queries	google.protobuf.Int64Value Maximum number of concurrently executed queries. Default value: 500. For details, see ClickHouse documentation.
max_table_size_to_drop	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.StringValue The default database. Default value: default. Change of the setting is applied with restart. For details, see ClickHouse documentation.
total_memory_profiler_step	google.protobuf.Int64Value Whenever server memory usage becomes larger than every next step in number of bytes the memory profiler will collect the allocating stack trace. 0 means disabled memory profiler. Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation.
total_memory_tracker_sample_probability	google.protobuf.DoubleValue Allows to collect random allocations and de-allocations and writes them in the system.trace_log system table with trace_type equal to a MemorySample with the specified probability. Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation.
async_insert_threads	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	MergeTree Settings for the MergeTree table engine family. Change of the settings of merge_tree is applied with restart.
compression[]	Compression Data compression settings for MergeTree engine tables. Change of the settings of compression is applied with restart. For details, see ClickHouse documentation.
dictionaries[]	ExternalDictionary Configuration of external dictionaries. Change of the settings of dictionaries is applied with restart. For details, see ClickHouse documentation.
graphite_rollup[]	GraphiteRollup 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 Kafka integration settings. Change of the settings of kafka is applied with restart.
kafka_topics[]	KafkaTopic Per-topic Kafka integration settings. Change of the settings of kafka_topics is applied with restart.
rabbitmq	Rabbitmq RabbitMQ integration settings. Change of the settings of rabbitmq is applied with restart.
query_masking_rules[]	QueryMaskingRule Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, system.query_log, system.text_log, system.processes tables, and in logs sent to the client. That allows preventing sensitive data leakage from SQL queries (like names, emails, personal identifiers or credit card numbers) to logs. Change of the settings of query_masking_rules is applied with restart. For details, see ClickHouse documentation.
query_cache	QueryCache Query cache configuration. Change of the settings of query_cache is applied with restart.
jdbc_bridge	JdbcBridge 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	google.protobuf.BoolValue Enables or disables MySQL interface on ClickHouse server Default value: false. For details, see ClickHouse documentation.
custom_macros[]	Macro Custom ClickHouse macros.
builtin_dictionaries_reload_interval	google.protobuf.Int64Value 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

google.protobuf.BoolValue

Sets whether SELECT * FROM system.<table> requires any grants and can be executed by any user.
If set to true then this query requires GRANT SELECT ON system.<table> just as for non-system tables.

Default value: false.

select_from_information_schema_requires_grant

google.protobuf.BoolValue

Sets whether SELECT * FROM information_schema.<table> requires any grants and can be executed by any user.
If set to true, then this query requires GRANT SELECT ON information_schema.<table>, just as for ordinary tables.

Default value: false.

MergeTree

Settings for the MergeTree table engine family.

Field	Description
parts_to_delay_insert	google.protobuf.Int64Value 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	google.protobuf.Int64Value If the number of active parts in a single partition exceeds the parts_to_throw_insert value, an INSERT is interrupted with the error "Too many parts (N). Merges are processing significantly slower than inserts". 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	google.protobuf.Int64Value If the number of inactive parts in a single partition in the table exceeds the inactive_parts_to_delay_insert value, an INSERT is artificially slowed down. Default value: 0. For details, see ClickHouse documentation.
inactive_parts_to_throw_insert	google.protobuf.Int64Value If the number of inactive parts in a single partition more than the inactive_parts_to_throw_insert value, INSERT is interrupted with an error. Default value: 0. For details, see ClickHouse documentation.
max_avg_part_size_for_too_many_parts	google.protobuf.Int64Value 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, INSERT queries will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. Default value: 1073741824 (1 GiB). For details, see ClickHouse documentation.
max_parts_in_total	google.protobuf.Int64Value If the total number of active parts in all partitions of a table exceeds the max_parts_in_total value, an INSERT is interrupted with the error "Too many parts (N)". 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value When there is less than the specified number of free entries in pool (or replicated queue), start to lower maximum size of merge to process (or to put in queue). This is to allow small merges to process - not filling the pool with long running merges. Default value: 8. For details, see ClickHouse documentation.
number_of_free_entries_in_pool_to_execute_mutation	google.protobuf.Int64Value When there is less than specified number of free entries in pool, do not execute part mutations. This is to leave free threads for regular merges and to avoid "Too many parts" errors. Default value: 20. For details, see ClickHouse documentation.
max_bytes_to_merge_at_min_space_in_pool	google.protobuf.Int64Value 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	google.protobuf.Int64Value The maximum total parts size (in bytes) to be merged into one part, if there are enough resources available. Corresponds roughly to the maximum possible part size created by an automatic background merge. 0 means merges will be disabled. Default value: 161061273600 (150 GiB). For details, see ClickHouse documentation.
min_bytes_for_wide_part	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value Minimum period to clean old queue logs, blocks hashes and parts. Default value: 30. For details, see ClickHouse documentation.
max_cleanup_delay_period	google.protobuf.Int64Value 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	google.protobuf.Int64Value Minimum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to Keeper in large-scale clusters. Default value: 5000 (5 seconds). For details, see ClickHouse documentation.
max_merge_selecting_sleep_ms	google.protobuf.Int64Value Maximum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to Keeper in large-scale clusters. Default value: 60000 (1 minute). For details, see ClickHouse documentation.
min_age_to_force_merge_seconds	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.Int64Value 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. `DEDUPLICATE_MERGE_PROJECTION_MODE_UNSPECIFIED` `DEDUPLICATE_MERGE_PROJECTION_MODE_IGNORE` `DEDUPLICATE_MERGE_PROJECTION_MODE_THROW` `DEDUPLICATE_MERGE_PROJECTION_MODE_DROP` `DEDUPLICATE_MERGE_PROJECTION_MODE_REBUILD`
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. `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_UNSPECIFIED` `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_THROW` `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_DROP` `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_REBUILD`
replicated_deduplication_window	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.BoolValue 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue Controls whether data parts are fully dropped in MergeTree tables when all rows in that part have expired according to their TTL settings. true - the entire part is dropped if all rows in that part have expired according to their TTL settings. false - only the rows that have expired based on their TTL settings are removed. Default value: false. For details, see ClickHouse documentation.
merge_with_ttl_timeout	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value When there is more than specified number of merges with TTL entries in pool, do not assign new merge with TTL. This is to leave free threads for regular merges and avoid "Too many parts" errors. Default value: 2. For details, see ClickHouse documentation.
materialize_ttl_recalculate_only	google.protobuf.BoolValue 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	google.protobuf.BoolValue Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. Default value: true. For details, see ClickHouse documentation.
allow_remote_fs_zero_copy_replication	google.protobuf.BoolValue Setting is automatically enabled if cloud storage is enabled, disabled otherwise. Default value: true.

Compression

Compression settings.
For details, see ClickHouse documentation.

Field	Description
method	enum Method Required field. Compression method to use for the specified combination of min_part_size and min_part_size_ratio. `METHOD_UNSPECIFIED` `LZ4`: LZ4 compression algorithm. `ZSTD`: ZSTD compression algorithm. `LZ4HC`: LZ4 HC (high compression) algorithm.
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	google.protobuf.Int64Value Compression level.

ExternalDictionary

External dictionary configuration.

Field	Description
name	string Required field. Name of the external dictionary.
structure	Structure Required field. Structure of the external dictionary.
layout	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 `fixed_lifetime`, `lifetime_range`.
lifetime_range	Range Range of intervals between dictionary updates for ClickHouse to choose from. Includes only one of the fields `fixed_lifetime`, `lifetime_range`.
http_source	HttpSource HTTP source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
mysql_source	MysqlSource MySQL source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
clickhouse_source	ClickhouseSource ClickHouse source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
mongodb_source	MongodbSource MongoDB source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
postgresql_source	PostgresqlSource PostgreSQL source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.

Structure

Configuration of external dictionary structure.

Field	Description
id	Id Single numeric key column for the dictionary.
key	Key Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.
range_min	Attribute Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.
range_max	Attribute Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.
attributes[]	Attribute Description of the fields available for database queries. For details, see ClickHouse documentation.

Id

Numeric key.

Field

Description

name

string

Required field. Name of the numeric key.

Key

Complex key.

Field

Description

attributes[]

Attribute

Attributes of a complex key.

Attribute

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.

Layout

Field	Description
type	enum Type Required field. Layout type. For details, see ClickHouse documentation. `TYPE_UNSPECIFIED` `FLAT`: The dictionary is completely stored in memory in the form of flat arrays. Applicable only for dictionaries with numeric keys of the UInt64 type. `HASHED`: The dictionary is completely stored in memory in the form of a hash table. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_HASHED`: The dictionary is completely stored in memory in the form of a hash table. Applicable for dictionaries with composite keys of arbitrary type. `RANGE_HASHED`: The dictionary is stored in memory in the form of a hash table with an ordered array of ranges and their corresponding values. Applicable only for dictionaries with numeric keys of the UInt64 type. `CACHE`: The dictionary is stored in a cache that has a fixed number of cells. These cells contain frequently used elements. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_CACHE`: The dictionary is stored in a cache that has a fixed number of cells. These cells contain frequently used elements. Applicable for dictionaries with composite keys of arbitrary type. `SPARSE_HASHED`: The dictionary is completely stored in memory in the form of a hash table. It's similar to HASHED layout type but uses less memory in favor of more CPU usage. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_SPARSE_HASHED`: The dictionary is completely stored in memory in the form of a hash table. It's similar to COMPLEX_KEY_HASHED layout type but uses less memory in favor of more CPU usage. Applicable for dictionaries with composite keys of arbitrary type. `COMPLEX_KEY_RANGE_HASHED`: The dictionary is stored in memory in the form of a hash table with an ordered array of ranges and their corresponding values. Applicable for dictionaries with composite keys of arbitrary type. `DIRECT`: The dictionary is not stored in memory and directly goes to the source during the processing of a request. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_DIRECT`: The dictionary is not stored in memory and directly goes to the source during the processing of a request. Applicable for dictionaries with composite keys of arbitrary type. `IP_TRIE`: The specialized layout type for mapping network prefixes (IP addresses) to metadata such as ASN.
size_in_cells	int64 Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 1000000000. For details, see ClickHouse documentation.
allow_read_expired_keys	google.protobuf.BoolValue Allows to read expired keys. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: false. For details, see ClickHouse documentation.
max_update_queue_size	int64 Max size of update queue. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 100000. For details, see ClickHouse documentation.
update_queue_push_timeout_milliseconds	int64 Max timeout in milliseconds for push update task into queue. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 10. For details, see ClickHouse documentation.
query_wait_timeout_milliseconds	int64 Max wait timeout in milliseconds for update task to complete. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 60000 (1 minute). For details, see ClickHouse documentation.
max_threads_for_updates	int64 Max threads for cache dictionary update. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 4. For details, see ClickHouse documentation.
initial_array_size	int64 Initial dictionary key size. Applicable only for FLAT layout type. Default value: 1024. For details, see ClickHouse documentation.
max_array_size	int64 Maximum dictionary key size. Applicable only for FLAT layout type. Default value: 500000. For details, see ClickHouse documentation.
access_to_key_from_attributes	google.protobuf.BoolValue Allows to retrieve key attribute using dictGetString function. Enabling this option increases memory usage. Applicable only for IP_TRIE layout type. For details, see ClickHouse documentation.

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[]	Header HTTP headers.

Field

Description

name

string

Required field. Header name.

value

string

Required field. Header value.

MysqlSource

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[]	Replica 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	google.protobuf.BoolValue Should a connection be closed after each request.
share_connection	google.protobuf.BoolValue Should a connection be shared for some requests.

Replica

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. Replica with the highest priority should have this field set to the lowest number.
port	int64 Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source.
user	string Name of the MySQL database user. If a user is not specified for a replica, ClickHouse uses the user specified for the source.
password	string Password of the MySQL database user. If a password is not specified for a replica, ClickHouse uses the password specified for the source.

ClickhouseSource

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	google.protobuf.BoolValue Determines whether to use TLS for connection.

MongodbSource

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.

PostgresqlSource

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. `SSL_MODE_UNSPECIFIED` `DISABLE`: Only try a non-SSL connection. `ALLOW`: First try a non-SSL connection; if that fails, try an SSL connection. `PREFER`: First try an SSL connection; if that fails, try a non-SSL connection. `VERIFY_CA`: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA). `VERIFY_FULL`: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.

GraphiteRollup

Rollup settings for the GraphiteMergeTree table engine.
For details, see ClickHouse documentation.

Field	Description
name	string Required field. Name for the specified combination of settings for Graphite rollup.
patterns[]	Pattern 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.

Pattern

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]. Accepted functions: min, max, any, avg. The average is calculated imprecisely, like the average of the averages.
retention[]	Retention Retention rules.

Retention

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

Kafka configuration settings.
For details, see librdkafka documentation.

Field	Description
security_protocol	enum SecurityProtocol Protocol used to communicate with brokers. Default value: SECURITY_PROTOCOL_PLAINTEXT. `SECURITY_PROTOCOL_UNSPECIFIED` `SECURITY_PROTOCOL_PLAINTEXT` `SECURITY_PROTOCOL_SSL` `SECURITY_PROTOCOL_SASL_PLAINTEXT` `SECURITY_PROTOCOL_SASL_SSL`
sasl_mechanism	enum SaslMechanism SASL mechanism to use for authentication. Default value: SASL_MECHANISM_GSSAPI. `SASL_MECHANISM_UNSPECIFIED` `SASL_MECHANISM_GSSAPI` `SASL_MECHANISM_PLAIN` `SASL_MECHANISM_SCRAM_SHA_256` `SASL_MECHANISM_SCRAM_SHA_512`
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	google.protobuf.BoolValue Enable OpenSSL's builtin broker (server) certificate verification. Default value: true.
max_poll_interval_ms	google.protobuf.Int64Value Maximum allowed time between calls to consume messages for high-level consumers. If this interval is exceeded the consumer is considered failed and the group will rebalance in order to reassign the partitions to another consumer group member. Default value: 300000 (5 minutes).
session_timeout_ms	google.protobuf.Int64Value Client group session and failure detection timeout. The consumer sends periodic heartbeats (heartbeat.interval.ms) to indicate its liveness to the broker. If no hearts are received by the broker for a group member within the session timeout, the broker will remove the consumer from the group and trigger a rebalance. Default value: 45000 (45 seconds).
debug	enum Debug Debug context to enable. `DEBUG_UNSPECIFIED` `DEBUG_GENERIC` `DEBUG_BROKER` `DEBUG_TOPIC` `DEBUG_METADATA` `DEBUG_FEATURE` `DEBUG_QUEUE` `DEBUG_MSG` `DEBUG_PROTOCOL` `DEBUG_CGRP` `DEBUG_SECURITY` `DEBUG_FETCH` `DEBUG_INTERCEPTOR` `DEBUG_PLUGIN` `DEBUG_CONSUMER` `DEBUG_ADMIN` `DEBUG_EOS` `DEBUG_MOCK` `DEBUG_ASSIGNOR` `DEBUG_CONF` `DEBUG_TELEMETRY` `DEBUG_ALL`
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. `AUTO_OFFSET_RESET_UNSPECIFIED` `AUTO_OFFSET_RESET_SMALLEST` `AUTO_OFFSET_RESET_EARLIEST` `AUTO_OFFSET_RESET_BEGINNING` `AUTO_OFFSET_RESET_LARGEST` `AUTO_OFFSET_RESET_LATEST` `AUTO_OFFSET_RESET_END` `AUTO_OFFSET_RESET_ERROR`

KafkaTopic

Field

Description

name

string

Required field. Kafka topic name.

settings

Kafka

Required field. Kafka topic settings.

Rabbitmq

RabbitMQ integration settings.
For details, see ClickHouse documentation.

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. Default value: six asterisks.

QueryCache

Query cache configuration.

Field	Description
max_size_in_bytes	google.protobuf.Int64Value The maximum cache size in bytes. Default value: 1073741824 (1 GiB).
max_entries	google.protobuf.Int64Value The maximum number of SELECT query results stored in the cache. Default value: 1024.
max_entry_size_in_bytes	google.protobuf.Int64Value 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	google.protobuf.Int64Value The maximum number of rows SELECT query results may have to be saved in the cache. Default value: 30000000.

JdbcBridge

JDBC bridge configuration for queries to external databases.

Field

Description

host

string

Host of jdbc bridge.

port

google.protobuf.Int64Value

Port of jdbc bridge.

Default value: 9019.

Macro

ClickHouse macro.

Field

Description

name

string

Required field. Name of the macro.

value

string

Required field. Value of the macro.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation
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. Possible values: network-hdd - network HDD drive, network-ssd - network SSD drive, local-ssd - local SSD storage.

DiskSizeAutoscaling

Field	Description
planned_usage_threshold	google.protobuf.Int64Value Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.
emergency_usage_threshold	google.protobuf.Int64Value Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.
disk_size_limit	google.protobuf.Int64Value Limit on how large the storage for database instances can automatically grow, in bytes.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string",
    "shard_name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "name": "string",
    "cluster_id": "string",
    "config": {
      "clickhouse": {
        "config": {
          "effective_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"
          },
          "user_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"
          },
          "default_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"
        }
      }
    }
  }
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdateClusterShardMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Shard The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateClusterShardMetadata

Field

Description

cluster_id

string

ID of the cluster that contains the shard being updated.

shard_name

string

Name of the shard being updated.

Shard

Field	Description
name	string Name of the shard.
cluster_id	string ID of the cluster that the shard belongs to.
config	ShardConfig Configuration of the shard.

ShardConfig

Field

Description

clickhouse

Clickhouse

ClickHouse configuration for a shard.

Clickhouse

Field	Description
config	ClickhouseConfigSet ClickHouse settings for a shard.
resources	Resources Computational resources for a shard.
weight	google.protobuf.Int64Value Relative weight of a shard considered when writing data to the cluster. For details, see ClickHouse documentation.
disk_size_autoscaling	DiskSizeAutoscaling Disk size autoscaling settings.

ClickhouseConfigSet

Field	Description
effective_config	ClickhouseConfig Required field. Effective configuration (a combination of user-defined configuration and default configuration).
user_config	ClickhouseConfig Required field. User-defined configuration.
default_config	ClickhouseConfig Required field. Default configuration.

ClickhouseConfig

ClickHouse configuration settings. Supported settings are a subset of settings described
in ClickHouse documentation.

Field	Description
background_pool_size	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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. 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	google.protobuf.Int64Value The maximum number of threads that will be used for constantly executing some lightweight periodic operations for replicated tables, Kafka streaming, and DNS cache updates. 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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. `LOG_LEVEL_UNSPECIFIED` `TRACE` `DEBUG` `INFORMATION` `WARNING` `ERROR`
query_log_retention_size	google.protobuf.Int64Value The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled. Default value: 1073741824 (1 GiB).
query_log_retention_time	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled. Default value: 536870912 (512 MiB).
query_thread_log_retention_time	google.protobuf.Int64Value The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled. Default value: 2592000000 (30 days).
part_log_retention_size	google.protobuf.Int64Value The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled. Default value: 536870912 (512 MiB).
part_log_retention_time	google.protobuf.Int64Value The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled. Default value: 2592000000 (30 days).
metric_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled. Default value: 536870912 (512 MiB).
metric_log_retention_time	google.protobuf.Int64Value The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled. Default value: 2592000000 (30 days).
trace_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled. Default value: 536870912 (512 MiB).
trace_log_retention_time	google.protobuf.Int64Value The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled. Default value: 2592000000 (30 days).
text_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled. Default value: 536870912 (512 MiB).
text_log_retention_time	google.protobuf.Int64Value The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled. 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. `LOG_LEVEL_UNSPECIFIED` `TRACE` `DEBUG` `INFORMATION` `WARNING` `ERROR`
opentelemetry_span_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0, automatic removal of opentelemetry_span_log data based on size is disabled. Default value: 0.
opentelemetry_span_log_retention_time	google.protobuf.Int64Value The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, automatic removal of opentelemetry_span_log data based on time is disabled. Default value: 2592000000 (30 days).
query_views_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that query_views_log can grow to before old data will be removed. If set to 0, automatic removal of query_views_log data based on size is disabled. Default value: 0.
query_views_log_retention_time	google.protobuf.Int64Value The maximum time that query_views_log records will be retained before removal. If set to 0, automatic removal of query_views_log data based on time is disabled. Default value: 2592000000 (30 days).
asynchronous_metric_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0, automatic removal of asynchronous_metric_log data based on size is disabled. Default value: 0.
asynchronous_metric_log_retention_time	google.protobuf.Int64Value The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, automatic removal of asynchronous_metric_log data based on time is disabled. Default value: 2592000000 (30 days).
session_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that session_log can grow to before old data will be removed. If set to 0, automatic removal of session_log data based on size is disabled. Default value: 536870912 (512 MiB) for versions 25.3 and higher, 0 for versions 25.2 and lower.
session_log_retention_time	google.protobuf.Int64Value The maximum time that session_log records will be retained before removal. If set to 0, automatic removal of session_log data based on time is disabled. Default value: 2592000000 (30 days).
zookeeper_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0, automatic removal of zookeeper_log data based on size is disabled. Default value: 0.
zookeeper_log_retention_time	google.protobuf.Int64Value The maximum time that zookeeper_log records will be retained before removal. If set to 0, automatic removal of zookeeper_log data based on time is disabled. Default value: 2592000000 (30 days).
asynchronous_insert_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0, automatic removal of asynchronous_insert_log data based on size is disabled. Default value: 0.
asynchronous_insert_log_retention_time	google.protobuf.Int64Value The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, automatic removal of asynchronous_insert_log data based on time is disabled. Default value: 2592000000 (30 days).
processors_profile_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that processors_profile_log can grow to before old data will be removed. If set to 0, automatic removal of processors_profile_log data based on size is disabled. Default value: 0.
processors_profile_log_retention_time	google.protobuf.Int64Value The maximum time that processors_profile_log records will be retained before removal. If set to 0, automatic removal of processors_profile_log data based on time is disabled. Default value: 2592000000 (30 days).
error_log_enabled	google.protobuf.BoolValue 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	google.protobuf.Int64Value The maximum size that error_log can grow to before old data will be removed. If set to 0, automatic removal of error_log data based on size is disabled. Default value: 0.
error_log_retention_time	google.protobuf.Int64Value The maximum time that error_log records will be retained before removal. If set to 0, automatic removal of error_log data based on time is disabled. Default value: 2592000000 (30 days).
access_control_improvements	AccessControlImprovements Access control settings.
max_connections	google.protobuf.Int64Value Maximum number of inbound connections. Default value: 4096. Change of the setting is applied with restart. For details, see ClickHouse documentation.
max_concurrent_queries	google.protobuf.Int64Value Maximum number of concurrently executed queries. Default value: 500. For details, see ClickHouse documentation.
max_table_size_to_drop	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.StringValue The default database. Default value: default. Change of the setting is applied with restart. For details, see ClickHouse documentation.
total_memory_profiler_step	google.protobuf.Int64Value Whenever server memory usage becomes larger than every next step in number of bytes the memory profiler will collect the allocating stack trace. 0 means disabled memory profiler. Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation.
total_memory_tracker_sample_probability	google.protobuf.DoubleValue Allows to collect random allocations and de-allocations and writes them in the system.trace_log system table with trace_type equal to a MemorySample with the specified probability. Default value: 0. Change of the setting is applied with restart. For details, see ClickHouse documentation.
async_insert_threads	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	MergeTree Settings for the MergeTree table engine family. Change of the settings of merge_tree is applied with restart.
compression[]	Compression Data compression settings for MergeTree engine tables. Change of the settings of compression is applied with restart. For details, see ClickHouse documentation.
dictionaries[]	ExternalDictionary Configuration of external dictionaries. Change of the settings of dictionaries is applied with restart. For details, see ClickHouse documentation.
graphite_rollup[]	GraphiteRollup 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 Kafka integration settings. Change of the settings of kafka is applied with restart.
kafka_topics[]	KafkaTopic Per-topic Kafka integration settings. Change of the settings of kafka_topics is applied with restart.
rabbitmq	Rabbitmq RabbitMQ integration settings. Change of the settings of rabbitmq is applied with restart.
query_masking_rules[]	QueryMaskingRule Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs, system.query_log, system.text_log, system.processes tables, and in logs sent to the client. That allows preventing sensitive data leakage from SQL queries (like names, emails, personal identifiers or credit card numbers) to logs. Change of the settings of query_masking_rules is applied with restart. For details, see ClickHouse documentation.
query_cache	QueryCache Query cache configuration. Change of the settings of query_cache is applied with restart.
jdbc_bridge	JdbcBridge 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	google.protobuf.BoolValue Enables or disables MySQL interface on ClickHouse server Default value: false. For details, see ClickHouse documentation.
custom_macros[]	Macro Custom ClickHouse macros.
builtin_dictionaries_reload_interval	google.protobuf.Int64Value 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

google.protobuf.BoolValue

Default value: false.

select_from_information_schema_requires_grant

google.protobuf.BoolValue

Default value: false.

MergeTree

Settings for the MergeTree table engine family.

Field	Description
parts_to_delay_insert	google.protobuf.Int64Value 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	google.protobuf.Int64Value If the number of active parts in a single partition exceeds the parts_to_throw_insert value, an INSERT is interrupted with the error "Too many parts (N). Merges are processing significantly slower than inserts". 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	google.protobuf.Int64Value If the number of inactive parts in a single partition in the table exceeds the inactive_parts_to_delay_insert value, an INSERT is artificially slowed down. Default value: 0. For details, see ClickHouse documentation.
inactive_parts_to_throw_insert	google.protobuf.Int64Value If the number of inactive parts in a single partition more than the inactive_parts_to_throw_insert value, INSERT is interrupted with an error. Default value: 0. For details, see ClickHouse documentation.
max_avg_part_size_for_too_many_parts	google.protobuf.Int64Value 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, INSERT queries will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. Default value: 1073741824 (1 GiB). For details, see ClickHouse documentation.
max_parts_in_total	google.protobuf.Int64Value If the total number of active parts in all partitions of a table exceeds the max_parts_in_total value, an INSERT is interrupted with the error "Too many parts (N)". 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value When there is less than the specified number of free entries in pool (or replicated queue), start to lower maximum size of merge to process (or to put in queue). This is to allow small merges to process - not filling the pool with long running merges. Default value: 8. For details, see ClickHouse documentation.
number_of_free_entries_in_pool_to_execute_mutation	google.protobuf.Int64Value When there is less than specified number of free entries in pool, do not execute part mutations. This is to leave free threads for regular merges and to avoid "Too many parts" errors. Default value: 20. For details, see ClickHouse documentation.
max_bytes_to_merge_at_min_space_in_pool	google.protobuf.Int64Value 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	google.protobuf.Int64Value The maximum total parts size (in bytes) to be merged into one part, if there are enough resources available. Corresponds roughly to the maximum possible part size created by an automatic background merge. 0 means merges will be disabled. Default value: 161061273600 (150 GiB). For details, see ClickHouse documentation.
min_bytes_for_wide_part	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value Minimum period to clean old queue logs, blocks hashes and parts. Default value: 30. For details, see ClickHouse documentation.
max_cleanup_delay_period	google.protobuf.Int64Value 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	google.protobuf.Int64Value Minimum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to Keeper in large-scale clusters. Default value: 5000 (5 seconds). For details, see ClickHouse documentation.
max_merge_selecting_sleep_ms	google.protobuf.Int64Value Maximum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to Keeper in large-scale clusters. Default value: 60000 (1 minute). For details, see ClickHouse documentation.
min_age_to_force_merge_seconds	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.Int64Value 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. `DEDUPLICATE_MERGE_PROJECTION_MODE_UNSPECIFIED` `DEDUPLICATE_MERGE_PROJECTION_MODE_IGNORE` `DEDUPLICATE_MERGE_PROJECTION_MODE_THROW` `DEDUPLICATE_MERGE_PROJECTION_MODE_DROP` `DEDUPLICATE_MERGE_PROJECTION_MODE_REBUILD`
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. `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_UNSPECIFIED` `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_THROW` `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_DROP` `LIGHTWEIGHT_MUTATION_PROJECTION_MODE_REBUILD`
replicated_deduplication_window	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue 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	google.protobuf.BoolValue 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.BoolValue Controls whether data parts are fully dropped in MergeTree tables when all rows in that part have expired according to their TTL settings. true - the entire part is dropped if all rows in that part have expired according to their TTL settings. false - only the rows that have expired based on their TTL settings are removed. Default value: false. For details, see ClickHouse documentation.
merge_with_ttl_timeout	google.protobuf.Int64Value 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	google.protobuf.Int64Value 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	google.protobuf.Int64Value When there is more than specified number of merges with TTL entries in pool, do not assign new merge with TTL. This is to leave free threads for regular merges and avoid "Too many parts" errors. Default value: 2. For details, see ClickHouse documentation.
materialize_ttl_recalculate_only	google.protobuf.BoolValue 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	google.protobuf.BoolValue Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. Default value: true. For details, see ClickHouse documentation.
allow_remote_fs_zero_copy_replication	google.protobuf.BoolValue Setting is automatically enabled if cloud storage is enabled, disabled otherwise. Default value: true.

Compression

Compression settings.
For details, see ClickHouse documentation.

Field	Description
method	enum Method Required field. Compression method to use for the specified combination of min_part_size and min_part_size_ratio. `METHOD_UNSPECIFIED` `LZ4`: LZ4 compression algorithm. `ZSTD`: ZSTD compression algorithm. `LZ4HC`: LZ4 HC (high compression) algorithm.
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	google.protobuf.Int64Value Compression level.

ExternalDictionary

External dictionary configuration.

Field	Description
name	string Required field. Name of the external dictionary.
structure	Structure Required field. Structure of the external dictionary.
layout	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 `fixed_lifetime`, `lifetime_range`.
lifetime_range	Range Range of intervals between dictionary updates for ClickHouse to choose from. Includes only one of the fields `fixed_lifetime`, `lifetime_range`.
http_source	HttpSource HTTP source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
mysql_source	MysqlSource MySQL source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
clickhouse_source	ClickhouseSource ClickHouse source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
mongodb_source	MongodbSource MongoDB source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.
postgresql_source	PostgresqlSource PostgreSQL source for the dictionary. Includes only one of the fields `http_source`, `mysql_source`, `clickhouse_source`, `mongodb_source`, `postgresql_source`.

Structure

Configuration of external dictionary structure.

Field	Description
id	Id Single numeric key column for the dictionary.
key	Key Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.
range_min	Attribute Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.
range_max	Attribute Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.
attributes[]	Attribute Description of the fields available for database queries. For details, see ClickHouse documentation.

Id

Numeric key.

Field

Description

name

string

Required field. Name of the numeric key.

Key

Complex key.

Field

Description

attributes[]

Attribute

Attributes of a complex key.

Attribute

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.

Layout

Field	Description
type	enum Type Required field. Layout type. For details, see ClickHouse documentation. `TYPE_UNSPECIFIED` `FLAT`: The dictionary is completely stored in memory in the form of flat arrays. Applicable only for dictionaries with numeric keys of the UInt64 type. `HASHED`: The dictionary is completely stored in memory in the form of a hash table. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_HASHED`: The dictionary is completely stored in memory in the form of a hash table. Applicable for dictionaries with composite keys of arbitrary type. `RANGE_HASHED`: The dictionary is stored in memory in the form of a hash table with an ordered array of ranges and their corresponding values. Applicable only for dictionaries with numeric keys of the UInt64 type. `CACHE`: The dictionary is stored in a cache that has a fixed number of cells. These cells contain frequently used elements. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_CACHE`: The dictionary is stored in a cache that has a fixed number of cells. These cells contain frequently used elements. Applicable for dictionaries with composite keys of arbitrary type. `SPARSE_HASHED`: The dictionary is completely stored in memory in the form of a hash table. It's similar to HASHED layout type but uses less memory in favor of more CPU usage. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_SPARSE_HASHED`: The dictionary is completely stored in memory in the form of a hash table. It's similar to COMPLEX_KEY_HASHED layout type but uses less memory in favor of more CPU usage. Applicable for dictionaries with composite keys of arbitrary type. `COMPLEX_KEY_RANGE_HASHED`: The dictionary is stored in memory in the form of a hash table with an ordered array of ranges and their corresponding values. Applicable for dictionaries with composite keys of arbitrary type. `DIRECT`: The dictionary is not stored in memory and directly goes to the source during the processing of a request. Applicable only for dictionaries with numeric keys of the UInt64 type. `COMPLEX_KEY_DIRECT`: The dictionary is not stored in memory and directly goes to the source during the processing of a request. Applicable for dictionaries with composite keys of arbitrary type. `IP_TRIE`: The specialized layout type for mapping network prefixes (IP addresses) to metadata such as ASN.
size_in_cells	int64 Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 1000000000. For details, see ClickHouse documentation.
allow_read_expired_keys	google.protobuf.BoolValue Allows to read expired keys. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: false. For details, see ClickHouse documentation.
max_update_queue_size	int64 Max size of update queue. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 100000. For details, see ClickHouse documentation.
update_queue_push_timeout_milliseconds	int64 Max timeout in milliseconds for push update task into queue. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 10. For details, see ClickHouse documentation.
query_wait_timeout_milliseconds	int64 Max wait timeout in milliseconds for update task to complete. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 60000 (1 minute). For details, see ClickHouse documentation.
max_threads_for_updates	int64 Max threads for cache dictionary update. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types. Default value: 4. For details, see ClickHouse documentation.
initial_array_size	int64 Initial dictionary key size. Applicable only for FLAT layout type. Default value: 1024. For details, see ClickHouse documentation.
max_array_size	int64 Maximum dictionary key size. Applicable only for FLAT layout type. Default value: 500000. For details, see ClickHouse documentation.
access_to_key_from_attributes	google.protobuf.BoolValue Allows to retrieve key attribute using dictGetString function. Enabling this option increases memory usage. Applicable only for IP_TRIE layout type. For details, see ClickHouse documentation.

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[]	Header HTTP headers.

Header

Field

Description

name

string

Required field. Header name.

value

string

Required field. Header value.

MysqlSource

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[]	Replica 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	google.protobuf.BoolValue Should a connection be closed after each request.
share_connection	google.protobuf.BoolValue Should a connection be shared for some requests.

Replica

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. Replica with the highest priority should have this field set to the lowest number.
port	int64 Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source.
user	string Name of the MySQL database user. If a user is not specified for a replica, ClickHouse uses the user specified for the source.
password	string Password of the MySQL database user. If a password is not specified for a replica, ClickHouse uses the password specified for the source.

ClickhouseSource

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	google.protobuf.BoolValue Determines whether to use TLS for connection.

MongodbSource

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.

PostgresqlSource

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. `SSL_MODE_UNSPECIFIED` `DISABLE`: Only try a non-SSL connection. `ALLOW`: First try a non-SSL connection; if that fails, try an SSL connection. `PREFER`: First try an SSL connection; if that fails, try a non-SSL connection. `VERIFY_CA`: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA). `VERIFY_FULL`: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.

GraphiteRollup

Rollup settings for the GraphiteMergeTree table engine.
For details, see ClickHouse documentation.

Field	Description
name	string Required field. Name for the specified combination of settings for Graphite rollup.
patterns[]	Pattern 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.

Pattern

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]. Accepted functions: min, max, any, avg. The average is calculated imprecisely, like the average of the averages.
retention[]	Retention Retention rules.

Retention

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

Kafka configuration settings.
For details, see librdkafka documentation.

Field	Description
security_protocol	enum SecurityProtocol Protocol used to communicate with brokers. Default value: SECURITY_PROTOCOL_PLAINTEXT. `SECURITY_PROTOCOL_UNSPECIFIED` `SECURITY_PROTOCOL_PLAINTEXT` `SECURITY_PROTOCOL_SSL` `SECURITY_PROTOCOL_SASL_PLAINTEXT` `SECURITY_PROTOCOL_SASL_SSL`
sasl_mechanism	enum SaslMechanism SASL mechanism to use for authentication. Default value: SASL_MECHANISM_GSSAPI. `SASL_MECHANISM_UNSPECIFIED` `SASL_MECHANISM_GSSAPI` `SASL_MECHANISM_PLAIN` `SASL_MECHANISM_SCRAM_SHA_256` `SASL_MECHANISM_SCRAM_SHA_512`
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	google.protobuf.BoolValue Enable OpenSSL's builtin broker (server) certificate verification. Default value: true.
max_poll_interval_ms	google.protobuf.Int64Value Maximum allowed time between calls to consume messages for high-level consumers. If this interval is exceeded the consumer is considered failed and the group will rebalance in order to reassign the partitions to another consumer group member. Default value: 300000 (5 minutes).
session_timeout_ms	google.protobuf.Int64Value Client group session and failure detection timeout. The consumer sends periodic heartbeats (heartbeat.interval.ms) to indicate its liveness to the broker. If no hearts are received by the broker for a group member within the session timeout, the broker will remove the consumer from the group and trigger a rebalance. Default value: 45000 (45 seconds).
debug	enum Debug Debug context to enable. `DEBUG_UNSPECIFIED` `DEBUG_GENERIC` `DEBUG_BROKER` `DEBUG_TOPIC` `DEBUG_METADATA` `DEBUG_FEATURE` `DEBUG_QUEUE` `DEBUG_MSG` `DEBUG_PROTOCOL` `DEBUG_CGRP` `DEBUG_SECURITY` `DEBUG_FETCH` `DEBUG_INTERCEPTOR` `DEBUG_PLUGIN` `DEBUG_CONSUMER` `DEBUG_ADMIN` `DEBUG_EOS` `DEBUG_MOCK` `DEBUG_ASSIGNOR` `DEBUG_CONF` `DEBUG_TELEMETRY` `DEBUG_ALL`
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. `AUTO_OFFSET_RESET_UNSPECIFIED` `AUTO_OFFSET_RESET_SMALLEST` `AUTO_OFFSET_RESET_EARLIEST` `AUTO_OFFSET_RESET_BEGINNING` `AUTO_OFFSET_RESET_LARGEST` `AUTO_OFFSET_RESET_LATEST` `AUTO_OFFSET_RESET_END` `AUTO_OFFSET_RESET_ERROR`

KafkaTopic

Field

Description

name

string

Required field. Kafka topic name.

settings

Kafka

Required field. Kafka topic settings.

Rabbitmq

RabbitMQ integration settings.
For details, see ClickHouse documentation.

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. Default value: six asterisks.

QueryCache

Query cache configuration.

Field	Description
max_size_in_bytes	google.protobuf.Int64Value The maximum cache size in bytes. Default value: 1073741824 (1 GiB).
max_entries	google.protobuf.Int64Value The maximum number of SELECT query results stored in the cache. Default value: 1024.
max_entry_size_in_bytes	google.protobuf.Int64Value 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	google.protobuf.Int64Value The maximum number of rows SELECT query results may have to be saved in the cache. Default value: 30000000.

JdbcBridge

JDBC bridge configuration for queries to external databases.

Field

Description

host

string

Host of jdbc bridge.

port

google.protobuf.Int64Value

Port of jdbc bridge.

Default value: 9019.

Macro

ClickHouse macro.

Field

Description

name

string

Required field. Name of the macro.

value

string

Required field. Value of the macro.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation
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. Possible values: network-hdd - network HDD drive, network-ssd - network SSD drive, local-ssd - local SSD storage.

DiskSizeAutoscaling

Field	Description
planned_usage_threshold	google.protobuf.Int64Value Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.
emergency_usage_threshold	google.protobuf.Int64Value Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.
disk_size_limit	google.protobuf.Int64Value Limit on how large the storage for database instances can automatically grow, in bytes.

Managed Service for ClickHouse API, gRPC: ClusterService.UpdateShard

gRPC requestgRPC request

UpdateClusterShardRequestUpdateClusterShardRequest

ShardConfigSpecShardConfigSpec

ClickhouseClickhouse

ClickhouseConfigClickhouseConfig

AccessControlImprovementsAccessControlImprovements

MergeTreeMergeTree

CompressionCompression

ExternalDictionaryExternalDictionary

StructureStructure

IdId

KeyKey

AttributeAttribute

LayoutLayout

RangeRange

HttpSourceHttpSource

HeaderHeader

MysqlSourceMysqlSource

ReplicaReplica

ClickhouseSourceClickhouseSource

MongodbSourceMongodbSource

PostgresqlSourcePostgresqlSource

GraphiteRollupGraphiteRollup

PatternPattern

RetentionRetention

KafkaKafka

KafkaTopicKafkaTopic

RabbitmqRabbitmq

QueryMaskingRuleQueryMaskingRule

QueryCacheQueryCache

JdbcBridgeJdbcBridge

MacroMacro

ResourcesResources

DiskSizeAutoscalingDiskSizeAutoscaling

operation.Operationoperation.Operation

UpdateClusterShardMetadataUpdateClusterShardMetadata

ShardShard

ShardConfigShardConfig

ClickhouseClickhouse

ClickhouseConfigSetClickhouseConfigSet

ClickhouseConfigClickhouseConfig

AccessControlImprovementsAccessControlImprovements

MergeTreeMergeTree

CompressionCompression

ExternalDictionaryExternalDictionary

StructureStructure

IdId

KeyKey

AttributeAttribute

LayoutLayout

RangeRange

HttpSourceHttpSource

HeaderHeader

MysqlSourceMysqlSource

ReplicaReplica

ClickhouseSourceClickhouseSource

MongodbSourceMongodbSource

PostgresqlSourcePostgresqlSource

GraphiteRollupGraphiteRollup

PatternPattern

RetentionRetention

KafkaKafka

KafkaTopicKafkaTopic

RabbitmqRabbitmq

QueryMaskingRuleQueryMaskingRule

QueryCacheQueryCache

JdbcBridgeJdbcBridge

MacroMacro

ResourcesResources

DiskSizeAutoscalingDiskSizeAutoscaling

Was the article helpful?

gRPC request

UpdateClusterShardRequest

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

operation.Operation

UpdateClusterShardMetadata

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