yandex_mdb_clickhouse_cluster_v2 (Resource)

Статья создана

Обновлена 26 января 2026 г.

Example usage
Schema
Import

Manages a ClickHouse cluster within the Yandex Cloud. For more information, see the official documentation. How to connect to the DB. To connect, use port 9440. The port number is not configurable.

Example usage

//
// Create a new MDB Clickhouse Cluster.
//
resource "yandex_mdb_clickhouse_cluster_v2" "my_cluster" {
    name        = "test"
    environment = "PRESTABLE"
    network_id  = yandex_vpc_network.foo.id

    clickhouse = {
        resources = {
            resource_preset_id = "s2.micro"
            disk_type_id       = "network-ssd"
            disk_size          = 32
        }

        config = {
            log_level                       = "TRACE"
            max_connections                 = 100
            max_concurrent_queries          = 50
            keep_alive_timeout              = 3000
            uncompressed_cache_size         = 8589934592
            max_table_size_to_drop          = 53687091200
            max_partition_size_to_drop      = 53687091200
            timezone                        = "UTC"
            geobase_uri                     = ""
            query_log_retention_size        = 1073741824
            query_log_retention_time        = 2592000
            query_thread_log_enabled        = true
            query_thread_log_retention_size = 536870912
            query_thread_log_retention_time = 2592000
            part_log_retention_size         = 536870912
            part_log_retention_time         = 2592000
            metric_log_enabled              = true
            metric_log_retention_size       = 536870912
            metric_log_retention_time       = 2592000
            trace_log_enabled               = true
            trace_log_retention_size        = 536870912
            trace_log_retention_time        = 2592000
            text_log_enabled                = true
            text_log_retention_size         = 536870912
            text_log_retention_time         = 2592000
            text_log_level                  = "TRACE"
            background_pool_size            = 16
            background_schedule_pool_size   = 16

            merge_tree = {
                replicated_deduplication_window                           = 100
                replicated_deduplication_window_seconds                   = 604800
                parts_to_delay_insert                                     = 150
                parts_to_throw_insert                                     = 300
                max_replicated_merges_in_queue                            = 16
                number_of_free_entries_in_pool_to_lower_max_size_of_merge = 8
                max_bytes_to_merge_at_min_space_in_pool                   = 1048576
                max_bytes_to_merge_at_max_space_in_pool                   = 161061273600
            }

            kafka = {
                security_protocol = "SECURITY_PROTOCOL_PLAINTEXT"
                sasl_mechanism    = "SASL_MECHANISM_GSSAPI"
                sasl_username     = "user1"
                sasl_password     = "pass1"
            }

            rabbitmq = {
                username = "rabbit_user"
                password = "rabbit_pass"
            }

            compression = [
                {
                    method              = "LZ4"
                    min_part_size       = 1024
                    min_part_size_ratio = 0.5
                },
                {
                    method              = "ZSTD"
                    min_part_size       = 2048
                    min_part_size_ratio = 0.7
                },
            ]

            graphite_rollup = [
                {
                    name = "rollup1"
                    patterns = [{
                        regexp   = "abc"
                        function = "func1"
                        retention = [{
                            age       = 1000
                            precision = 3
                        }]
                    }]
                },
                {
                    name = "rollup2"
                    patterns = [{
                        function = "func2"
                        retention = [{
                            age       = 2000
                            precision = 5
                        }]
                    }]
                }
            ]
        }
    }

    hosts = {
        "h1" = {
            type      = "CLICKHOUSE"
            zone      = "ru-central1-a"
            subnet_id = yandex_vpc_subnet.foo.id
        }
    }

    format_schema {
        name = "test_schema"
        type = "FORMAT_SCHEMA_TYPE_CAPNPROTO"
        uri  = "https://storage.yandexcloud.net/ch-data/schema.proto"
    }

    service_account_id = "your_service_account_id"

    cloud_storage = {
        enabled = false
    }

    maintenance_window {
        type = "ANYTIME"
    }
}

resource "yandex_vpc_network" "foo" {}

resource "yandex_vpc_subnet" "foo" {
  zone           = "ru-central1-a"
  network_id     = yandex_vpc_network.foo.id
  v4_cidr_blocks = ["10.5.0.0/24"]
}

