Управление базами данных в Managed Service for ClickHouse®

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

Чтобы получить список баз данных в кластере, выполните команду:

yc managed-clickhouse database list \
   --cluster-name=<имя_кластера>

Имя кластера можно запросить со списком кластеров в каталоге.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Database.List и выполните запрос, например, с помощью cURL:

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<идентификатор_кластера>/databases'
   

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

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

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом DatabaseService.List и выполните запрос, например, с помощью 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": "<идентификатор_кластера>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.DatabaseService.List
   

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Подключитесь к кластеру, используя учетную запись admin.

2. Получите список баз данных:

   SHOW DATABASES;
   

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

Выполните команду создания БД, задав имя новой базы:

yc managed-clickhouse database create <имя_БД> \
   --cluster-name=<имя_кластера> \
   --engine=<движок_БД>

Где:

• --cluster-name — имя кластера базы данных.

• --engine — движок базы данных. Необязательный параметр. Возможные значения:

  • database-engine-atomic (по умолчанию) — движок Atomic. Поддерживает неблокирующие операции DROP TABLE и RENAME TABLE, а также атомарные операции EXCHANGE TABLES.

  • database-engine-replicated — движок Replicated. Поддерживает репликацию метаданных таблиц между всеми репликами базы данных. При этом набор таблиц и их схемы будут одинаковыми для всех реплик.

    Доступен только в реплицированных кластерах.

  Движок задается при создании базы данных и не может быть изменен для этой базы.

Имя кластера можно запросить со списком кластеров в каталоге.

Managed Service for ClickHouse® запустит операцию создания базы данных.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, в разделе Создание кластера.

2. Добавьте ресурс yandex_mdb_clickhouse_database:

   resource "yandex_mdb_clickhouse_database" "<имя_БД>" {
     cluster_id = "<идентификатор_кластера>"
     name       = "<имя_БД>"
     engine     = "<движок_БД>"
   }
   

   Где:

   • cluster_id — идентификатор кластера базы данных.

   • name — имя базы данных.

   • engine — движок базы данных. Необязательный параметр. Возможные значения:

     • atomic (по умолчанию) — движок Atomic. Поддерживает неблокирующие операции DROP TABLE и RENAME TABLE, а также атомарные операции EXCHANGE TABLES.

     • replicated — движок Replicated. Поддерживает репликацию метаданных таблиц между всеми репликами базы данных. При этом набор таблиц и их схемы будут одинаковыми для всех реплик.

       Доступен только в реплицированных кластерах.

     Движок задается при создании базы данных и не может быть изменен для этой базы.

   Примечание

   Имя базы может содержать латинские буквы, цифры и подчеркивание. Максимальная длина имени 63 символа. Запрещено создание базы данных с именем default.

   Если кластер создается с помощью Terraform одновременно с созданием БД, то в ресурсе yandex_mdb_clickhouse_database вместо идентификатора кластера укажите ссылку на имя создаваемого кластера:

   
   resource "yandex_mdb_clickhouse_cluster_v2" "<имя_кластера>" {
     name = "<имя_кластера>"
     ...
   }
   
   resource "yandex_mdb_clickhouse_database" "<имя_БД>" {
     cluster_id = yandex_mdb_clickhouse_cluster_v2.<имя_кластера>.id
     name       = "<имя_БД>"
   }
   

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее в документации провайдера Terraform.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Database.Create и выполните запрос, например, с помощью 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/<идентификатор_кластера>/databases' \
       --data '{
                 "databaseSpec": {
                   "name": "<имя_базы_данных>",
                   "engine": "<движок_базы_данных>"
                 }
               }'
   

   Где:

   • databaseSpec.name — имя базы данных.

     Примечание

     Имя базы может содержать латинские буквы, цифры и подчеркивание. Максимальная длина имени 63 символа. Запрещено создание базы данных с именем default.

   • databaseSpec.engine — движок базы данных. Возможные значения:

     • DATABASE_ENGINE_ATOMIC (по умолчанию) — движок Atomic. Поддерживает неблокирующие операции DROP TABLE и RENAME TABLE, а также атомарные операции EXCHANGE TABLES.

     • DATABASE_ENGINE_REPLICATED — движок Replicated. Поддерживает репликацию метаданных таблиц между всеми репликами базы данных. При этом набор таблиц и их схемы будут одинаковыми для всех реплик.

       Доступен только в реплицированных кластерах.

     • DATABASE_ENGINE_UNSPECIFIED — для этого значения будет выбран движок по умолчанию DATABASE_ENGINE_ATOMIC.

     Движок задается при создании базы данных и не может быть изменен для этой базы.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

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

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом DatabaseService.Create и выполните запрос, например, с помощью 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": "<идентификатор_кластера>",
             "database_spec": {
               "name": "<имя_базы_данных>",
               "engine": "<движок_базы_данных>"
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.DatabaseService.Create
   

   Где:

   • database_spec.name — имя базы данных.

     Примечание

     Имя базы может содержать латинские буквы, цифры и подчеркивание. Максимальная длина имени 63 символа. Запрещено создание базы данных с именем default.

   • database_spec.engine — движок базы данных. Возможные значения:

     • DATABASE_ENGINE_ATOMIC (по умолчанию) — движок Atomic. Поддерживает неблокирующие операции DROP TABLE и RENAME TABLE, а также атомарные операции EXCHANGE TABLES.

     • DATABASE_ENGINE_REPLICATED — движок Replicated. Поддерживает репликацию метаданных таблиц между всеми репликами базы данных. При этом набор таблиц и их схемы будут одинаковыми для всех реплик.

       Доступен только в реплицированных кластерах.

     • DATABASE_ENGINE_UNSPECIFIED — для этого значения будет выбран движок по умолчанию DATABASE_ENGINE_ATOMIC.

     Движок задается при создании базы данных и не может быть изменен для этой базы.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Подключитесь к кластеру, используя учетную запись admin.

2. Создайте базу данных:

   CREATE DATABASE <имя_БД>;
   

   Примечание

   Имя базы может содержать латинские буквы, цифры и подчеркивание. Максимальная длина имени 63 символа. Запрещено создание базы данных с именем default.

Подробнее о создании баз данных в документации ClickHouse®.

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

Чтобы удалить базу данных, выполните команду:

yc managed-clickhouse database delete <имя_БД> \
   --cluster-name=<имя_кластера>

Имя кластера можно запросить со списком кластеров в каталоге.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, в разделе Создание кластера.

2. Удалите ресурс yandex_mdb_clickhouse_database с именем удаляемой базы данных.

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее в документации провайдера Terraform.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Database.Delete и выполните запрос, например, с помощью cURL:

   curl \
       --request DELETE \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<идентификатор_кластера>/databases/<имя_БД>'
   

   Идентификатор кластера можно запросить со списком кластеров в каталоге, а имя БД — со списком БД в кластере.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

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

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом DatabaseService.Delete и выполните запрос, например, с помощью 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": "<идентификатор_кластера>",
             "database_name": "<имя_БД>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.DatabaseService.Delete
   

   Идентификатор кластера можно запросить со списком кластеров в каталоге, а имя БД — со списком БД в кластере.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Подключитесь к кластеру, используя учетную запись admin.

2. Удалите базу данных:

   DROP DATABASE <имя_БД>;
   

Подробнее об удалении объектов в документации ClickHouse®.