Вывод информации об экземпляре БД

примечание

Исполнять сценарий необходимо от имени пользователя pbr.

Описание сценария

Команда для вывода информации об экземпляре базы данных OceanBase Database, к которому подключен агент copywala-ob (в формате YAML и JSON).

Предусловие

Перед выводом информации об экземпляре БД убедитесь, что:

• агент copywala-ob инициализирован (сценарий );

• в конфигурационном файле copywala-ob.yaml настроены параметры:

  • target_db – учетные данные для подключения к OceanBase Database; команда выполняет подключение через системный тенант (sys-тенант), поэтому пользователь должен иметь права доступа к нему.
  • log – параметры логирования.

Последовательность выполнения

Шаги сценария:

1. Убедитесь, что настройки подключения к целевой базе данных OceanBase Database (секция target_db), указанные в конфигурационном файле copywala-ob.yaml, являются корректными.
2. Выведите информацию об экземпляре базы данных через CLI компонента Copywala OB командой copywala-ob db info.

Флаг --json

Если флаг --json не был указан, вывод осуществляется по умолчанию в формате YAML. При передаче флага --json информация отображается в формате JSON.

Результат

В результате выполнения команды будет выведена следующая информация об экземпляре БД:

$ copywala-ob db info

username: user_tenant
instance_name: ob-cluster_0198a217-3cd5-74d1-b44f-2099e2eb1afe
version: 4.2.1.0
tenants:
- id: 1002
  name: test
  status: NORMAL
  total_size: 51839534080
  databases:
  - name: testdb
    size_bytes: 51839534080
  - name: app_db
    size_bytes: 2147483648

Поле	Описание
username	Пользователь OceanBase Database, указанный в параметре target_db.username конфигурационного файла copywala-ob.yaml, от имени которого выполняется подключение
instance_name	Полное уникальное наименование экземпляра агента, сформированное при инициализации командой copywala-ob init <name>
version	Версия OceanBase Database
tenants	Список пользовательских тенантов OceanBase Database со статусом NORMAL, не находящихся в корзине
tenants[].id	Идентификатор тенанта
tenants[].name	Имя тенанта
tenants[].status	Статус тенанта
tenants[].total_size	Суммарный размер баз данных тенанта, байт
tenants[].databases	Список баз данных тенанта (системные базы данных не отображаются)
tenants[].databases[].name	Имя базы данных
tenants[].databases[].size_bytes	Размер базы данных, байт

примечание

В выводе отображаются только пользовательские тенанты (TENANT_TYPE = USER) со статусом NORMAL, не помещенные в корзину. Системные базы данных (information_schema, mysql, oceanbase, __public, __recyclebin) не включаются в перечень баз данных тенантов.

Исключительные сценарии

• Не удалось установить подключение к целевой базе данных.
• Агент copywala-ob не инициализирован (сценарий ): в CLI выводится сообщение failed to load agent-id.