//
// Create a new MDB High Availability Clickhouse Cluster.
//
resource "yandex_mdb_clickhouse_cluster_v2" "my_cluster" {
  name        = "ha"
  environment = "PRESTABLE"
  network_id  = yandex_vpc_network.foo.id

  clickhouse = {
    resources = {
      resource_preset_id = "s2.micro"
      disk_type_id       = "network-ssd"
      disk_size          = 16
    }
  }

  zookeeper = {
    resources = {
      resource_preset_id = "s2.micro"
      disk_type_id       = "network-ssd"
      disk_size          = 10
    }
  }

  hosts = {
    "ka" = {
      type      = "KEEPER"
      zone      = "ru-central1-a"
      subnet_id = yandex_vpc_subnet.foo.id
    }
    "kb" = {
      type      = "KEEPER"
      zone      = "ru-central1-b"
      subnet_id = yandex_vpc_subnet.bar.id
    }
    "kd" = {
      type      = "KEEPER"
      zone      = "ru-central1-d"
      subnet_id = yandex_vpc_subnet.baz.id
    }
    "ca" = {
      type      = "CLICKHOUSE"
      zone      = "ru-central1-a"
      subnet_id = yandex_vpc_subnet.foo.id
    }
    "cb" = {
      type      = "CLICKHOUSE"
      zone      = "ru-central1-b"
      subnet_id = yandex_vpc_subnet.bar.id
    }
  }

  cloud_storage = {
    enabled = false
  }

  maintenance_window {
    type = "ANYTIME"
  }
}

// Auxiliary resources
resource "yandex_vpc_network" "foo" {}

resource "yandex_vpc_subnet" "foo" {
  zone           = "ru-central1-a"
  network_id     = yandex_vpc_network.foo.id
  v4_cidr_blocks = ["10.1.0.0/24"]
}

resource "yandex_vpc_subnet" "bar" {
  zone           = "ru-central1-b"
  network_id     = yandex_vpc_network.foo.id
  v4_cidr_blocks = ["10.2.0.0/24"]
}

resource "yandex_vpc_subnet" "baz" {
  zone           = "ru-central1-d"
  network_id     = yandex_vpc_network.foo.id
  v4_cidr_blocks = ["10.3.0.0/24"]
}

//
// Create a new MDB Sharded Clickhouse Cluster.
//
resource "yandex_mdb_clickhouse_cluster_v2" "my_cluster" {
  name        = "sharded"
  environment = "PRODUCTION"
  network_id  = yandex_vpc_network.foo.id

  clickhouse = {
    resources = {
      resource_preset_id = "s2.micro"
      disk_type_id       = "network-ssd"
      disk_size          = 16
    }
  }

  zookeeper = {
    resources = {
      resource_preset_id = "s2.micro"
      disk_type_id       = "network-ssd"
      disk_size          = 10
    }
  }

  shards = {
    "shard1" = {
      weight = 110
    }
    "shard2" = {
      weight = 300
    }
  }

  hosts = {
    "c1a" = {
      type       = "CLICKHOUSE"
      zone       = "ru-central1-a"
      subnet_id  = yandex_vpc_subnet.foo.id
      shard_name = "shard1"
    }
    "c1b" = {
      type       = "CLICKHOUSE"
      zone       = "ru-central1-b"
      subnet_id  = yandex_vpc_subnet.bar.id
      shard_name = "shard1"
    }
    "c2a" = {
      type       = "CLICKHOUSE"
      zone       = "ru-central1-b"
      subnet_id  = yandex_vpc_subnet.bar.id
      shard_name = "shard2"
    }
    "c2d" = {
      type       = "CLICKHOUSE"
      zone       = "ru-central1-d"
      subnet_id  = yandex_vpc_subnet.baz.id
      shard_name = "shard2"
    }
  }

  shard_group {
    name        = "single_shard_group"
    description = "Cluster configuration that contain only shard1"
    shard_names = [
      "shard1",
    ]
  }

  cloud_storage = {
    enabled = false
  }

  maintenance_window {
    type = "ANYTIME"
  }
}

// Auxiliary resources
resource "yandex_vpc_network" "foo" {}

resource "yandex_vpc_subnet" "foo" {
  zone           = "ru-central1-a"
  network_id     = yandex_vpc_network.foo.id
  v4_cidr_blocks = ["10.1.0.0/24"]
}

resource "yandex_vpc_subnet" "bar" {
  zone           = "ru-central1-b"
  network_id     = yandex_vpc_network.foo.id
  v4_cidr_blocks = ["10.2.0.0/24"]
}

resource "yandex_vpc_subnet" "baz" {
  zone           = "ru-central1-d"
  network_id     = yandex_vpc_network.foo.id
  v4_cidr_blocks = ["10.3.0.0/24"]
}

Schema

Required

environment (String) Deployment environment of the ClickHouse cluster.
hosts (Attributes Map) A host configuration of the ClickHouse cluster. (see below for nested schema)
name (String) Name of the ClickHouse cluster. Provided by the client when the cluster is created.
network_id (String) The VPC Network ID of subnets which resource attached to.

Optional

access (Attributes) Access policy to the ClickHouse cluster. (see below for nested schema)
admin_password (String, Sensitive) A password used to authorize as user admin when sql_user_management enabled.
backup_retain_period_days (Number) The period in days during which backups are stored.
backup_window_start (Attributes) Time to start the daily backup, in the UTC timezone. (see below for nested schema)
clickhouse (Attributes) Configuration of the ClickHouse subcluster. (see below for nested schema)
cloud_storage (Attributes) Cloud Storage settings. (see below for nested schema)
copy_schema_on_new_hosts (Boolean) Whether to copy schema on new ClickHouse hosts.
deletion_protection (Boolean) The true value means that resource is protected from accidental deletion.
description (String) The resource description.
disk_encryption_key_id (String) ID of the KMS key for cluster disk encryption.
embedded_keeper (Boolean) Whether to use ClickHouse Keeper as a coordination system.
folder_id (String) The folder identifier that resource belongs to. If it is not provided, the default provider folder-id is used.
format_schema (Block Set) A set of protobuf or capnproto format schemas. (see below for nested schema)
labels (Map of String) A set of key/value label pairs which assigned to resource.
maintenance_window (Block, Optional) Maintenance window settings. (see below for nested schema)
ml_model (Block Set) A group of machine learning models. (see below for nested schema)
security_group_ids (Set of String) The list of security groups applied to resource or their components.
service_account_id (String) Service account which linked to the resource.
shard_group (Block List) A group of clickhouse shards. (see below for nested schema)
shards (Attributes Map) A shards of the ClickHouse cluster. (see below for nested schema)
sql_database_management (Boolean) Grants admin user database management permission.
sql_user_management (Boolean) Enables admin user with user management permission.
timeouts (Attributes) (see below for nested schema)
version (String) Version of the ClickHouse server software.
zookeeper (Attributes) Configuration of the ZooKeeper subcluster. (see below for nested schema)

Read-Only

cluster_id (String) ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
created_at (String) The creation timestamp of the resource.
id (String) The resource identifier.

Nested Schema for `hosts`

Required:

type (String) The type of the host to be deployed. Can be either CLICKHOUSE or ZOOKEEPER.
zone (String) The availability zone where resource is located. If it is not provided, the default provider zone will be used.

Optional:

assign_public_ip (Boolean) Whether the host should get a public IP address.
shard_name (String) The name of the shard to which the host belongs.
subnet_id (String) ID of the subnet where the host is located.

Read-Only:

fqdn (String) The fully qualified domain name of the host.

Nested Schema for `access`

Optional:

data_lens (Boolean) Allow access for DataLens.
data_transfer (Boolean) Allow access for DataTransfer.
metrika (Boolean) Allow access for Yandex.Metrika.
serverless (Boolean) Allow access for Serverless.
web_sql (Boolean) Allow access for Web SQL.
yandex_query (Boolean) Allow access for YandexQuery.

Nested Schema for `backup_window_start`

Optional:

hours (Number) The hour at which backup will be started (UTC).
minutes (Number) The minute at which backup will be started (UTC).

Nested Schema for `clickhouse`

Required:

resources (Attributes) Resources allocated to hosts. (see below for nested schema)

Optional:

config (Attributes) Configuration of the ClickHouse subcluster. (see below for nested schema)

Nested Schema for `clickhouse.resources`

Required:

disk_size (Number) Volume of the storage available to a host, in gigabytes.
disk_type_id (String) Type of the storage of hosts. For more information see the official documentation.
resource_preset_id (String) The ID of the preset for computational resources available to a host (CPU, memory etc.). For more information, see the official documentation.

Nested Schema for `clickhouse.config`

Optional:

