Managing databases in Managed Service for ClickHouse®

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To get the list of databases in a cluster, run this command:

yc managed-clickhouse database list \
   --cluster-name=<cluster_name>

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

1. Get an IAM token for API authentication and place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Database.List method and send the following request, e.g., via cURL:

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/databases'
   

   You can get the cluster ID from the folder’s cluster list.

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

1. Get an IAM token for API authentication and place it in 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 the repository contents are stored in the ~/cloudapi/ directory.

3. Use the DatabaseService.List call and send the following request, e.g., via gRPCurl:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/database_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<cluster_ID>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.DatabaseService.List
   

   You can get the cluster ID from the folder’s cluster list.

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

1. Connect to your cluster as admin.

2. Get the list of databases:

   SHOW DATABASES;
   

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

Run the database create command, providing a name for the new database:

yc managed-clickhouse database create <DB_name> \
   --cluster-name=<cluster_name>

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

Managed Service for ClickHouse® will initiate creating the database.

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

   For more information about creating this file, see Creating clusters.

2. Add the yandex_mdb_clickhouse_database resource:

   resource "yandex_mdb_clickhouse_database" "<DB_name>" {
     cluster_id = "<cluster_ID>"
     name       = "<DB_name>"
   }
   

   Note

   The DB name may contain Latin letters, numbers, and underscores. The name may be up to 63 characters long. You cannot create a database named default.

   When creating a cluster with Terraform at the same time as creating a database, specify a name for the new cluster rather than cluster ID in the yandex_mdb_clickhouse_database resource:

   
   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     name = "<cluster_name>"
     ...
   }
   
   resource "yandex_mdb_clickhouse_database" "<DB_name>" {
     cluster_id = yandex_mdb_clickhouse_cluster.<cluster_name>.id
     name       = "<DB_name>"
   }
   

3. Make sure the settings are correct.

   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 resource changes.

   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 article.

1. Get an IAM token for API authentication and place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Database.Create method and send the following request, e.g., via cURL:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/databases' \
       --data '{
                 "databaseSpec": {
                   "name": "<DB_name>",
                   "engine": "<database_engine>"
                 }
               }'
   

   Where:

   • databaseSpec.name: Database name.

     Note

     The DB name may contain Latin letters, numbers, and underscores. The name may be up to 63 characters long. You cannot create a database named default.

   • databaseSpec.engine: Database engine. The allowed values are:

     • DATABASE_ENGINE_ATOMIC (default): The Atomic engine. Supports non-blocking DROP TABLE and RENAME TABLE operations, and atomic EXCHANGE TABLES operations.

     • DATABASE_ENGINE_REPLICATED: The Replicated engine. Supports table metadata replication across all database replicas. The set of tables and their schemas will be the same for all replicas.

       Available only in replicated clusters.

     • DATABASE_ENGINE_UNSPECIFIED: This value will set the default engine, i.e., DATABASE_ENGINE_ATOMIC.

     You set the engine when creating the database and cannot change it for this database.

   You can get the cluster ID from the folder’s cluster list.

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

1. Get an IAM token for API authentication and place it in 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 the repository contents are stored in the ~/cloudapi/ directory.

3. Use the DatabaseService.Create call and send the following request, e.g., via gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/database_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "database_spec": {
               "name": "<DB_name>",
               "engine": "<database_engine>"
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.DatabaseService.Create
   

   Where:

   • database_spec.name: Database name.

     Note

     The DB name may contain Latin letters, numbers, and underscores. The name may be up to 63 characters long. You cannot create a database named default.

   • database_spec.engine: Database engine. The allowed values are:

     • DATABASE_ENGINE_ATOMIC (default): The Atomic engine. Supports non-blocking DROP TABLE and RENAME TABLE operations, and atomic EXCHANGE TABLES operations.

     • DATABASE_ENGINE_REPLICATED: The Replicated engine. Supports table metadata replication across all database replicas. The set of tables and their schemas will be the same for all replicas.

       Available only in replicated clusters.

     • DATABASE_ENGINE_UNSPECIFIED: This value will set the default engine, i.e., DATABASE_ENGINE_ATOMIC.

     You set the engine when creating the database and cannot change it for this database.

   You can get the cluster ID from the folder’s cluster list.

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

1. Connect to your cluster as admin.

2. Create a database:

   CREATE DATABASE <DB_name>;
   

   Note

   The DB name may contain Latin letters, numbers, and underscores. The name may be up to 63 characters long. You cannot create a database named default.

To learn more about creating databases, see this ClickHouse® article.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To delete a database, run this command:

yc managed-clickhouse database delete <DB_name> \
   --cluster-name=<cluster_name>

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

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

   For more information about creating this file, see Creating clusters.

2. Delete the yandex_mdb_clickhouse_database resource with the name of the database you are deleting.

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 resource changes.

   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 article.

1. Get an IAM token for API authentication and place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Database.Delete method and send the following request, e.g., via cURL:

   curl \
       --request DELETE \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/databases/<DB_name>'
   

   You can get the cluster ID with the list of clusters in the folder, and the DB name, with the list of DBs in the cluster.

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

1. Get an IAM token for API authentication and place it in 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 the repository contents are stored in the ~/cloudapi/ directory.

3. Use the DatabaseService.Delete call and send the following request, e.g., via gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/database_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "database_name": "<DB_name>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.DatabaseService.Delete
   

   You can get the cluster ID with the list of clusters in the folder, and the DB name, with the list of DBs in the cluster.

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

1. Connect to your cluster as admin.

2. Delete the database:

   DROP DATABASE <DB_name>;
   

To learn more about deleting objects, see this ClickHouse® article.