Managed Service for ClickHouse API, gRPC: ClusterService.Create
- gRPC request
- CreateClusterRequest
- ConfigSpec
- Clickhouse
- ClickhouseConfig
- MergeTree
- Compression
- ExternalDictionary
- Structure
- Id
- Key
- Attribute
- Layout
- Range
- HttpSource
- Header
- MysqlSource
- Replica
- ClickhouseSource
- MongodbSource
- PostgresqlSource
- GraphiteRollup
- Pattern
- Retention
- Kafka
- KafkaTopic
- Rabbitmq
- QueryMaskingRule
- QueryCache
- Resources
- Zookeeper
- Access
- CloudStorage
- DatabaseSpec
- UserSpec
- Permission
- UserSettings
- UserQuota
- HostSpec
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- operation.Operation
- CreateClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Clickhouse
- ClickhouseConfigSet
- ClickhouseConfig
- MergeTree
- Compression
- ExternalDictionary
- Structure
- Id
- Key
- Attribute
- Layout
- Range
- HttpSource
- Header
- MysqlSource
- Replica
- ClickhouseSource
- MongodbSource
- PostgresqlSource
- GraphiteRollup
- Pattern
- Retention
- Kafka
- KafkaTopic
- Rabbitmq
- QueryMaskingRule
- QueryCache
- Resources
- Zookeeper
- Access
- CloudStorage
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Creates a ClickHouse cluster in the specified folder.
gRPC request
rpc Create (CreateClusterRequest) returns (operation.Operation)
CreateClusterRequest
{
"folder_id": "string",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"environment": "Environment",
"config_spec": {
"version": "string",
"clickhouse": {
"config": {
"log_level": "LogLevel",
"merge_tree": {
"replicated_deduplication_window": "google.protobuf.Int64Value",
"replicated_deduplication_window_seconds": "google.protobuf.Int64Value",
"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_replicated_merges_in_queue": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_lower_max_size_of_merge": "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",
"ttl_only_drop_parts": "google.protobuf.BoolValue",
"allow_remote_fs_zero_copy_replication": "google.protobuf.BoolValue",
"merge_with_ttl_timeout": "google.protobuf.Int64Value",
"merge_with_recompression_ttl_timeout": "google.protobuf.Int64Value",
"max_parts_in_total": "google.protobuf.Int64Value",
"max_number_of_merges_with_ttl_in_pool": "google.protobuf.Int64Value",
"cleanup_delay_period": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_execute_mutation": "google.protobuf.Int64Value",
"max_avg_part_size_for_too_many_parts": "google.protobuf.Int64Value",
"min_age_to_force_merge_seconds": "google.protobuf.Int64Value",
"min_age_to_force_merge_on_partition_only": "google.protobuf.BoolValue",
"merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"merge_max_block_size": "google.protobuf.Int64Value",
"check_sample_column_is_correct": "google.protobuf.BoolValue",
"max_merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"max_cleanup_delay_period": "google.protobuf.Int64Value"
},
"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",
"max_array_size": "int64"
},
// 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"
},
"max_connections": "google.protobuf.Int64Value",
"max_concurrent_queries": "google.protobuf.Int64Value",
"keep_alive_timeout": "google.protobuf.Int64Value",
"uncompressed_cache_size": "google.protobuf.Int64Value",
"mark_cache_size": "google.protobuf.Int64Value",
"max_table_size_to_drop": "google.protobuf.Int64Value",
"max_partition_size_to_drop": "google.protobuf.Int64Value",
"builtin_dictionaries_reload_interval": "google.protobuf.Int64Value",
"timezone": "string",
"geobase_enabled": "google.protobuf.BoolValue",
"geobase_uri": "string",
"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",
"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",
"default_database": "google.protobuf.StringValue",
"total_memory_profiler_step": "google.protobuf.Int64Value",
"total_memory_tracker_sample_probability": "google.protobuf.DoubleValue",
"query_masking_rules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionaries_lazy_load": "google.protobuf.BoolValue",
"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"
}
},
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
}
},
"zookeeper": {
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
}
},
"backup_window_start": "google.type.TimeOfDay",
"access": {
"data_lens": "bool",
"web_sql": "bool",
"metrika": "bool",
"serverless": "bool",
"data_transfer": "bool",
"yandex_query": "bool"
},
"cloud_storage": {
"enabled": "bool",
"move_factor": "google.protobuf.DoubleValue",
"data_cache_enabled": "google.protobuf.BoolValue",
"data_cache_max_size": "google.protobuf.Int64Value",
"prefer_not_to_merge": "google.protobuf.BoolValue"
},
"sql_database_management": "google.protobuf.BoolValue",
"sql_user_management": "google.protobuf.BoolValue",
"admin_password": "string",
"embedded_keeper": "google.protobuf.BoolValue",
"backup_retain_period_days": "google.protobuf.Int64Value"
},
"database_specs": [
{
"name": "string"
}
],
"user_specs": [
{
"name": "string",
"password": "string",
"permissions": [
{
"database_name": "string"
}
],
"settings": {
"readonly": "google.protobuf.Int64Value",
"allow_ddl": "google.protobuf.BoolValue",
"allow_introspection_functions": "google.protobuf.BoolValue",
"connect_timeout": "google.protobuf.Int64Value",
"connect_timeout_with_failover": "google.protobuf.Int64Value",
"receive_timeout": "google.protobuf.Int64Value",
"send_timeout": "google.protobuf.Int64Value",
"timeout_before_checking_execution_speed": "google.protobuf.Int64Value",
"insert_quorum": "google.protobuf.Int64Value",
"insert_quorum_timeout": "google.protobuf.Int64Value",
"insert_quorum_parallel": "google.protobuf.BoolValue",
"insert_null_as_default": "google.protobuf.BoolValue",
"select_sequential_consistency": "google.protobuf.BoolValue",
"deduplicate_blocks_in_dependent_materialized_views": "google.protobuf.BoolValue",
"replication_alter_partitions_sync": "google.protobuf.Int64Value",
"max_replica_delay_for_distributed_queries": "google.protobuf.Int64Value",
"fallback_to_stale_replicas_for_distributed_queries": "google.protobuf.BoolValue",
"distributed_product_mode": "DistributedProductMode",
"distributed_aggregation_memory_efficient": "google.protobuf.BoolValue",
"distributed_ddl_task_timeout": "google.protobuf.Int64Value",
"skip_unavailable_shards": "google.protobuf.BoolValue",
"compile_expressions": "google.protobuf.BoolValue",
"min_count_to_compile_expression": "google.protobuf.Int64Value",
"max_block_size": "google.protobuf.Int64Value",
"min_insert_block_size_rows": "google.protobuf.Int64Value",
"min_insert_block_size_bytes": "google.protobuf.Int64Value",
"max_insert_block_size": "google.protobuf.Int64Value",
"min_bytes_to_use_direct_io": "google.protobuf.Int64Value",
"use_uncompressed_cache": "google.protobuf.BoolValue",
"merge_tree_max_rows_to_use_cache": "google.protobuf.Int64Value",
"merge_tree_max_bytes_to_use_cache": "google.protobuf.Int64Value",
"merge_tree_min_rows_for_concurrent_read": "google.protobuf.Int64Value",
"merge_tree_min_bytes_for_concurrent_read": "google.protobuf.Int64Value",
"max_bytes_before_external_group_by": "google.protobuf.Int64Value",
"max_bytes_before_external_sort": "google.protobuf.Int64Value",
"group_by_two_level_threshold": "google.protobuf.Int64Value",
"group_by_two_level_threshold_bytes": "google.protobuf.Int64Value",
"priority": "google.protobuf.Int64Value",
"max_threads": "google.protobuf.Int64Value",
"max_memory_usage": "google.protobuf.Int64Value",
"max_memory_usage_for_user": "google.protobuf.Int64Value",
"max_network_bandwidth": "google.protobuf.Int64Value",
"max_network_bandwidth_for_user": "google.protobuf.Int64Value",
"max_partitions_per_insert_block": "google.protobuf.Int64Value",
"max_concurrent_queries_for_user": "google.protobuf.Int64Value",
"force_index_by_date": "google.protobuf.BoolValue",
"force_primary_key": "google.protobuf.BoolValue",
"max_rows_to_read": "google.protobuf.Int64Value",
"max_bytes_to_read": "google.protobuf.Int64Value",
"read_overflow_mode": "OverflowMode",
"max_rows_to_group_by": "google.protobuf.Int64Value",
"group_by_overflow_mode": "GroupByOverflowMode",
"max_rows_to_sort": "google.protobuf.Int64Value",
"max_bytes_to_sort": "google.protobuf.Int64Value",
"sort_overflow_mode": "OverflowMode",
"max_result_rows": "google.protobuf.Int64Value",
"max_result_bytes": "google.protobuf.Int64Value",
"result_overflow_mode": "OverflowMode",
"max_rows_in_distinct": "google.protobuf.Int64Value",
"max_bytes_in_distinct": "google.protobuf.Int64Value",
"distinct_overflow_mode": "OverflowMode",
"max_rows_to_transfer": "google.protobuf.Int64Value",
"max_bytes_to_transfer": "google.protobuf.Int64Value",
"transfer_overflow_mode": "OverflowMode",
"max_execution_time": "google.protobuf.Int64Value",
"timeout_overflow_mode": "OverflowMode",
"max_rows_in_set": "google.protobuf.Int64Value",
"max_bytes_in_set": "google.protobuf.Int64Value",
"set_overflow_mode": "OverflowMode",
"max_rows_in_join": "google.protobuf.Int64Value",
"max_bytes_in_join": "google.protobuf.Int64Value",
"join_overflow_mode": "OverflowMode",
"join_algorithm": [
"JoinAlgorithm"
],
"any_join_distinct_right_table_keys": "google.protobuf.BoolValue",
"max_columns_to_read": "google.protobuf.Int64Value",
"max_temporary_columns": "google.protobuf.Int64Value",
"max_temporary_non_const_columns": "google.protobuf.Int64Value",
"max_query_size": "google.protobuf.Int64Value",
"max_ast_depth": "google.protobuf.Int64Value",
"max_ast_elements": "google.protobuf.Int64Value",
"max_expanded_ast_elements": "google.protobuf.Int64Value",
"min_execution_speed": "google.protobuf.Int64Value",
"min_execution_speed_bytes": "google.protobuf.Int64Value",
"count_distinct_implementation": "CountDistinctImplementation",
"input_format_values_interpret_expressions": "google.protobuf.BoolValue",
"input_format_defaults_for_omitted_fields": "google.protobuf.BoolValue",
"input_format_null_as_default": "google.protobuf.BoolValue",
"date_time_input_format": "DateTimeInputFormat",
"input_format_with_names_use_header": "google.protobuf.BoolValue",
"output_format_json_quote_64bit_integers": "google.protobuf.BoolValue",
"output_format_json_quote_denormals": "google.protobuf.BoolValue",
"date_time_output_format": "DateTimeOutputFormat",
"low_cardinality_allow_in_native_format": "google.protobuf.BoolValue",
"allow_suspicious_low_cardinality_types": "google.protobuf.BoolValue",
"empty_result_for_aggregation_by_empty_set": "google.protobuf.BoolValue",
"http_connection_timeout": "google.protobuf.Int64Value",
"http_receive_timeout": "google.protobuf.Int64Value",
"http_send_timeout": "google.protobuf.Int64Value",
"enable_http_compression": "google.protobuf.BoolValue",
"send_progress_in_http_headers": "google.protobuf.BoolValue",
"http_headers_progress_interval": "google.protobuf.Int64Value",
"add_http_cors_header": "google.protobuf.BoolValue",
"cancel_http_readonly_queries_on_client_close": "google.protobuf.BoolValue",
"max_http_get_redirects": "google.protobuf.Int64Value",
"joined_subquery_requires_alias": "google.protobuf.BoolValue",
"join_use_nulls": "google.protobuf.BoolValue",
"transform_null_in": "google.protobuf.BoolValue",
"quota_mode": "QuotaMode",
"flatten_nested": "google.protobuf.BoolValue",
"format_regexp": "string",
"format_regexp_escaping_rule": "FormatRegexpEscapingRule",
"format_regexp_skip_unmatched": "google.protobuf.BoolValue",
"async_insert": "google.protobuf.BoolValue",
"async_insert_threads": "google.protobuf.Int64Value",
"wait_for_async_insert": "google.protobuf.BoolValue",
"wait_for_async_insert_timeout": "google.protobuf.Int64Value",
"async_insert_max_data_size": "google.protobuf.Int64Value",
"async_insert_busy_timeout": "google.protobuf.Int64Value",
"async_insert_stale_timeout": "google.protobuf.Int64Value",
"memory_profiler_step": "google.protobuf.Int64Value",
"memory_profiler_sample_probability": "google.protobuf.DoubleValue",
"max_final_threads": "google.protobuf.Int64Value",
"input_format_parallel_parsing": "google.protobuf.BoolValue",
"input_format_import_nested_json": "google.protobuf.BoolValue",
"local_filesystem_read_method": "LocalFilesystemReadMethod",
"max_read_buffer_size": "google.protobuf.Int64Value",
"insert_keeper_max_retries": "google.protobuf.Int64Value",
"max_temporary_data_on_disk_size_for_user": "google.protobuf.Int64Value",
"max_temporary_data_on_disk_size_for_query": "google.protobuf.Int64Value",
"max_parser_depth": "google.protobuf.Int64Value",
"remote_filesystem_read_method": "RemoteFilesystemReadMethod",
"memory_overcommit_ratio_denominator": "google.protobuf.Int64Value",
"memory_overcommit_ratio_denominator_for_user": "google.protobuf.Int64Value",
"memory_usage_overcommit_max_wait_microseconds": "google.protobuf.Int64Value",
"log_query_threads": "google.protobuf.BoolValue",
"max_insert_threads": "google.protobuf.Int64Value",
"use_hedged_requests": "google.protobuf.BoolValue",
"idle_connection_timeout": "google.protobuf.Int64Value",
"hedged_connection_timeout_ms": "google.protobuf.Int64Value",
"load_balancing": "LoadBalancing",
"prefer_localhost_replica": "google.protobuf.BoolValue",
"compile": "google.protobuf.BoolValue",
"min_count_to_compile": "google.protobuf.Int64Value"
},
"quotas": [
{
"interval_duration": "google.protobuf.Int64Value",
"queries": "google.protobuf.Int64Value",
"errors": "google.protobuf.Int64Value",
"result_rows": "google.protobuf.Int64Value",
"read_rows": "google.protobuf.Int64Value",
"execution_time": "google.protobuf.Int64Value"
}
]
}
],
"host_specs": [
{
"zone_id": "string",
"type": "Type",
"subnet_id": "string",
"assign_public_ip": "bool",
"shard_name": "string"
}
],
"network_id": "string",
"shard_name": "string",
"service_account_id": "string",
"security_group_ids": [
"string"
],
"deletion_protection": "bool",
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
}
}
|
Field |
Description |
|
folder_id |
string Required field. ID of the folder to create the ClickHouse cluster in. |
|
name |
string Required field. Name of the ClickHouse cluster. The name must be unique within the folder. |
|
description |
string Description of the ClickHouse cluster. |
|
labels |
object (map<string, string>) Custom labels for the ClickHouse cluster as |
|
environment |
enum Environment Required field. Deployment environment of the ClickHouse cluster.
|
|
config_spec |
Required field. Configuration and resources for hosts that should be created for the ClickHouse cluster. |
|
database_specs[] |
Descriptions of databases to be created in the ClickHouse cluster. |
|
user_specs[] |
Descriptions of database users to be created in the ClickHouse cluster. |
|
host_specs[] |
Individual configurations for hosts that should be created for the ClickHouse cluster. |
|
network_id |
string Required field. ID of the network to create the cluster in. |
|
shard_name |
string Name of the first shard in cluster. If not set, defaults to the value 'shard1'. |
|
service_account_id |
string ID of the service account used for access to Object Storage. |
|
security_group_ids[] |
string User security groups |
|
deletion_protection |
bool Deletion Protection inhibits deletion of the cluster |
|
maintenance_window |
Window of maintenance operations. |
ConfigSpec
|
Field |
Description |
|
version |
string Version of the ClickHouse server software. |
|
clickhouse |
Configuration and resources for a ClickHouse server. |
|
zookeeper |
Configuration and resources for a ZooKeeper server. |
|
backup_window_start |
Time to start the daily backup, in the UTC timezone. |
|
access |
Access policy for external services. If you want a specific service to access the ClickHouse cluster, then set the necessary values in this policy. |
|
cloud_storage |
|
|
sql_database_management |
Whether database management through SQL commands is enabled. |
|
sql_user_management |
Whether user management through SQL commands is enabled. |
|
admin_password |
string Password for user 'admin' that has SQL user management access. |
|
embedded_keeper |
Whether cluster should use embedded Keeper instead of Zookeeper |
|
backup_retain_period_days |
Retain period of automatically created backup in days |
Clickhouse
|
Field |
Description |
|
config |
Configuration for a ClickHouse server. |
|
resources |
Resources allocated to ClickHouse hosts. |
ClickhouseConfig
ClickHouse configuration options. Detailed description for each set of options
is available in ClickHouse documentation.
Any options not listed here are not supported.
|
Field |
Description |
|
log_level |
enum LogLevel Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
|
|
merge_tree |
Settings for the MergeTree engine. |
|
compression[] |
Compression settings for the ClickHouse cluster. |
|
dictionaries[] |
Configuration of external dictionaries to be used by the ClickHouse cluster. |
|
graphite_rollup[] |
Settings for thinning Graphite data. |
|
kafka |
|
|
kafka_topics[] |
|
|
rabbitmq |
|
|
max_connections |
Maximum number of inbound connections. |
|
max_concurrent_queries |
Maximum number of simultaneously processed requests. |
|
keep_alive_timeout |
Number of milliseconds that ClickHouse waits for incoming requests before closing the connection. |
|
uncompressed_cache_size |
Cache size (in bytes) for uncompressed data used by MergeTree tables. |
|
mark_cache_size |
Approximate size (in bytes) of the cache of "marks" used by MergeTree tables. |
|
max_table_size_to_drop |
Maximum size of the table that can be deleted using a DROP query. |
|
max_partition_size_to_drop |
Maximum size of the partition that can be deleted using a DROP query. |
|
builtin_dictionaries_reload_interval |
The setting is deprecated and has no effect. |
|
timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
|
geobase_enabled |
Enable or disable geobase. |
|
geobase_uri |
string Address of the archive with the user geobase in Object Storage. |
|
query_log_retention_size |
The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
query_log_retention_time |
The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of |
|
query_thread_log_enabled |
Whether query_thread_log system table is enabled. |
|
query_thread_log_retention_size |
The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
query_thread_log_retention_time |
The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of |
|
part_log_retention_size |
The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
part_log_retention_time |
The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of |
|
metric_log_enabled |
Whether metric_log system table is enabled. |
|
metric_log_retention_size |
The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
metric_log_retention_time |
The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of |
|
trace_log_enabled |
Whether trace_log system table is enabled. |
|
trace_log_retention_size |
The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
trace_log_retention_time |
The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of |
|
text_log_enabled |
Whether text_log system table is enabled. |
|
text_log_retention_size |
The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
text_log_retention_time |
The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of |
|
text_log_level |
enum LogLevel Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
|
|
opentelemetry_span_log_enabled |
Enable or disable opentelemetry_span_log system table. Default value: false. |
|
opentelemetry_span_log_retention_size |
The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0 (default), |
|
opentelemetry_span_log_retention_time |
The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, |
|
query_views_log_enabled |
Enable or disable query_views_log system table. Default value: false. |
|
query_views_log_retention_size |
The maximum size that query_views_log can grow to before old data will be removed. If set to 0 (default), |
|
query_views_log_retention_time |
The maximum time that query_views_log records will be retained before removal. If set to 0, |
|
asynchronous_metric_log_enabled |
Enable or disable asynchronous_metric_log system table. Default value: false. |
|
asynchronous_metric_log_retention_size |
The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0 (default), |
|
asynchronous_metric_log_retention_time |
The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, |
|
session_log_enabled |
Enable or disable session_log system table. Default value: false. |
|
session_log_retention_size |
The maximum size that session_log can grow to before old data will be removed. If set to 0 (default), |
|
session_log_retention_time |
The maximum time that session_log records will be retained before removal. If set to 0, |
|
zookeeper_log_enabled |
Enable or disable zookeeper_log system table. Default value: false. |
|
zookeeper_log_retention_size |
The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0 (default), |
|
zookeeper_log_retention_time |
The maximum time that zookeeper_log records will be retained before removal. If set to 0, |
|
asynchronous_insert_log_enabled |
Enable or disable asynchronous_insert_log system table. Default value: false. |
|
asynchronous_insert_log_retention_size |
The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0 (default), |
|
asynchronous_insert_log_retention_time |
The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, |
|
background_pool_size |
|
|
background_merges_mutations_concurrency_ratio |
Sets a ratio between the number of threads and the number of background merges and mutations that can be executed concurrently. For example, if the ratio equals to 2 and background_pool_size is set to 16 then ClickHouse can execute 32 background merges concurrently. This is possible, because background operations could be suspended and postponed. This is needed to give small merges more execution priority. You can only increase this ratio at runtime. To lower it you have to restart the server. The same as for background_pool_size setting background_merges_mutations_concurrency_ratio could be applied from the default profile for backward compatibility. |
|
background_schedule_pool_size |
|
|
background_fetches_pool_size |
Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8. More info see in ClickHouse documentation. |
|
background_move_pool_size |
|
|
background_distributed_schedule_pool_size |
|
|
background_buffer_flush_schedule_pool_size |
|
|
background_message_broker_schedule_pool_size |
|
|
background_common_pool_size |
The maximum number of threads that will be used for performing a variety of operations (mostly garbage collection) for *MergeTree-engine tables in a background. |
|
default_database |
The default database. To get a list of cluster databases, see Yandex Managed ClickHouse documentation. |
|
total_memory_profiler_step |
Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304. More info see in ClickHouse documentation. |
|
total_memory_tracker_sample_probability |
|
|
query_masking_rules[] |
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. |
|
dictionaries_lazy_load |
Lazy loading of dictionaries. |
|
query_cache |
Query cache configuration. |
MergeTree
Options specific to the MergeTree table engine.
|
Field |
Description |
|
replicated_deduplication_window |
Number of blocks of hashes to keep in ZooKeeper. |
|
replicated_deduplication_window_seconds |
Period of time to keep blocks of hashes for. |
|
parts_to_delay_insert |
If table contains at least that many active parts in single partition, artificially slow down insert into table. |
|
parts_to_throw_insert |
If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
|
inactive_parts_to_delay_insert |
|
|
inactive_parts_to_throw_insert |
|
|
max_replicated_merges_in_queue |
How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
|
number_of_free_entries_in_pool_to_lower_max_size_of_merge |
If there is less than specified number of free entries in background pool (or replicated queue), start to lower |
|
max_bytes_to_merge_at_min_space_in_pool |
Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries |
|
max_bytes_to_merge_at_max_space_in_pool |
|
|
min_bytes_for_wide_part |
Minimum number of bytes in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
|
min_rows_for_wide_part |
Minimum number of rows in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
|
ttl_only_drop_parts |
Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables. More info see in ClickHouse documentation. |
|
allow_remote_fs_zero_copy_replication |
|
|
merge_with_ttl_timeout |
|
|
merge_with_recompression_ttl_timeout |
|
|
max_parts_in_total |
|
|
max_number_of_merges_with_ttl_in_pool |
|
|
cleanup_delay_period |
|
|
number_of_free_entries_in_pool_to_execute_mutation |
|
|
max_avg_part_size_for_too_many_parts |
The 'too many parts' check according to 'parts_to_delay_insert' and 'parts_to_throw_insert' will be active only if the average part size (in the relevant partition) is not larger than the specified threshold. If it is larger than the specified threshold, the INSERTs will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. |
|
min_age_to_force_merge_seconds |
Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds. |
|
min_age_to_force_merge_on_partition_only |
Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. |
|
merge_selecting_sleep_ms |
Sleep time for merge selecting when no part is selected. A lower setting triggers selecting tasks in background_schedule_pool frequently, which results in a large number of requests to ClickHouse Keeper in large-scale clusters. |
|
merge_max_block_size |
The number of rows that are read from the merged parts into memory. |
|
check_sample_column_is_correct |
Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. |
|
max_merge_selecting_sleep_ms |
Maximum sleep time for merge selecting, a lower setting will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to zookeeper in large-scale clusters. |
|
max_cleanup_delay_period |
Maximum period to clean old queue logs, blocks hashes and parts. |
Compression
|
Field |
Description |
|
method |
enum Method Compression method to use for the specified combination of
|
|
min_part_size |
int64 Minimum size of a part of a table. |
|
min_part_size_ratio |
double Minimum ratio of a part relative to the size of all the data in the table. |
|
level |
ExternalDictionary
|
Field |
Description |
|
name |
string Required field. Name of the external dictionary. |
|
structure |
Required field. Set of attributes for the external dictionary. |
|
layout |
Required field. Layout for storing the dictionary in memory. |
|
fixed_lifetime |
int64 Fixed interval between dictionary updates. Includes only one of the fields Setting for the period of time between dictionary updates. |
|
lifetime_range |
Range of intervals between dictionary updates for ClickHouse to choose from. Includes only one of the fields Setting for the period of time between dictionary updates. |
|
http_source |
HTTP source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
mysql_source |
MySQL source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
clickhouse_source |
ClickHouse source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
mongodb_source |
MongoDB source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
postgresql_source |
PostgreSQL source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
Structure
|
Field |
Description |
|
id |
Single numeric key column for the dictionary. |
|
key |
Composite key for the dictionary, containing of one or more key columns. |
|
range_min |
Field holding the beginning of the range for dictionaries with |
|
range_max |
Field holding the end of the range for dictionaries with |
|
attributes[] |
Description of the fields available for database queries. |
Id
Numeric key.
|
Field |
Description |
|
name |
string Required field. Name of the numeric key. |
Key
Complex key.
|
Field |
Description |
|
attributes[] |
Attributes of a complex key. |
Attribute
|
Field |
Description |
|
name |
string Required field. Name of the column. |
|
type |
string Required field. Type of the column. |
|
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. |
|
injective |
bool Indication of injective mapping "id -> attribute". |
Layout
Layout determining how to store the dictionary in memory.
|
Field |
Description |
|
type |
enum Type Required field. Layout type for an external dictionary.
|
|
size_in_cells |
int64 Number of cells in the cache. Rounded up to a power of two. |
|
max_array_size |
int64 Maximum dictionary key size. |
Range
|
Field |
Description |
|
min |
int64 Minimum dictionary lifetime. |
|
max |
int64 Maximum dictionary lifetime. |
HttpSource
|
Field |
Description |
|
url |
string Required field. URL of the source dictionary available over HTTP. |
|
format |
string Required field. The data format. Valid values are all formats supported by ClickHouse SQL dialect. |
|
headers[] |
HTTP headers. |
Header
|
Field |
Description |
|
name |
string Required field. |
|
value |
string Required field. |
MysqlSource
|
Field |
Description |
|
db |
string Required field. Name of the MySQL database to connect to. |
|
table |
string Required field. Name of the database table to use as a ClickHouse dictionary. |
|
port |
int64 Default port to use when connecting to a replica of the dictionary source. |
|
user |
string Name of the default user for replicas of the dictionary source. |
|
password |
string Password of the default user for replicas of the dictionary source. |
|
replicas[] |
List of MySQL replicas of the database used as dictionary source. |
|
where |
string Selection criteria for the data in the specified MySQL table. |
|
invalidate_query |
string Query for checking the dictionary status, to pull only updated data. |
|
close_connection |
Should the connection be closed after each request. |
|
share_connection |
Should a connection be shared for some requests. |
Replica
|
Field |
Description |
|
host |
string Required field. MySQL host of the replica. |
|
priority |
int64 Required field. The priority of the replica that ClickHouse takes into account when connecting. |
|
port |
int64 Port to use when connecting to the replica. |
|
user |
string Name of the MySQL database user. |
|
password |
string Password of the MySQL database user. |
ClickhouseSource
|
Field |
Description |
|
db |
string Required field. Name of the ClickHouse database. |
|
table |
string Required field. Name of the table in the specified database to be used as the dictionary source. |
|
host |
string ClickHouse host of the specified database. |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the ClickHouse database user. |
|
password |
string Password of the ClickHouse database user. |
|
where |
string Selection criteria for the data in the specified ClickHouse table. |
|
secure |
Use ssl for connection. |
MongodbSource
|
Field |
Description |
|
db |
string Required field. Name of the MongoDB database. |
|
collection |
string Required field. Name of the collection in the specified database to be used as the dictionary source. |
|
host |
string MongoDB host of the specified database. |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the MongoDB database user. |
|
password |
string Password of the MongoDB database user. |
|
options |
string |
PostgresqlSource
|
Field |
Description |
|
db |
string Required field. Name of the PostrgreSQL database. |
|
table |
string Required field. Name of the table in the specified database to be used as the dictionary source. |
|
hosts[] |
string Name of the PostrgreSQL host |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the PostrgreSQL database user. |
|
password |
string Password of the PostrgreSQL database user. |
|
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.
|
GraphiteRollup
Rollup settings for the GraphiteMergeTree table engine.
|
Field |
Description |
|
name |
string Required field. Name for the specified combination of settings for Graphite rollup. |
|
patterns[] |
Pattern to use for the rollup. |
|
path_column_name |
string The name of the column storing the metric name (Graphite sensor). |
|
time_column_name |
string The name of the column storing the time of measuring the metric. |
|
value_column_name |
string The name of the column storing the value of the metric at the time set in time_column_name. |
|
version_column_name |
string The name of the column storing the version of the metric. |
Pattern
|
Field |
Description |
|
regexp |
string Pattern for metric names. |
|
function |
string Required field. Name of the aggregating function to apply to data of the age specified in |
|
retention[] |
Age of data to use for thinning. |
Retention
|
Field |
Description |
|
age |
int64 Minimum age of the data in seconds. |
|
precision |
int64 Precision of determining the age of the data, in seconds. |
Kafka
|
Field |
Description |
|
security_protocol |
enum SecurityProtocol
|
|
sasl_mechanism |
enum SaslMechanism
|
|
sasl_username |
string |
|
sasl_password |
string |
|
enable_ssl_certificate_verification |
|
|
max_poll_interval_ms |
|
|
session_timeout_ms |
|
|
debug |
enum Debug
|
|
auto_offset_reset |
enum AutoOffsetReset
|
KafkaTopic
|
Field |
Description |
|
name |
string Required field. |
|
settings |
Required field. |
Rabbitmq
|
Field |
Description |
|
username |
string RabbitMQ username |
|
password |
string RabbitMQ password |
|
vhost |
string RabbitMQ virtual host |
QueryMaskingRule
|
Field |
Description |
|
name |
string Name for the rule. |
|
regexp |
string Required field. RE2 compatible regular expression. |
|
replace |
string Substitution string for sensitive data. |
QueryCache
|
Field |
Description |
|
max_size_in_bytes |
The maximum cache size in bytes. |
|
max_entries |
The maximum number of SELECT query results stored in the cache. |
|
max_entry_size_in_bytes |
The maximum size in bytes SELECT query results may have to be saved in the cache. |
|
max_entry_size_in_rows |
The maximum number of rows SELECT query results may have to be saved in the cache. |
Resources
|
Field |
Description |
|
resource_preset_id |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
|
disk_size |
int64 Volume of the storage available to a host, in bytes. |
|
disk_type_id |
string Type of the storage environment for the host.
|
Zookeeper
|
Field |
Description |
|
resources |
Resources allocated to ZooKeeper hosts. If not set, minimal available resources will be used. |
Access
|
Field |
Description |
|
data_lens |
bool Allow to export data from the cluster to DataLens. |
|
web_sql |
bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
|
metrika |
bool Allow to import data from Yandex Metrica and AppMetrica to the cluster. See AppMetrica documentation for more details. |
|
serverless |
bool Allow access to cluster for Serverless. |
|
data_transfer |
bool Allow access for DataTransfer |
|
yandex_query |
bool Allow access for Query |
CloudStorage
|
Field |
Description |
|
enabled |
bool Whether to use Object Storage for storing ClickHouse data. |
|
move_factor |
|
|
data_cache_enabled |
|
|
data_cache_max_size |
|
|
prefer_not_to_merge |
DatabaseSpec
|
Field |
Description |
|
name |
string Required field. Name of the ClickHouse database. 1-63 characters long. |
UserSpec
|
Field |
Description |
|
name |
string Required field. Name of the ClickHouse user. |
|
password |
string Required field. Password of the ClickHouse user. |
|
permissions[] |
Set of permissions to grant to the user. If not set, it's granted permissions to access all databases. |
|
settings |
|
|
quotas[] |
Set of quotas assigned to the user. |
Permission
|
Field |
Description |
|
database_name |
string Name of the database that the permission grants access to. |
UserSettings
ClickHouse user settings. Supported settings are a limited subset of all settings
described in ClickHouse documentation.
|
Field |
Description |
|
readonly |
Restricts permissions for non-DDL queries. To restrict permissions for DDL queries, use
See in-depth description in ClickHouse documentation. |
|
allow_ddl |
Determines whether DDL queries are allowed (e.g., CREATE, ALTER, RENAME, etc). Default value: true. See in-depth description in ClickHouse documentation. |
|
allow_introspection_functions |
Enables introspections functions for query profiling. More info see in ClickHouse documentation. |
|
connect_timeout |
Connection timeout in milliseconds. Value must be greater than 0 (default: 10000, 10 seconds). |
|
connect_timeout_with_failover |
The timeout in milliseconds for connecting to a remote server for a Distributed table engine. Applies only if the cluster uses sharding and replication. If unsuccessful, several attempts are made to connect to various replicas. Default value: 50. More info see in ClickHouse documentation. |
|
receive_timeout |
Receive timeout in milliseconds. Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes). |
|
send_timeout |
Send timeout in milliseconds. Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes). |
|
timeout_before_checking_execution_speed |
Timeout (in seconds) between checks of execution speed. It is checked that execution speed is not less that specified in Default value: 10. |
|
insert_quorum |
Enables or disables write quorum for ClickHouse cluster. When used, write quorum guarantees that ClickHouse has written data to the quorum of insert_quorum replicas with no errors until the You can use See in-depth description in ClickHouse documentation. |
|
insert_quorum_timeout |
Quorum write timeout in milliseconds. If the write quorum is enabled in the cluster, this timeout expires and some data is not written to the Minimum value: 1000, 1 second (default: 60000, 1 minute). |
|
insert_quorum_parallel |
See in-depth description in ClickHouse documentation. |
|
insert_null_as_default |
Enables the insertion of default values instead of NULL into columns with not nullable data type. Default value: true. More info see in ClickHouse documentation. |
|
select_sequential_consistency |
Determines the behavior of SELECT queries from the replicated table: if enabled, ClickHouse will terminate a query with error message in case the replica does not have a chunk written with the quorum and will not read the parts that have not yet been written with the quorum. Default value: false (sequential consistency is disabled). |
|
deduplicate_blocks_in_dependent_materialized_views |
See in-depth description in ClickHouse documentation. |
|
replication_alter_partitions_sync |
Wait mode for asynchronous actions in ALTER queries on replicated tables:
See in-depth description in ClickHouse documentation. |
|
max_replica_delay_for_distributed_queries |
Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. |
|
fallback_to_stale_replicas_for_distributed_queries |
Enables or disables query forcing to a stale replica in case the actual data is unavailable. Default value: true (query forcing is enabled). See in-depth description in ClickHouse documentation. |
|
distributed_product_mode |
enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation.
|
|
distributed_aggregation_memory_efficient |
Enables of disables memory saving mode when doing distributed aggregation. When ClickHouse works with a distributed query, external aggregation is done on remote servers. Default value: false (memory saving mode is disabled). See in-depth description in ClickHouse documentation. |
|
distributed_ddl_task_timeout |
Timeout for DDL queries, in milliseconds. |
|
skip_unavailable_shards |
Enables or disables silent skipping of unavailable shards. A shard is considered unavailable if all its replicas are also unavailable. Default value: false (silent skipping is disabled). See in-depth description in ClickHouse documentation. |
|
compile_expressions |
Enables or disables expression compilation. Use this setting in combination with Default value: false (expression compilation is disabled). |
|
min_count_to_compile_expression |
How many identical expressions ClickHouse has to encounter before they are compiled. Minimum value: 0 (default: 3). For the 0 value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. For all other values, compilation is asynchronous: the compilation process executes in a separate thread. |
|
max_block_size |
The maximum block size for reading. Data in ClickHouse is organized and processed by blocks (block is a set of columns' parts). This setting is a recommendation for size of block (in a count of rows) that should be loaded from tables. Value must be greater than 0 (default: 65536). See in-depth description in ClickHouse documentation. |
|
min_insert_block_size_rows |
Limits the minimum number of rows in a block to be inserted in a table by INSERT query. Minimal value: 0, block squashing is disabled (default: 1048576). |
|
min_insert_block_size_bytes |
Limits the minimum number of bytes in a block to be inserted in a table by INSERT query. Minimal value: 0, block squashing is disabled (default: 268435456, 256 MB). |
|
max_insert_block_size |
Allows to form blocks of the specified size (in bytes) when inserting data in a table. Value must be greater than 0 (default: 1048576). See in-depth description in ClickHouse documentation. |
|
min_bytes_to_use_direct_io |
Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). By default, ClickHouse does not read data directly from disk, but relies on the filesystem and its cache instead. If the total amount of the data to read is greater than the value of this setting, then ClickHouse will fetch this data directly from the disk. Minimal value and default value: 0, Direct I/O is disabled. |
|
use_uncompressed_cache |
Determines whether to use the cache of uncompressed blocks, or not. This setting has effect only for tables of the MergeTree family. Default value: false (uncompressed cache is disabled). See in-depth description in ClickHouse documentation. |
|
merge_tree_max_rows_to_use_cache |
Limits the maximum size in rows of the request that can use the cache of uncompressed data. The cache is not used for requests larger Use this setting in combination with Value must be greater than 0 (default: 128x8192). |
|
merge_tree_max_bytes_to_use_cache |
Limits the maximum size in bytes of the request that can use the cache of uncompressed data. The cache is not used for requests larger Use this setting in combination with Value must be greater than 0 (default: 192x10x1024x1024). |
|
merge_tree_min_rows_for_concurrent_read |
Limits the minimum number of rows to be read from a file to enable concurrent read. This setting has effect only for tables of the MergeTree family. Value must be greater than 0 (default: 20x8192). |
|
merge_tree_min_bytes_for_concurrent_read |
Limits the number of bytes to be read from a file to enable concurrent read. This setting has effect only for tables of the MergeTree family. Value must be greater than 0 (default: 24x10x1024x1024). |
|
max_bytes_before_external_group_by |
Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the GROUP BY operation, should be flushed to disk to limit the RAM comsumption. By default, aggregation is done by employing hash table that resides in RAM. Minimal value and default value: 0, GROUP BY in the external memory is disabled. When using aggregation in external memory, it is recommended to set the value of this setting twice as low as the See in-depth description in ClickHouse documentation. See also: the |
|
max_bytes_before_external_sort |
This setting is equivalent of the |
|
group_by_two_level_threshold |
Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000). |
|
group_by_two_level_threshold_bytes |
Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000). |
|
priority |
Sets the priority of a query.
This setting should be set up for each query individually. If ClickHouse is working with the high-priority queries, and a low-priority query enters, then the low-priority query is paused until higher-priority queries are completed. Minimal value and default value: 0, priority is not used. |
|
max_threads |
Limits the maximum number of threads to process the request (setting does not take threads that read data from remote servers into account). This setting applies to threads that perform the same stages of the query processing pipeline in parallel. Minimal value and default value: 0 (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). See in-depth description in ClickHouse documentation. |
|
max_memory_usage |
Limits the maximum memory usage (in bytes) for processing of a single user's query on a single server. This limitation is enforced for any user's single query on a single server. Minimal value: 0, no limitation is set. If you use See in-depth description in ClickHouse documentation. |
|
max_memory_usage_for_user |
Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. This limitation is enforced for all queries that belong to one user and run simultaneously on a single server. Minimal value and default value: 0, no limitation is set. |
|
max_network_bandwidth |
The maximum speed of data exchange over the network in bytes per second for a query. Minimal value and default value: 0, no limitation is set. |
|
max_network_bandwidth_for_user |
The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set. |
|
max_partitions_per_insert_block |
See in-depth description in ClickHouse documentation. |
|
max_concurrent_queries_for_user |
The maximum number of concurrent requests per user. |
|
force_index_by_date |
If enabled, query is not executed if the ClickHouse can't use index by date. Default value: false (setting is disabled, query executes even if ClickHouse can't use index by date). See in-depth description in ClickHouse documentation. |
|
force_primary_key |
If enabled, query is not executed if the ClickHouse can't use index by primary key. Default value: false (setting is disabled, query executes even if ClickHouse can't use index by primary key). See in-depth description in ClickHouse documentation. |
|
max_rows_to_read |
Limits the maximum number of rows that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. See in-depth description in ClickHouse documentation. |
|
max_bytes_to_read |
Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. |
|
read_overflow_mode |
enum OverflowMode Determines the behavior on exceeding limits while reading the data.
|
|
max_rows_to_group_by |
Limits the maximum number of unique keys received from aggregation function. Minimal value and default value: 0, no limitation is set. |
|
group_by_overflow_mode |
enum GroupByOverflowMode Determines the behavior on exceeding limits while doing aggregation.
|
|
max_rows_to_sort |
Limits the maximum number of rows that can be read from a table for sorting. Minimal value and default value: 0, no limitation is set. |
|
max_bytes_to_sort |
Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting. Minimal value and default value: 0, no limitation is set. |
|
sort_overflow_mode |
enum OverflowMode Determines the behavior on exceeding limits while sorting.
|
|
max_result_rows |
Limits the number of rows in the result. Minimal value and default value: 0, no limitation is set. |
|
max_result_bytes |
Limits the number of bytes in the result. Minimal value and default value: 0, no limitation is set. |
|
result_overflow_mode |
enum OverflowMode Determines the behavior on exceeding limits while forming result.
|
|
max_rows_in_distinct |
Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. |
|
max_bytes_in_distinct |
Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. |
|
distinct_overflow_mode |
enum OverflowMode Determines the behavior on exceeding limits while doing DISCTINCT.
|
|
max_rows_to_transfer |
Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. |
|
max_bytes_to_transfer |
Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary Minimal value and default value: 0, no limitation is set. |
|
transfer_overflow_mode |
enum OverflowMode Determines the behavior on exceeding limits while doing transfers.
|
|
max_execution_time |
Limits the maximum query execution time in milliseconds. Minimal value and default value: 0, no limitation is set. |
|
timeout_overflow_mode |
enum OverflowMode Determines the behavior on exceeding limits of execution time.
|
|
max_rows_in_set |
Limit on the number of rows in the set resulting from the execution of the IN section. |
|
max_bytes_in_set |
Limit on the number of bytes in the set resulting from the execution of the IN section. |
|
set_overflow_mode |
enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit.
|
|
max_rows_in_join |
Limit on maximum size of the hash table for JOIN, in rows. |
|
max_bytes_in_join |
Limit on maximum size of the hash table for JOIN, in bytes. |
|
join_overflow_mode |
enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit.
|
|
join_algorithm[] |
enum JoinAlgorithm See in-depth description in ClickHouse documentation.
|
|
any_join_distinct_right_table_keys |
See in-depth description in ClickHouse documentation. |
|
max_columns_to_read |
Limits the maximum number of columns that can be read from a table in a single query. Minimal value and default value: 0, no limitation is set. |
|
max_temporary_columns |
Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. Minimal value and default value: 0, no limitation is set. |
|
max_temporary_non_const_columns |
Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. Minimal value and default value: 0, no limitation is set. |
|
max_query_size |
Limits the size of the part of a query that can be transferred to RAM for parsing with the SQL parser, in bytes. Value must be greater than 0 (default: 262144). See in-depth description in ClickHouse documentation. |
|
max_ast_depth |
Limits the maximum depth of query syntax tree. Executing a big and complex query may result in building a syntax tree of enormous depth. For example, the **SELECT *** query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. Value must be greater than 0 (default: 1000). See in-depth description in ClickHouse documentation. |
|
max_ast_elements |
Limits the maximum size of query syntax tree in number of nodes. Executing a big and complex query may result in building a syntax tree of enormous size. Value must be greater than 0 (default: 50000). See in-depth description in ClickHouse documentation. |
|
max_expanded_ast_elements |
Limits the maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk values. Executing a big and complex query may result in building a syntax tree of enormous size. Value must be greater than 0 (default: 500000). |
|
min_execution_speed |
Minimal execution speed in rows per second. |
|
min_execution_speed_bytes |
Minimal execution speed in bytes per second. |
|
count_distinct_implementation |
enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
|
|
input_format_values_interpret_expressions |
Enables or disables SQL parser if the fast stream parser cannot parse the data. Enable this setting, if the data that you want to insert into a table contains SQL expressions. For example, the stream parser is unable to parse a value that contains now() expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. This setting has effect only if you use Values format when inserting data. Default value: true (SQL parser is enabled). See in-depth description in ClickHouse documentation. |
|
input_format_defaults_for_omitted_fields |
Enables or disables replacing omitted input values with default values of the respective columns when performing INSERT queries. Default value: true (replacing is enabled). |
|
input_format_null_as_default |
See in-depth description in ClickHouse documentation. |
|
date_time_input_format |
enum DateTimeInputFormat See in-depth description in ClickHouse documentation.
|
|
input_format_with_names_use_header |
See in-depth description in ClickHouse documentation. |
|
output_format_json_quote_64bit_integers |
Enables quoting of 64-bit integers in JSON output format. If this setting is enabled, then 64-bit integers (UInt64 and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. Default value: false (quoting 64-bit integers is disabled). |
|
output_format_json_quote_denormals |
Enables special floating-point values (+nan, -nan, +inf and -inf) in JSON output format. Default value: false (special values do not present in output). |
|
date_time_output_format |
enum DateTimeOutputFormat See in-depth description in ClickHouse documentation.
|
|
low_cardinality_allow_in_native_format |
Determines whether to use LowCardinality type in Native format.
LowCardinality columns (aka sparse columns) store data in more effective way, compared to regular columns, by using hash tables. If you use a third-party ClickHouse client that can't work with LowCardinality columns, then this client will not be able to correctly interpret the result of the query that asks for data stored in LowCardinality column. Official ClickHouse client works with LowCardinality columns out-of-the-box. Default value: true (LowCardinality columns are used in Native format). |
|
allow_suspicious_low_cardinality_types |
Allows specifying LowCardinality modifier for types of small fixed size (8 or less) in CREATE TABLE statements. Enabling this may increase merge times and memory consumption. More info see in ClickHouse documentation. |
|
empty_result_for_aggregation_by_empty_set |
Enables returning of empty result when aggregating without keys (with GROUP BY operation absent) on empty set (e.g., SELECT count(*) FROM table WHERE 0).
|
|
http_connection_timeout |
HTTP connection timeout, in milliseconds. Value must be greater than 0 (default: 1000, 1 second). |
|
http_receive_timeout |
HTTP receive timeout, in milliseconds. Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes). |
|
http_send_timeout |
HTTP send timeout, in milliseconds. Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes). |
|
enable_http_compression |
Enables or disables data compression in HTTP responses. By default, ClickHouse stores data compressed. When executing a query, its result is uncompressed. Enable this setting and add the Accept-Encoding: ClickHouse support the following compression methods: gzip, br and deflate. Default value: false (compression is disabled). See in-depth description in ClickHouse documentation. |
|
send_progress_in_http_headers |
Enables progress notifications using X-ClickHouse-Progress HTTP header. Default value: false (notifications disabled). |
|
http_headers_progress_interval |
Minimum interval between progress notifications with X-ClickHouse-Progress HTTP header, in milliseconds. Value must be greater than 0 (default: 100). |
|
add_http_cors_header |
Adds CORS header in HTTP responses. Default value: false (header is not added). |
|
cancel_http_readonly_queries_on_client_close |
Cancels HTTP read-only queries (e.g. SELECT) when a client closes the connection without waiting for the response. Default value: false. More info see in ClickHouse documentation. |
|
max_http_get_redirects |
Limits the maximum number of HTTP GET redirect hops for URL-engine tables. If the parameter is set to 0 (default), no hops is allowed. More info see in ClickHouse documentation. |
|
joined_subquery_requires_alias |
|
|
join_use_nulls |
|
|
transform_null_in |
|
|
quota_mode |
enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.
|
|
flatten_nested |
Sets the data format of a nested columns. More info see in ClickHouse documentation. |
|
format_regexp |
string Regular expression (for Regexp format) |
|
format_regexp_escaping_rule |
enum FormatRegexpEscapingRule See in-depth description in ClickHouse documentation.
|
|
format_regexp_skip_unmatched |
See in-depth description in ClickHouse documentation. |
|
async_insert |
Enables asynchronous inserts. Disabled by default. More info see in ClickHouse documentation. |
|
async_insert_threads |
The maximum number of threads for background data parsing and insertion. If the parameter is set to 0, asynchronous insertions are disabled. Default value: 16. More info see in ClickHouse documentation. |
|
wait_for_async_insert |
Enables waiting for processing of asynchronous insertion. If enabled, server returns OK only after the data is inserted. More info see in ClickHouse documentation. |
|
wait_for_async_insert_timeout |
The timeout (in seconds) for waiting for processing of asynchronous insertion. Default value: 120. More info see in ClickHouse documentation. |
|
async_insert_max_data_size |
The maximum size of the unparsed data in bytes collected per query before being inserted. If the parameter is set to 0, asynchronous insertions are disabled. Default value: 100000. More info see in ClickHouse documentation. |
|
async_insert_busy_timeout |
The maximum timeout in milliseconds since the first INSERT query before inserting collected data. If the parameter is set to 0, the timeout is disabled. Default value: 200. More info see in ClickHouse documentation. |
|
async_insert_stale_timeout |
The maximum timeout in milliseconds since the last INSERT query before dumping collected data. If enabled, the settings prolongs the More info see in ClickHouse documentation. |
|
memory_profiler_step |
Memory profiler step (in bytes). If the next query step requires more memory than this parameter specifies, the memory profiler collects the allocating stack trace. Values lower than a few megabytes slow down query processing. Default value: 4194304 (4 MB). Zero means disabled memory profiler. |
|
memory_profiler_sample_probability |
Collect random allocations and deallocations and write them into system.trace_log with 'MemorySample' trace_type. The probability is for every alloc/free regardless to the size of the allocation. Possible values: from 0 to 1. Default: 0. |
|
max_final_threads |
Sets the maximum number of parallel threads for the SELECT query data read phase with the FINAL modifier. |
|
input_format_parallel_parsing |
Enables or disables order-preserving parallel parsing of data formats. Supported only for TSV, TKSV, CSV and JSONEachRow formats. |
|
input_format_import_nested_json |
Enables or disables the insertion of JSON data with nested objects. |
|
local_filesystem_read_method |
enum LocalFilesystemReadMethod Method of reading data from local filesystem, one of: read, pread, mmap, io_uring, pread_threadpool. The 'io_uring' method is experimental and does not work for Log, TinyLog, StripeLog, File, Set and Join, and other tables with append-able files in presence of concurrent reads and writes.
|
|
max_read_buffer_size |
The maximum size of the buffer to read from the filesystem. |
|
insert_keeper_max_retries |
The setting sets the maximum number of retries for ClickHouse Keeper (or ZooKeeper) requests during insert into replicated MergeTree. Only Keeper requests which failed due to network error, Keeper session timeout, or request timeout are considered for retries. |
|
max_temporary_data_on_disk_size_for_user |
The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running user queries. Zero means unlimited. |
|
max_temporary_data_on_disk_size_for_query |
The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running queries. Zero means unlimited. |
|
max_parser_depth |
Limits maximum recursion depth in the recursive descent parser. Allows controlling the stack size. |
|
remote_filesystem_read_method |
enum RemoteFilesystemReadMethod Method of reading data from remote filesystem, one of: read, threadpool.
|
|
memory_overcommit_ratio_denominator |
It represents soft memory limit in case when hard limit is reached on user level. This value is used to compute overcommit ratio for the query. Zero means skip the query. |
|
memory_overcommit_ratio_denominator_for_user |
It represents soft memory limit in case when hard limit is reached on global level. This value is used to compute overcommit ratio for the query. Zero means skip the query. |
|
memory_usage_overcommit_max_wait_microseconds |
Maximum time thread will wait for memory to be freed in the case of memory overcommit on a user level. If the timeout is reached and memory is not freed, an exception is thrown. |
|
log_query_threads |
Setting up query threads logging. Query threads log into the system.query_thread_log table. This setting has effect only when log_queries is true. Queries threads run by ClickHouse with this setup are logged according to the rules in the query_thread_log server configuration parameter. |
|
max_insert_threads |
The maximum number of threads to execute the INSERT SELECT query. |
|
use_hedged_requests |
Enables hedged requests logic for remote queries. It allows to establish many connections with different replicas for query. New connection is enabled in case existent connection(s) with replica(s) were not established within hedged_connection_timeout or no data was received within receive_data_timeout. Query uses the first connection which send non empty progress packet (or data packet, if allow_changing_replica_until_first_data_packet); other connections are cancelled. Queries with max_parallel_replicas > 1 are supported. |
|
idle_connection_timeout |
Timeout to close idle TCP connections after specified number of milliseconds. |
|
hedged_connection_timeout_ms |
Connection timeout for establishing connection with replica for Hedged requests. |
|
load_balancing |
enum LoadBalancing Specifies the algorithm of replicas selection that is used for distributed query processing, one of: random, nearest_hostname, in_order, first_or_random, round_robin.
|
|
prefer_localhost_replica |
Enables/disables preferable using the localhost replica when processing distributed queries. |
|
compile |
The setting is deprecated and has no effect. |
|
min_count_to_compile |
The setting is deprecated and has no effect. |
UserQuota
ClickHouse quota representation. Each quota associated with an user and limits it resource usage for an interval.
See in-depth description ClickHouse documentation.
|
Field |
Description |
|
interval_duration |
Duration of interval for quota in milliseconds. |
|
queries |
The total number of queries. |
|
errors |
The number of queries that threw exception. |
|
result_rows |
The total number of rows given as the result.. |
|
read_rows |
The total number of source rows read from tables for running the query, on all remote servers. |
|
execution_time |
The total query execution time, in milliseconds (wall time). |
HostSpec
|
Field |
Description |
|
zone_id |
string ID of the availability zone where the host resides. |
|
type |
enum Type Required field. Type of the host to be deployed.
|
|
subnet_id |
string ID of the subnet that the host should belong to. This subnet should be a part |
|
assign_public_ip |
bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign Possible values:
|
|
shard_name |
string Name of the shard that the host is assigned to. |
MaintenanceWindow
A maintenance window settings.
|
Field |
Description |
|
anytime |
Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
|
weekly_maintenance_window |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
Weelky maintenance window settings.
|
Field |
Description |
|
day |
enum WeekDay Day of the week (in
|
|
hour |
int64 Hour of the day in UTC (in |
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"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"environment": "Environment",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"clickhouse": {
"config": {
"effective_config": {
"log_level": "LogLevel",
"merge_tree": {
"replicated_deduplication_window": "google.protobuf.Int64Value",
"replicated_deduplication_window_seconds": "google.protobuf.Int64Value",
"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_replicated_merges_in_queue": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_lower_max_size_of_merge": "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",
"ttl_only_drop_parts": "google.protobuf.BoolValue",
"allow_remote_fs_zero_copy_replication": "google.protobuf.BoolValue",
"merge_with_ttl_timeout": "google.protobuf.Int64Value",
"merge_with_recompression_ttl_timeout": "google.protobuf.Int64Value",
"max_parts_in_total": "google.protobuf.Int64Value",
"max_number_of_merges_with_ttl_in_pool": "google.protobuf.Int64Value",
"cleanup_delay_period": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_execute_mutation": "google.protobuf.Int64Value",
"max_avg_part_size_for_too_many_parts": "google.protobuf.Int64Value",
"min_age_to_force_merge_seconds": "google.protobuf.Int64Value",
"min_age_to_force_merge_on_partition_only": "google.protobuf.BoolValue",
"merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"merge_max_block_size": "google.protobuf.Int64Value",
"check_sample_column_is_correct": "google.protobuf.BoolValue",
"max_merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"max_cleanup_delay_period": "google.protobuf.Int64Value"
},
"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",
"max_array_size": "int64"
},
// 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"
},
"max_connections": "google.protobuf.Int64Value",
"max_concurrent_queries": "google.protobuf.Int64Value",
"keep_alive_timeout": "google.protobuf.Int64Value",
"uncompressed_cache_size": "google.protobuf.Int64Value",
"mark_cache_size": "google.protobuf.Int64Value",
"max_table_size_to_drop": "google.protobuf.Int64Value",
"max_partition_size_to_drop": "google.protobuf.Int64Value",
"builtin_dictionaries_reload_interval": "google.protobuf.Int64Value",
"timezone": "string",
"geobase_enabled": "google.protobuf.BoolValue",
"geobase_uri": "string",
"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",
"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",
"default_database": "google.protobuf.StringValue",
"total_memory_profiler_step": "google.protobuf.Int64Value",
"total_memory_tracker_sample_probability": "google.protobuf.DoubleValue",
"query_masking_rules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionaries_lazy_load": "google.protobuf.BoolValue",
"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"
}
},
"user_config": {
"log_level": "LogLevel",
"merge_tree": {
"replicated_deduplication_window": "google.protobuf.Int64Value",
"replicated_deduplication_window_seconds": "google.protobuf.Int64Value",
"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_replicated_merges_in_queue": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_lower_max_size_of_merge": "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",
"ttl_only_drop_parts": "google.protobuf.BoolValue",
"allow_remote_fs_zero_copy_replication": "google.protobuf.BoolValue",
"merge_with_ttl_timeout": "google.protobuf.Int64Value",
"merge_with_recompression_ttl_timeout": "google.protobuf.Int64Value",
"max_parts_in_total": "google.protobuf.Int64Value",
"max_number_of_merges_with_ttl_in_pool": "google.protobuf.Int64Value",
"cleanup_delay_period": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_execute_mutation": "google.protobuf.Int64Value",
"max_avg_part_size_for_too_many_parts": "google.protobuf.Int64Value",
"min_age_to_force_merge_seconds": "google.protobuf.Int64Value",
"min_age_to_force_merge_on_partition_only": "google.protobuf.BoolValue",
"merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"merge_max_block_size": "google.protobuf.Int64Value",
"check_sample_column_is_correct": "google.protobuf.BoolValue",
"max_merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"max_cleanup_delay_period": "google.protobuf.Int64Value"
},
"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",
"max_array_size": "int64"
},
// 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"
},
"max_connections": "google.protobuf.Int64Value",
"max_concurrent_queries": "google.protobuf.Int64Value",
"keep_alive_timeout": "google.protobuf.Int64Value",
"uncompressed_cache_size": "google.protobuf.Int64Value",
"mark_cache_size": "google.protobuf.Int64Value",
"max_table_size_to_drop": "google.protobuf.Int64Value",
"max_partition_size_to_drop": "google.protobuf.Int64Value",
"builtin_dictionaries_reload_interval": "google.protobuf.Int64Value",
"timezone": "string",
"geobase_enabled": "google.protobuf.BoolValue",
"geobase_uri": "string",
"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",
"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",
"default_database": "google.protobuf.StringValue",
"total_memory_profiler_step": "google.protobuf.Int64Value",
"total_memory_tracker_sample_probability": "google.protobuf.DoubleValue",
"query_masking_rules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionaries_lazy_load": "google.protobuf.BoolValue",
"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"
}
},
"default_config": {
"log_level": "LogLevel",
"merge_tree": {
"replicated_deduplication_window": "google.protobuf.Int64Value",
"replicated_deduplication_window_seconds": "google.protobuf.Int64Value",
"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_replicated_merges_in_queue": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_lower_max_size_of_merge": "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",
"ttl_only_drop_parts": "google.protobuf.BoolValue",
"allow_remote_fs_zero_copy_replication": "google.protobuf.BoolValue",
"merge_with_ttl_timeout": "google.protobuf.Int64Value",
"merge_with_recompression_ttl_timeout": "google.protobuf.Int64Value",
"max_parts_in_total": "google.protobuf.Int64Value",
"max_number_of_merges_with_ttl_in_pool": "google.protobuf.Int64Value",
"cleanup_delay_period": "google.protobuf.Int64Value",
"number_of_free_entries_in_pool_to_execute_mutation": "google.protobuf.Int64Value",
"max_avg_part_size_for_too_many_parts": "google.protobuf.Int64Value",
"min_age_to_force_merge_seconds": "google.protobuf.Int64Value",
"min_age_to_force_merge_on_partition_only": "google.protobuf.BoolValue",
"merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"merge_max_block_size": "google.protobuf.Int64Value",
"check_sample_column_is_correct": "google.protobuf.BoolValue",
"max_merge_selecting_sleep_ms": "google.protobuf.Int64Value",
"max_cleanup_delay_period": "google.protobuf.Int64Value"
},
"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",
"max_array_size": "int64"
},
// 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"
},
"max_connections": "google.protobuf.Int64Value",
"max_concurrent_queries": "google.protobuf.Int64Value",
"keep_alive_timeout": "google.protobuf.Int64Value",
"uncompressed_cache_size": "google.protobuf.Int64Value",
"mark_cache_size": "google.protobuf.Int64Value",
"max_table_size_to_drop": "google.protobuf.Int64Value",
"max_partition_size_to_drop": "google.protobuf.Int64Value",
"builtin_dictionaries_reload_interval": "google.protobuf.Int64Value",
"timezone": "string",
"geobase_enabled": "google.protobuf.BoolValue",
"geobase_uri": "string",
"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",
"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",
"default_database": "google.protobuf.StringValue",
"total_memory_profiler_step": "google.protobuf.Int64Value",
"total_memory_tracker_sample_probability": "google.protobuf.DoubleValue",
"query_masking_rules": [
{
"name": "string",
"regexp": "string",
"replace": "string"
}
],
"dictionaries_lazy_load": "google.protobuf.BoolValue",
"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"
}
}
},
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
}
},
"zookeeper": {
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
}
},
"backup_window_start": "google.type.TimeOfDay",
"access": {
"data_lens": "bool",
"web_sql": "bool",
"metrika": "bool",
"serverless": "bool",
"data_transfer": "bool",
"yandex_query": "bool"
},
"cloud_storage": {
"enabled": "bool",
"move_factor": "google.protobuf.DoubleValue",
"data_cache_enabled": "google.protobuf.BoolValue",
"data_cache_max_size": "google.protobuf.Int64Value",
"prefer_not_to_merge": "google.protobuf.BoolValue"
},
"sql_database_management": "google.protobuf.BoolValue",
"sql_user_management": "google.protobuf.BoolValue",
"embedded_keeper": "google.protobuf.BoolValue",
"backup_retain_period_days": "google.protobuf.Int64Value"
},
"network_id": "string",
"health": "Health",
"status": "Status",
"service_account_id": "string",
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"planned_operation": {
"info": "string",
"delayed_until": "google.protobuf.Timestamp"
},
"security_group_ids": [
"string"
],
"deletion_protection": "bool"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateClusterMetadata
|
Field |
Description |
|
cluster_id |
string ID of the ClickHouse cluster that is being created. |
Cluster
A ClickHouse Cluster resource. For more information, see the
Cluster section in the Developer's Guide.
|
Field |
Description |
|
id |
string ID of the ClickHouse cluster. |
|
folder_id |
string ID of the folder that the ClickHouse cluster belongs to. |
|
created_at |
Creation timestamp in RFC3339 text format. |
|
name |
string Name of the ClickHouse cluster. |
|
description |
string Description of the ClickHouse cluster. 0-256 characters long. |
|
labels |
object (map<string, string>) Custom labels for the ClickHouse cluster as |
|
environment |
enum Environment Deployment environment of the ClickHouse cluster.
|
|
monitoring[] |
Description of monitoring systems relevant to the ClickHouse cluster. |
|
config |
Configuration of the ClickHouse cluster. |
|
network_id |
string ID of the network that the cluster belongs to. |
|
health |
enum Health Aggregated cluster health.
|
|
status |
enum Status Current state of the cluster.
|
|
service_account_id |
string ID of the service account used for access to Object Storage. |
|
maintenance_window |
Maintenance window for the cluster. |
|
planned_operation |
Planned maintenance operation to be started for the cluster within the nearest |
|
security_group_ids[] |
string User security groups |
|
deletion_protection |
bool Deletion Protection inhibits deletion of the cluster |
Monitoring
Monitoring system metadata.
|
Field |
Description |
|
name |
string Name of the monitoring system. |
|
description |
string Description of the monitoring system. |
|
link |
string Link to the monitoring system charts for the ClickHouse cluster. |
ClusterConfig
|
Field |
Description |
|
version |
string Version of the ClickHouse server software. |
|
clickhouse |
Configuration and resource allocation for ClickHouse hosts. |
|
zookeeper |
Configuration and resource allocation for ZooKeeper hosts. |
|
backup_window_start |
Time to start the daily backup, in the UTC timezone. |
|
access |
Access policy for external services. |
|
cloud_storage |
|
|
sql_database_management |
Whether database management through SQL commands is enabled. |
|
sql_user_management |
Whether user management through SQL commands is enabled. |
|
embedded_keeper |
Whether cluster should use embedded Keeper instead of Zookeeper. |
|
backup_retain_period_days |
Retain period of automatically created backup in days |
Clickhouse
|
Field |
Description |
|
config |
Configuration settings of a ClickHouse server. |
|
resources |
Resources allocated to ClickHouse hosts. |
ClickhouseConfigSet
|
Field |
Description |
|
effective_config |
Required field. Effective settings for a ClickHouse cluster (a combination of settings defined |
|
user_config |
User-defined settings for a ClickHouse cluster. |
|
default_config |
Default configuration for a ClickHouse cluster. |
ClickhouseConfig
ClickHouse configuration options. Detailed description for each set of options
is available in ClickHouse documentation.
Any options not listed here are not supported.
|
Field |
Description |
|
log_level |
enum LogLevel Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
|
|
merge_tree |
Settings for the MergeTree engine. |
|
compression[] |
Compression settings for the ClickHouse cluster. |
|
dictionaries[] |
Configuration of external dictionaries to be used by the ClickHouse cluster. |
|
graphite_rollup[] |
Settings for thinning Graphite data. |
|
kafka |
|
|
kafka_topics[] |
|
|
rabbitmq |
|
|
max_connections |
Maximum number of inbound connections. |
|
max_concurrent_queries |
Maximum number of simultaneously processed requests. |
|
keep_alive_timeout |
Number of milliseconds that ClickHouse waits for incoming requests before closing the connection. |
|
uncompressed_cache_size |
Cache size (in bytes) for uncompressed data used by MergeTree tables. |
|
mark_cache_size |
Approximate size (in bytes) of the cache of "marks" used by MergeTree tables. |
|
max_table_size_to_drop |
Maximum size of the table that can be deleted using a DROP query. |
|
max_partition_size_to_drop |
Maximum size of the partition that can be deleted using a DROP query. |
|
builtin_dictionaries_reload_interval |
The setting is deprecated and has no effect. |
|
timezone |
string The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier. |
|
geobase_enabled |
Enable or disable geobase. |
|
geobase_uri |
string Address of the archive with the user geobase in Object Storage. |
|
query_log_retention_size |
The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
query_log_retention_time |
The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of |
|
query_thread_log_enabled |
Whether query_thread_log system table is enabled. |
|
query_thread_log_retention_size |
The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
query_thread_log_retention_time |
The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of |
|
part_log_retention_size |
The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
part_log_retention_time |
The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of |
|
metric_log_enabled |
Whether metric_log system table is enabled. |
|
metric_log_retention_size |
The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
metric_log_retention_time |
The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of |
|
trace_log_enabled |
Whether trace_log system table is enabled. |
|
trace_log_retention_size |
The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
trace_log_retention_time |
The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of |
|
text_log_enabled |
Whether text_log system table is enabled. |
|
text_log_retention_size |
The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of |
|
text_log_retention_time |
The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of |
|
text_log_level |
enum LogLevel Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
|
|
opentelemetry_span_log_enabled |
Enable or disable opentelemetry_span_log system table. Default value: false. |
|
opentelemetry_span_log_retention_size |
The maximum size that opentelemetry_span_log can grow to before old data will be removed. If set to 0 (default), |
|
opentelemetry_span_log_retention_time |
The maximum time that opentelemetry_span_log records will be retained before removal. If set to 0, |
|
query_views_log_enabled |
Enable or disable query_views_log system table. Default value: false. |
|
query_views_log_retention_size |
The maximum size that query_views_log can grow to before old data will be removed. If set to 0 (default), |
|
query_views_log_retention_time |
The maximum time that query_views_log records will be retained before removal. If set to 0, |
|
asynchronous_metric_log_enabled |
Enable or disable asynchronous_metric_log system table. Default value: false. |
|
asynchronous_metric_log_retention_size |
The maximum size that asynchronous_metric_log can grow to before old data will be removed. If set to 0 (default), |
|
asynchronous_metric_log_retention_time |
The maximum time that asynchronous_metric_log records will be retained before removal. If set to 0, |
|
session_log_enabled |
Enable or disable session_log system table. Default value: false. |
|
session_log_retention_size |
The maximum size that session_log can grow to before old data will be removed. If set to 0 (default), |
|
session_log_retention_time |
The maximum time that session_log records will be retained before removal. If set to 0, |
|
zookeeper_log_enabled |
Enable or disable zookeeper_log system table. Default value: false. |
|
zookeeper_log_retention_size |
The maximum size that zookeeper_log can grow to before old data will be removed. If set to 0 (default), |
|
zookeeper_log_retention_time |
The maximum time that zookeeper_log records will be retained before removal. If set to 0, |
|
asynchronous_insert_log_enabled |
Enable or disable asynchronous_insert_log system table. Default value: false. |
|
asynchronous_insert_log_retention_size |
The maximum size that asynchronous_insert_log can grow to before old data will be removed. If set to 0 (default), |
|
asynchronous_insert_log_retention_time |
The maximum time that asynchronous_insert_log records will be retained before removal. If set to 0, |
|
background_pool_size |
|
|
background_merges_mutations_concurrency_ratio |
Sets a ratio between the number of threads and the number of background merges and mutations that can be executed concurrently. For example, if the ratio equals to 2 and background_pool_size is set to 16 then ClickHouse can execute 32 background merges concurrently. This is possible, because background operations could be suspended and postponed. This is needed to give small merges more execution priority. You can only increase this ratio at runtime. To lower it you have to restart the server. The same as for background_pool_size setting background_merges_mutations_concurrency_ratio could be applied from the default profile for backward compatibility. |
|
background_schedule_pool_size |
|
|
background_fetches_pool_size |
Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8. More info see in ClickHouse documentation. |
|
background_move_pool_size |
|
|
background_distributed_schedule_pool_size |
|
|
background_buffer_flush_schedule_pool_size |
|
|
background_message_broker_schedule_pool_size |
|
|
background_common_pool_size |
The maximum number of threads that will be used for performing a variety of operations (mostly garbage collection) for *MergeTree-engine tables in a background. |
|
default_database |
The default database. To get a list of cluster databases, see Yandex Managed ClickHouse documentation. |
|
total_memory_profiler_step |
Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304. More info see in ClickHouse documentation. |
|
total_memory_tracker_sample_probability |
|
|
query_masking_rules[] |
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. |
|
dictionaries_lazy_load |
Lazy loading of dictionaries. |
|
query_cache |
Query cache configuration. |
MergeTree
Options specific to the MergeTree table engine.
|
Field |
Description |
|
replicated_deduplication_window |
Number of blocks of hashes to keep in ZooKeeper. |
|
replicated_deduplication_window_seconds |
Period of time to keep blocks of hashes for. |
|
parts_to_delay_insert |
If table contains at least that many active parts in single partition, artificially slow down insert into table. |
|
parts_to_throw_insert |
If more than this number active parts in single partition, throw 'Too many parts ...' exception. |
|
inactive_parts_to_delay_insert |
|
|
inactive_parts_to_throw_insert |
|
|
max_replicated_merges_in_queue |
How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue. |
|
number_of_free_entries_in_pool_to_lower_max_size_of_merge |
If there is less than specified number of free entries in background pool (or replicated queue), start to lower |
|
max_bytes_to_merge_at_min_space_in_pool |
Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries |
|
max_bytes_to_merge_at_max_space_in_pool |
|
|
min_bytes_for_wide_part |
Minimum number of bytes in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
|
min_rows_for_wide_part |
Minimum number of rows in a data part that can be stored in Wide format. More info see in ClickHouse documentation. |
|
ttl_only_drop_parts |
Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables. More info see in ClickHouse documentation. |
|
allow_remote_fs_zero_copy_replication |
|
|
merge_with_ttl_timeout |
|
|
merge_with_recompression_ttl_timeout |
|
|
max_parts_in_total |
|
|
max_number_of_merges_with_ttl_in_pool |
|
|
cleanup_delay_period |
|
|
number_of_free_entries_in_pool_to_execute_mutation |
|
|
max_avg_part_size_for_too_many_parts |
The 'too many parts' check according to 'parts_to_delay_insert' and 'parts_to_throw_insert' will be active only if the average part size (in the relevant partition) is not larger than the specified threshold. If it is larger than the specified threshold, the INSERTs will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts. |
|
min_age_to_force_merge_seconds |
Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds. |
|
min_age_to_force_merge_on_partition_only |
Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset. |
|
merge_selecting_sleep_ms |
Sleep time for merge selecting when no part is selected. A lower setting triggers selecting tasks in background_schedule_pool frequently, which results in a large number of requests to ClickHouse Keeper in large-scale clusters. |
|
merge_max_block_size |
The number of rows that are read from the merged parts into memory. |
|
check_sample_column_is_correct |
Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct. The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64. |
|
max_merge_selecting_sleep_ms |
Maximum sleep time for merge selecting, a lower setting will trigger selecting tasks in background_schedule_pool frequently which result in large amount of requests to zookeeper in large-scale clusters. |
|
max_cleanup_delay_period |
Maximum period to clean old queue logs, blocks hashes and parts. |
Compression
|
Field |
Description |
|
method |
enum Method Compression method to use for the specified combination of
|
|
min_part_size |
int64 Minimum size of a part of a table. |
|
min_part_size_ratio |
double Minimum ratio of a part relative to the size of all the data in the table. |
|
level |
ExternalDictionary
|
Field |
Description |
|
name |
string Required field. Name of the external dictionary. |
|
structure |
Required field. Set of attributes for the external dictionary. |
|
layout |
Required field. Layout for storing the dictionary in memory. |
|
fixed_lifetime |
int64 Fixed interval between dictionary updates. Includes only one of the fields Setting for the period of time between dictionary updates. |
|
lifetime_range |
Range of intervals between dictionary updates for ClickHouse to choose from. Includes only one of the fields Setting for the period of time between dictionary updates. |
|
http_source |
HTTP source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
mysql_source |
MySQL source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
clickhouse_source |
ClickHouse source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
mongodb_source |
MongoDB source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
|
postgresql_source |
PostgreSQL source for the dictionary. Includes only one of the fields Description of the source for the external dictionary. |
Structure
|
Field |
Description |
|
id |
Single numeric key column for the dictionary. |
|
key |
Composite key for the dictionary, containing of one or more key columns. |
|
range_min |
Field holding the beginning of the range for dictionaries with |
|
range_max |
Field holding the end of the range for dictionaries with |
|
attributes[] |
Description of the fields available for database queries. |
Id
Numeric key.
|
Field |
Description |
|
name |
string Required field. Name of the numeric key. |
Key
Complex key.
|
Field |
Description |
|
attributes[] |
Attributes of a complex key. |
Attribute
|
Field |
Description |
|
name |
string Required field. Name of the column. |
|
type |
string Required field. Type of the column. |
|
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. |
|
injective |
bool Indication of injective mapping "id -> attribute". |
Layout
Layout determining how to store the dictionary in memory.
|
Field |
Description |
|
type |
enum Type Required field. Layout type for an external dictionary.
|
|
size_in_cells |
int64 Number of cells in the cache. Rounded up to a power of two. |
|
max_array_size |
int64 Maximum dictionary key size. |
Range
|
Field |
Description |
|
min |
int64 Minimum dictionary lifetime. |
|
max |
int64 Maximum dictionary lifetime. |
HttpSource
|
Field |
Description |
|
url |
string Required field. URL of the source dictionary available over HTTP. |
|
format |
string Required field. The data format. Valid values are all formats supported by ClickHouse SQL dialect. |
|
headers[] |
HTTP headers. |
Header
|
Field |
Description |
|
name |
string Required field. |
|
value |
string Required field. |
MysqlSource
|
Field |
Description |
|
db |
string Required field. Name of the MySQL database to connect to. |
|
table |
string Required field. Name of the database table to use as a ClickHouse dictionary. |
|
port |
int64 Default port to use when connecting to a replica of the dictionary source. |
|
user |
string Name of the default user for replicas of the dictionary source. |
|
password |
string Password of the default user for replicas of the dictionary source. |
|
replicas[] |
List of MySQL replicas of the database used as dictionary source. |
|
where |
string Selection criteria for the data in the specified MySQL table. |
|
invalidate_query |
string Query for checking the dictionary status, to pull only updated data. |
|
close_connection |
Should the connection be closed after each request. |
|
share_connection |
Should a connection be shared for some requests. |
Replica
|
Field |
Description |
|
host |
string Required field. MySQL host of the replica. |
|
priority |
int64 Required field. The priority of the replica that ClickHouse takes into account when connecting. |
|
port |
int64 Port to use when connecting to the replica. |
|
user |
string Name of the MySQL database user. |
|
password |
string Password of the MySQL database user. |
ClickhouseSource
|
Field |
Description |
|
db |
string Required field. Name of the ClickHouse database. |
|
table |
string Required field. Name of the table in the specified database to be used as the dictionary source. |
|
host |
string ClickHouse host of the specified database. |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the ClickHouse database user. |
|
password |
string Password of the ClickHouse database user. |
|
where |
string Selection criteria for the data in the specified ClickHouse table. |
|
secure |
Use ssl for connection. |
MongodbSource
|
Field |
Description |
|
db |
string Required field. Name of the MongoDB database. |
|
collection |
string Required field. Name of the collection in the specified database to be used as the dictionary source. |
|
host |
string MongoDB host of the specified database. |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the MongoDB database user. |
|
password |
string Password of the MongoDB database user. |
|
options |
string |
PostgresqlSource
|
Field |
Description |
|
db |
string Required field. Name of the PostrgreSQL database. |
|
table |
string Required field. Name of the table in the specified database to be used as the dictionary source. |
|
hosts[] |
string Name of the PostrgreSQL host |
|
port |
int64 Port to use when connecting to the host. |
|
user |
string Required field. Name of the PostrgreSQL database user. |
|
password |
string Password of the PostrgreSQL database user. |
|
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.
|
GraphiteRollup
Rollup settings for the GraphiteMergeTree table engine.
|
Field |
Description |
|
name |
string Required field. Name for the specified combination of settings for Graphite rollup. |
|
patterns[] |
Pattern to use for the rollup. |
|
path_column_name |
string The name of the column storing the metric name (Graphite sensor). |
|
time_column_name |
string The name of the column storing the time of measuring the metric. |
|
value_column_name |
string The name of the column storing the value of the metric at the time set in time_column_name. |
|
version_column_name |
string The name of the column storing the version of the metric. |
Pattern
|
Field |
Description |
|
regexp |
string Pattern for metric names. |
|
function |
string Required field. Name of the aggregating function to apply to data of the age specified in |
|
retention[] |
Age of data to use for thinning. |
Retention
|
Field |
Description |
|
age |
int64 Minimum age of the data in seconds. |
|
precision |
int64 Precision of determining the age of the data, in seconds. |
Kafka
|
Field |
Description |
|
security_protocol |
enum SecurityProtocol
|
|
sasl_mechanism |
enum SaslMechanism
|
|
sasl_username |
string |
|
sasl_password |
string |
|
enable_ssl_certificate_verification |
|
|
max_poll_interval_ms |
|
|
session_timeout_ms |
|
|
debug |
enum Debug
|
|
auto_offset_reset |
enum AutoOffsetReset
|
KafkaTopic
|
Field |
Description |
|
name |
string Required field. |
|
settings |
Required field. |
Rabbitmq
|
Field |
Description |
|
username |
string RabbitMQ username |
|
password |
string RabbitMQ password |
|
vhost |
string RabbitMQ virtual host |
QueryMaskingRule
|
Field |
Description |
|
name |
string Name for the rule. |
|
regexp |
string Required field. RE2 compatible regular expression. |
|
replace |
string Substitution string for sensitive data. |
QueryCache
|
Field |
Description |
|
max_size_in_bytes |
The maximum cache size in bytes. |
|
max_entries |
The maximum number of SELECT query results stored in the cache. |
|
max_entry_size_in_bytes |
The maximum size in bytes SELECT query results may have to be saved in the cache. |
|
max_entry_size_in_rows |
The maximum number of rows SELECT query results may have to be saved in the cache. |
Resources
|
Field |
Description |
|
resource_preset_id |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
|
disk_size |
int64 Volume of the storage available to a host, in bytes. |
|
disk_type_id |
string Type of the storage environment for the host.
|
Zookeeper
|
Field |
Description |
|
resources |
Resources allocated to ZooKeeper hosts. |
Access
|
Field |
Description |
|
data_lens |
bool Allow to export data from the cluster to DataLens. |
|
web_sql |
bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
|
metrika |
bool Allow to import data from Yandex Metrica and AppMetrica to the cluster. See AppMetrica documentation for more details. |
|
serverless |
bool Allow access to cluster for Serverless. |
|
data_transfer |
bool Allow access for DataTransfer |
|
yandex_query |
bool Allow access for Query |
CloudStorage
|
Field |
Description |
|
enabled |
bool Whether to use Object Storage for storing ClickHouse data. |
|
move_factor |
|
|
data_cache_enabled |
|
|
data_cache_max_size |
|
|
prefer_not_to_merge |
MaintenanceWindow
A maintenance window settings.
|
Field |
Description |
|
anytime |
Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
|
weekly_maintenance_window |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
Weelky maintenance window settings.
|
Field |
Description |
|
day |
enum WeekDay Day of the week (in
|
|
hour |
int64 Hour of the day in UTC (in |
MaintenanceOperation
A planned maintenance operation.
|
Field |
Description |
|
info |
string Information about this maintenance operation. |
|
delayed_until |
Time until which this maintenance operation is delayed. |