access_control_improvements (Attributes) Access control settings. (see below for nested schema)
async_insert_threads (Number) Maximum number of threads to parse and insert data in background.
asynchronous_insert_log_enabled (Boolean) Enable or disable asynchronous_insert_log system table.
asynchronous_insert_log_retention_size (Number) The maximum size that asynchronous_insert_log can grow to before old data will be removed.
asynchronous_insert_log_retention_time (Number) The maximum time that asynchronous_insert_log records will be retained before removal.
asynchronous_metric_log_enabled (Boolean) Enable or disable asynchronous_metric_log system table.
asynchronous_metric_log_retention_size (Number) The maximum size that asynchronous_metric_log can grow to before old data will be removed.
asynchronous_metric_log_retention_time (Number) The maximum time that asynchronous_metric_log records will be retained before removal.
background_buffer_flush_schedule_pool_size (Number) The maximum number of threads that will be used for performing flush operations for Buffer-engine tables in the background.
background_common_pool_size (Number) 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.
background_distributed_schedule_pool_size (Number) The maximum number of threads that will be used for executing distributed sends.
background_fetches_pool_size (Number) The maximum number of threads that will be used for fetching data parts from another replica for MergeTree-engine tables in a background.
background_merges_mutations_concurrency_ratio (Number) Sets a ratio between the number of threads and the number of background merges and mutations that can be executed concurrently.
background_message_broker_schedule_pool_size (Number) The maximum number of threads that will be used for executing background operations for message streaming.
background_move_pool_size (Number) The maximum number of threads that will be used for moving data parts to another disk or volume for MergeTree-engine tables in a background.
background_pool_size (Number) Sets the number of threads performing background merges and mutations for MergeTree-engine tables.
background_schedule_pool_size (Number) The maximum number of threads that will be used for constantly executing some lightweight periodic operations for replicated tables, Kafka streaming, and DNS cache updates.
backup_threads (Number) The maximum number of threads to execute BACKUP requests.
compression (Attributes List) Data compression configuration. (see below for nested schema)
custom_macros (Attributes List) Custom ClickHouse macros. (see below for nested schema)
default_database (String) Default database name.
dictionaries_lazy_load (Boolean) Lazy loading of dictionaries. If true, then each dictionary is loaded on the first use.
error_log_enabled (Boolean) Enables or disables error_log system table.
error_log_retention_size (Number) The maximum size that error_log can grow to before old data will be removed. If set to 0, automatic removal of error_log data based on size is disabled.
error_log_retention_time (Number) The maximum time that error_log records will be retained before removal. If set to 0, automatic removal of error_log data based on time is disabled.
geobase_enabled (Boolean) Enable or disable geobase.
geobase_uri (String) Address of the archive with the user geobase in Object Storage.
graphite_rollup (Attributes List) Graphite rollup configuration. (see below for nested schema)
jdbc_bridge (Attributes) JDBC bridge configuration. (see below for nested schema)
kafka (Attributes) Kafka connection configuration. (see below for nested schema)
keep_alive_timeout (Number) The number of seconds that ClickHouse waits for incoming requests for HTTP protocol before closing the connection.
log_level (String) Logging level.
max_concurrent_queries (Number) Limit on total number of concurrently executed queries.
max_connections (Number) Max server connections.
max_partition_size_to_drop (Number) Restriction on dropping partitions.
max_table_size_to_drop (Number) Restriction on deleting tables.
merge_tree (Attributes) MergeTree engine configuration. (see below for nested schema)
metric_log_enabled (Boolean) Enable or disable metric_log system table.
metric_log_retention_size (Number) The maximum size that metric_log can grow to before old data will be removed.
metric_log_retention_time (Number) The maximum time that metric_log records will be retained before removal.
mysql_protocol (Boolean) Enables or disables MySQL interface on ClickHouse server.
opentelemetry_span_log_enabled (Boolean) Enable or disable opentelemetry_span_log system table.
opentelemetry_span_log_retention_size (Number) The maximum size that opentelemetry_span_log can grow to before old data will be removed.
opentelemetry_span_log_retention_time (Number) The maximum time that opentelemetry_span_log records will be retained before removal.
part_log_retention_size (Number) The maximum size that part_log can grow to before old data will be removed.
part_log_retention_time (Number) The maximum time that part_log records will be retained before removal.
processors_profile_log_enabled (Boolean) Enables or disables processors_profile_log system table.
processors_profile_log_retention_size (Number) The maximum time that processors_profile_log records will be retained before removal. If set to 0, automatic removal of processors_profile_log data based on time is disabled.
processors_profile_log_retention_time (Number) Enables or disables error_log system table.
query_cache (Attributes) Query cache configuration. (see below for nested schema)
query_log_retention_size (Number) The maximum size that query_log can grow to before old data will be removed.
query_log_retention_time (Number) The maximum time that query_log records will be retained before removal.
query_masking_rules (Attributes List) Query masking rules configuration. (see below for nested schema)
query_thread_log_enabled (Boolean) Enable or disable query_thread_log system table.
query_thread_log_retention_size (Number) The maximum size that query_thread_log can grow to before old data will be removed.
query_thread_log_retention_time (Number) The maximum time that query_thread_log records will be retained before removal.
query_views_log_enabled (Boolean) Enable or disable query_views_log system table.
query_views_log_retention_size (Number) The maximum size that query_views_log can grow to before old data will be removed.
query_views_log_retention_time (Number) The maximum time that query_views_log records will be retained before removal.
rabbitmq (Attributes) RabbitMQ connection configuration. (see below for nested schema)
restore_threads (Number) The maximum number of threads to execute RESTORE requests.
session_log_enabled (Boolean) Enable or disable session_log system table.
session_log_retention_size (Number) The maximum size that session_log can grow to before old data will be removed.
session_log_retention_time (Number) The maximum time that session_log records will be retained before removal.
text_log_enabled (Boolean) Enable or disable text_log system table.
text_log_level (String) Logging level for text_log system table.
text_log_retention_size (Number) The maximum size that text_log can grow to before old data will be removed.
text_log_retention_time (Number) The maximum time that text_log records will be retained before removal.
timezone (String) The server's time zone.
total_memory_profiler_step (Number) Whenever server memory usage becomes larger than every next step in number of bytes the memory profiler will collect the allocating stack trace.
total_memory_tracker_sample_probability (Number) Allows to collect random allocations and de-allocations and writes them in the system.trace_log system table with trace_type equal to a MemorySample with the specified probability.
trace_log_enabled (Boolean) Enable or disable trace_log system table.
trace_log_retention_size (Number) The maximum size that trace_log can grow to before old data will be removed.
trace_log_retention_time (Number) The maximum time that trace_log records will be retained before removal.
uncompressed_cache_size (Number) Cache size (in bytes) for uncompressed data used by table engines from the MergeTree family. Zero means disabled.
zookeeper_log_enabled (Boolean) Enable or disable zookeeper_log system table.
zookeeper_log_retention_size (Number) The maximum size that zookeeper_log can grow to before old data will be removed.
zookeeper_log_retention_time (Number) The maximum time that zookeeper_log records will be retained before removal.

Nested Schema for `clickhouse.config.access_control_improvements`

Optional:

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

Nested Schema for `clickhouse.config.compression`

Required:

method (String) Compression method. Two methods are available: LZ4 and zstd.
min_part_size (Number) Min part size: Minimum size (in bytes) of a data part in a table. ClickHouse only applies the rule to tables with data parts greater than or equal to the Min part size value.
min_part_size_ratio (Number) Min part size ratio: Minimum table part size to total table size ratio. ClickHouse only applies the rule to tables in which this ratio is greater than or equal to the Min part size ratio value.

Optional:

level (Number) Compression level for ZSTD method.

Nested Schema for `clickhouse.config.custom_macros`

Required:

name (String) Name of the macro.
value (String) Value of the macro.

Nested Schema for `clickhouse.config.graphite_rollup`

Required:

name (String) Graphite rollup configuration name.

Optional:

path_column_name (String) The name of the column storing the metric name (Graphite sensor). Default value: Path.
patterns (Attributes List) Set of thinning rules. (see below for nested schema)
time_column_name (String) The name of the column storing the time of measuring the metric. Default value: Time.
value_column_name (String) The name of the column storing the value of the metric at the time set in time_column_name. Default value: Value.
version_column_name (String) The name of the column storing the version of the metric. Default value: Timestamp.

Nested Schema for `clickhouse.config.graphite_rollup.patterns`

Required:

function (String) Aggregation function name.

Optional:

regexp (String) Regular expression that the metric name must match.
retention (Attributes List) Retain parameters. (see below for nested schema)

Nested Schema for `clickhouse.config.graphite_rollup.version_column_name.retention`

Required:

age (Number) Minimum data age in seconds.
precision (Number) Accuracy of determining the age of the data in seconds.

Nested Schema for `clickhouse.config.jdbc_bridge`

Required:

host (String) Host of jdbc bridge.

Optional:

port (Number) Port of jdbc bridge. Default value: 9019.

