Подключиться
Yandex Managed Service for ClickHouse

Управление групами шардов

Вы можете сгруппировать несколько шардов кластера ClickHouse в группу шардов и затем размещать таблицы в этой группе.

Получить список групп шардов в кластере

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

$ yc managed-clickhouse shard-groups list
     --cluster-name=<имя кластера>

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

Воспользуйтесь методом API listShardGroups: передайте идентификатор требуемого кластера в параметре clusterId запроса.

Чтобы узнать идентификатор, получите список кластеров в каталоге.

Получить детальную информацию о группе шардов

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы получить детальную информацию о группе шардов в кластере, выполните команду:

$ yc managed-clickhouse shard-groups get
     --cluster-name=<имя кластера>
     --name=<имя группы шардов>

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

Воспользуйтесь методом API getShardGroup и передайте в запросе:

Создать группу шардов

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

$ yc managed-clickhouse shard-groups create
     --cluster-name=<имя кластера>
     --name=<имя группы шардов>
     --description=<описание группы шардов>
     --shards=<список имен шардов, которые нужно включить в группу>

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

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

Воспользуйтесь методом API createShardGroup и передайте в запросе:

  • Идентификатор кластера, в котором требуется создать группу, в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
  • Имя группы шардов в параметре shardGroupName.
  • Список имен шардов, которые требуется включить в группу, в параметре shardNames. Чтобы узнать имена, получите список шардов в кластере.
  • При необходимости, описание группы шардов в параметре description.

Изменить группу шардов

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

$ yc managed-clickhouse shard-groups update
     --cluster-name=<имя кластера>
     --name=<имя группы шардов>
     --description=<новое описание группы шардов>
     --shards=<новый список имен шардов, которые нужно включить в группу>

Эта команда заменяет существующий список шардов в группе новым, который был передан команде в параметре --shards. Перед выполнением команды убедитесь, что вы включили в новый список все необходимые шарды.

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

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

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

Воспользуйтесь методом API updateShardGroup и передайте в запросе:

  • Идентификатор кластера, в котором требуется изменить группу, в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
  • Имя группы шардов в параметре shardGroupName. Чтобы узнать имя, получите список групп шардов в кластере.
  • При необходимости, новое описание группы шардов в параметре description.
  • При необходимости, новый список имен шардов, которые требуется включить в группу, в параметре shardNames. Чтобы узнать имена, получите список шардов в кластере. Этот список заменит собой текущий: убедитесь, что вы включили в новый список все необходимые шарды.
  • Имена изменяемых параметров в параметре updateMask. Если не задать этот параметр, то метод API заменит все настройки группы шардов на значения по умолчанию.

Удалить группу шардов

Удаление группы шардов не затрагивает входящие в нее шарды — они остаются в кластере.

Таблицы, созданные поверх удаляемой группы, остаются, но становятся неработоспособными: попытки выполнить запрос к ним приведут к ошибкам. Однако такие таблицы можно удалить до или после удаления группы шардов.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

$ yc managed-clickhouse shard-groups delete
     --cluster-name=<имя кластера>
     --name=<имя группы шардов>

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

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

Чтобы удалить группу шардов в кластере, воспользуйтесь методом API deleteShardGroup и передайте в запросе:

В этой статье: