Changing ClickHouse® settings at the server level

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To configure ClickHouse®:

1. View the full list of settings for the cluster:

   yc managed-clickhouse cluster get <cluster_name_or_ID> --full
   

2. View the description of the CLI command for updating the cluster configuration:

   yc managed-clickhouse cluster update-config --help
   

3. Set the parameter values as needed:

   yc managed-clickhouse cluster update-config <cluster_name_or_ID> \
      --set <parameter_1_name>=<value_1>,...
   

To configure ClickHouse®:

1. Open the current Terraform configuration file describing your infrastructure.

   For more on how to create this file, see Creating a cluster.

2. In the Managed Service for ClickHouse® cluster description, under clickhouse.config, edit the parameters as follows:

   resource "yandex_mdb_clickhouse_cluster_v2" "<cluster_name>" {
     ...
     clickhouse = {
       ...
   
       config = {
         # General DBMS settings
         ...
   
         merge_tree = {
           # MergeTree engine settings
           ...
         }
   
         kafka = {
           # General settings for getting data from Apache Kafka
           ...
         }
   
         rabbit_mq = {
           # Settings for getting data from RabbitMQ
           username = "<username>"
           password = "<password>"
         }
   
         compression = [
           {
             # Data compression settings
             method              = "<compression_method>"
             min_part_size       = <data_part_size>
             min_part_size_ratio = <size_ratio>
           }
         ]
   
         graphite_rollup = [
           {
             # GraphiteMergeTree engine settings for data thinning, aggregation, and rollup in Graphite.
             ...
           }
         ]
       }
       ...
     }
     ...
   }
   

   Where:

   • method: Compression method, LZ4 or ZSTD.
   • min_part_size: Minimum size of a table data part, in bytes.
   • min_part_size_ratio: Ratio of the smallest data part size to the full table size.

3. Validate your configuration.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_clickhouse_cluster_v2" "<cluster_name>" {
  ...
  timeouts = {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
      --request PATCH \
      --header "Authorization: Bearer $IAM_TOKEN" \
      --header "Content-Type: application/json" \
      --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>' \
      --data '{
                 "updateMask": "configSpec.clickhouse.config.<setting_1>,...,configSpec.clickhouse.config.<setting_N>",
                 "configSpec": {
                    "clickhouse": {
                       "config": {
                          "<setting_1>": "<value_1>",
                          "<setting_2>": "<value_2>",
                          ...
                          "<setting_N>": "<value_N>"
                       }
                    }
                 }
              }'
   

   Where:

   • updateMask: Comma-separated string of settings to update.
   • configSpec.clickhouse.config: ClickHouse® server-level settings. For the list of possible parameters and their values, see the method description.

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
      -format json \
      -import-path ~/cloudapi/ \
      -import-path ~/cloudapi/third_party/googleapis/ \
      -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
      -rpc-header "Authorization: Bearer $IAM_TOKEN" \
      -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
                "paths": [
                   "configSpec.clickhouse.config.<setting_1>",
                   "configSpec.clickhouse.config.<setting_2>",
                   ...
                   "configSpec.clickhouse.config.<setting_N>"
                ]
             },
             "config_spec": {
                "clickhouse": {
                   "config": {
                      "<setting_1>": "<value_1>",
                      "<setting_2>": "<value_2>",
                      ...
                      "<setting_N>": "<value_N>"
                   }
                }
             }
          }' \
      mdb.api.cloud.yandex.net:443 \
      yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings to update as an array of strings (paths[]).
   • config_spec.clickhouse.config: ClickHouse® server-level settings. For the list of possible parameters and their values, see the method description.

   You can request the cluster ID with the list of clusters in the folder.

4. View the server response to make sure your request was successful.