Nested Schema for `clickhouse.config.kafka`

Optional:

auto_offset_reset (String) Action when no initial offset: 'smallest','earliest','largest','latest','error'.
debug (String) A comma-separated list of debug contexts to enable.
enable_ssl_certificate_verification (Boolean) Enable verification of SSL certificates.
max_poll_interval_ms (Number) Maximum allowed time between calls to consume messages. If exceeded, consumer is considered failed.
sasl_mechanism (String) SASL mechanism used in kafka authentication.
sasl_password (String, Sensitive) User password on kafka server.
sasl_username (String) Username on kafka server.
security_protocol (String) Security protocol used to connect to kafka server.
session_timeout_ms (Number) Client group session and failure detection timeout.

Nested Schema for `clickhouse.config.merge_tree`

Optional:

check_sample_column_is_correct (Boolean) Enables the check at table creation that the sampling column type is correct. Default value: true.
cleanup_delay_period (Number) Minimum period to clean old queue logs, blocks hashes and parts.
deduplicate_merge_projection_mode (String) Determines the behavior of background merges for MergeTree tables with projections.
fsync_after_insert (Boolean) Do fsync for every inserted part. Significantly decreases performance of inserts, not recommended to use with wide parts.
fsync_part_directory (Boolean) Do fsync for part directory after all part operations (writes, renames, etc.).
inactive_parts_to_delay_insert (Number) If the number of inactive parts in a single partition in the table at least that many the inactive_parts_to_delay_insert value, an INSERT artificially slows down. It is useful when a server fails to clean up parts quickly enough.
inactive_parts_to_throw_insert (Number) If the number of inactive parts in a single partition more than the inactive_parts_to_throw_insert value, INSERT is interrupted with the Too many inactive parts (N). Parts cleaning are processing significantly slower than inserts exception.
lightweight_mutation_projection_mode (String) Determines the behavior of lightweight deletes for MergeTree tables with projections.
materialize_ttl_recalculate_only (Boolean) Only recalculate ttl info when MATERIALIZE TTL.
max_avg_part_size_for_too_many_parts (Number) The too many parts check will be active only if the average part size is not larger than the specified threshold. This allows large tables if parts are successfully merged.
max_bytes_to_merge_at_max_space_in_pool (Number) The maximum total parts size (in bytes) to be merged into one part, if there are enough resources available. Roughly corresponds to the maximum possible part size created by an automatic background merge.
max_bytes_to_merge_at_min_space_in_pool (Number) Max bytes to merge at min space in pool: Maximum total size of a data part to merge when the number of free threads in the background pool is minimum.
max_cleanup_delay_period (Number) Maximum period to clean old queue logs, blocks hashes and parts. Default value: 300 seconds.
max_merge_selecting_sleep_ms (Number) Maximum sleep time for merge selecting. Default value: 60000 milliseconds (60 seconds).
max_number_of_merges_with_ttl_in_pool (Number) When there is more than specified number of merges with TTL entries in pool, do not assign new merge with TTL.
max_parts_in_total (Number) Maximum number of parts in all partitions.
max_replicated_merges_in_queue (Number) Max replicated merges in queue: Maximum number of merge tasks that can be in the ReplicatedMergeTree queue at the same time.
merge_max_block_size (Number) The number of rows that are read from the merged parts into memory. Default value: 8192.
merge_selecting_sleep_ms (Number) Sleep time for merge selecting when no part is selected. Lower values increase ZooKeeper requests in large clusters.
merge_with_recompression_ttl_timeout (Number) Minimum delay in seconds before repeating a merge with recompression TTL. Default value: 14400 seconds (4 hours).
merge_with_ttl_timeout (Number) Minimum delay in seconds before repeating a merge with delete TTL. Default value: 14400 seconds (4 hours).
min_age_to_force_merge_on_partition_only (Boolean) Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset.
min_age_to_force_merge_seconds (Number) Merge parts if every part in the range is older than the value of min_age_to_force_merge_seconds.
min_bytes_for_wide_part (Number) Minimum number of bytes in a data part that can be stored in Wide format. You can set one, both or none of these settings.
min_compressed_bytes_to_fsync_after_fetch (Number) Minimal number of rows to do fsync for part after merge. 0 means disabled.
min_compressed_bytes_to_fsync_after_merge (Number) Minimal number of compressed bytes to do fsync for part after merge. 0 means disabled.
min_rows_for_wide_part (Number) Minimum number of rows in a data part that can be stored in Wide format. You can set one, both or none of these settings.
min_rows_to_fsync_after_merge (Number) Minimal number of rows to do fsync for part after merge. 0 means disabled.
number_of_free_entries_in_pool_to_execute_mutation (Number) When there is less than specified number of free entries in pool, do not execute part mutations. This is to leave free threads for regular merges and avoid Too many parts. Default value: 20.
number_of_free_entries_in_pool_to_lower_max_size_of_merge (Number) Number of free entries in pool to lower max size of merge: Threshold value of free entries in the pool. If the number of entries in the pool falls below this value, ClickHouse reduces the maximum size of a data part to merge. This helps handle small merges faster, rather than filling the pool with lengthy merges.
parts_to_delay_insert (Number) Parts to delay insert: Number of active data parts in a table, on exceeding which ClickHouse starts artificially reduce the rate of inserting data into the table
parts_to_throw_insert (Number) Parts to throw insert: Threshold value of active data parts in a table, on exceeding which ClickHouse throws the 'Too many parts ...' exception.
replicated_deduplication_window (Number) Replicated deduplication window: Number of recent hash blocks that ZooKeeper will store (the old ones will be deleted).
replicated_deduplication_window_seconds (Number) Replicated deduplication window seconds: Time during which ZooKeeper stores the hash blocks (the old ones will be deleted).
ttl_only_drop_parts (Boolean) Enables zero-copy replication when a replica is located on a remote filesystem.

Nested Schema for `clickhouse.config.query_cache`

Optional:

max_entries (Number) The maximum number of SELECT query results stored in the cache. Default value: 1024.
max_entry_size_in_bytes (Number) The maximum size in bytes SELECT query results may have to be saved in the cache. Default value: 1048576 (1 MiB).
max_entry_size_in_rows (Number) The maximum number of rows SELECT query results may have to be saved in the cache. Default value: 30000000 (30 mil).
max_size_in_bytes (Number) The maximum cache size in bytes. 0 means the query cache is disabled. Default value: 1073741824 (1 GiB).

Nested Schema for `clickhouse.config.query_masking_rules`

Required:

regexp (String) RE2 compatible regular expression.

Optional:

name (String) Name for the rule.
replace (String) Substitution string for sensitive data. Default value: six asterisks.

Nested Schema for `clickhouse.config.rabbitmq`

Optional:

password (String, Sensitive) RabbitMQ user password.
username (String) RabbitMQ username.
vhost (String) RabbitMQ vhost. Default: \.

Nested Schema for `cloud_storage`

Required:

enabled (Boolean) Whether to use Yandex Object Storage for storing ClickHouse data. Can be either true or false.

Optional:

data_cache_enabled (Boolean) Enables temporary storage in the cluster repository of data requested from the object repository.
data_cache_max_size (Number) Defines the maximum amount of memory (in bytes) allocated in the cluster storage for temporary storage of data requested from the object storage.
move_factor (Number) Sets the minimum free space ratio in the cluster storage. If the free space is lower than this value, the data is transferred to Yandex Object Storage. Acceptable values are 0 to 1, inclusive.
prefer_not_to_merge (Boolean) Disables merging of data parts in Yandex Object Storage.

Nested Schema for `format_schema`

Required:

name (String) The name of the format schema.
type (String) Type of the format schema.
uri (String) Format schema file URL. You can only use format schemas stored in Yandex Object Storage.

Nested Schema for `maintenance_window`

Required:

type (String) Type of maintenance window. Can be either ANYTIME or WEEKLY. A day and hour of window need to be specified with weekly window.

Optional:

day (String) Day of week for maintenance window if window type is weekly. Possible values: MON, TUE, WED, THU, FRI, SAT, SUN.
hour (Number) Hour of day in UTC time zone (1-24) for maintenance window if window type is weekly.

Nested Schema for `ml_model`

Required:

name (String) The name of the ml model.
type (String) Type of the model.
uri (String) Model file URL. You can only use models stored in Yandex Object Storage.

Nested Schema for `shard_group`

Required:

name (String) The name of the shard group, used as cluster name in Distributed tables.
shard_names (List of String) List of shards names that belong to the shard group.

Optional:

description (String) Description of the shard group.

Nested Schema for `shards`

Optional:

resources (Attributes) Resources allocated to hosts. (see below for nested schema)
weight (Number) The weight of shard.

Nested Schema for `shards.resources`

Optional:

disk_size (Number) Volume of the storage available to a host, in gigabytes.
disk_type_id (String) Type of the storage of hosts. For more information see the official documentation.
resource_preset_id (String) The ID of the preset for computational resources available to a host (CPU, memory etc.). For more information, see the official documentation.

Nested Schema for `timeouts`

Optional:

create (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
delete (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
update (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Nested Schema for `zookeeper`

Required:

resources (Attributes) Resources allocated to hosts. (see below for nested schema)

Nested Schema for `zookeeper.resources`

Required:

disk_size (Number) Volume of the storage available to a host, in gigabytes.
disk_type_id (String) Type of the storage of hosts. For more information see the official documentation.
resource_preset_id (String) The ID of the preset for computational resources available to a host (CPU, memory etc.). For more information, see the official documentation.

Import

The resource can be imported by using their resource ID. For getting the resource ID you can use Yandex Cloud Web Console or YC CLI.

# terraform import yandex_mdb_clickhouse_cluster_v2.<resource Name> <resource Id>
terraform import yandex_mdb_clickhouse_cluster_v2.my_cluster cluster_id

yandex_mdb_clickhouse_cluster_v2 (Resource)

Example usageExample usage

SchemaSchema

RequiredRequired

OptionalOptional

Read-OnlyRead-Only

Nested Schema for Nested Schema for hosts

Nested Schema for Nested Schema for access

Nested Schema for Nested Schema for backup_window_start

Nested Schema for Nested Schema for clickhouse

Nested Schema for Nested Schema for clickhouse.resources

Nested Schema for Nested Schema for clickhouse.config

Nested Schema for Nested Schema for clickhouse.config.access_control_improvements

Nested Schema for Nested Schema for clickhouse.config.compression

Nested Schema for Nested Schema for clickhouse.config.custom_macros

Nested Schema for Nested Schema for clickhouse.config.graphite_rollup

Nested Schema for Nested Schema for clickhouse.config.graphite_rollup.patterns

Nested Schema for Nested Schema for clickhouse.config.graphite_rollup.version_column_name.retention

Nested Schema for Nested Schema for clickhouse.config.jdbc_bridge

Nested Schema for Nested Schema for clickhouse.config.kafka

Nested Schema for Nested Schema for clickhouse.config.merge_tree

Nested Schema for Nested Schema for clickhouse.config.query_cache

Nested Schema for Nested Schema for clickhouse.config.query_masking_rules

Nested Schema for Nested Schema for clickhouse.config.rabbitmq

Nested Schema for Nested Schema for cloud_storage

Nested Schema for Nested Schema for format_schema

Nested Schema for Nested Schema for maintenance_window

Nested Schema for Nested Schema for ml_model

Nested Schema for Nested Schema for shard_group

Nested Schema for Nested Schema for shards

Nested Schema for Nested Schema for shards.resources

Nested Schema for Nested Schema for timeouts

Nested Schema for Nested Schema for zookeeper

Nested Schema for Nested Schema for zookeeper.resources

ImportImport

Была ли статья полезна?

Example usage

Schema

Required

Optional

Read-Only

Nested Schema for `hosts`

Nested Schema for `access`

Nested Schema for `backup_window_start`

Nested Schema for `clickhouse`

Nested Schema for `clickhouse.resources`

Nested Schema for `clickhouse.config`

Nested Schema for `clickhouse.config.access_control_improvements`

Nested Schema for `clickhouse.config.compression`

Nested Schema for `clickhouse.config.custom_macros`

Nested Schema for `clickhouse.config.graphite_rollup`

Nested Schema for `clickhouse.config.graphite_rollup.patterns`

Nested Schema for `clickhouse.config.graphite_rollup.version_column_name.retention`

Nested Schema for `clickhouse.config.jdbc_bridge`

Nested Schema for `clickhouse.config.kafka`

Nested Schema for `clickhouse.config.merge_tree`

Nested Schema for `clickhouse.config.query_cache`

Nested Schema for `clickhouse.config.query_masking_rules`

Nested Schema for `clickhouse.config.rabbitmq`

Nested Schema for `cloud_storage`

Nested Schema for `format_schema`

Nested Schema for `maintenance_window`

Nested Schema for `ml_model`

Nested Schema for `shard_group`

Nested Schema for `shards`

Nested Schema for `shards.resources`

Nested Schema for `timeouts`

Nested Schema for `zookeeper`

Nested Schema for `zookeeper.resources`

Import