6.1 Using MySQL AdminAPI — MySQL Shell 8.4

6.1 Использование MySQL AdminAPI

AdminAPI предоставляется MySQL Shell. AdminAPI доступен через глобальную переменную dba и её связанные методы. Методы переменной dba предоставляют операции, позволяющие развертывать, настраивать и администрировать InnoDB Cluster, InnoDB ClusterSet и InnoDB ReplicaSet. Например, используйте метод dba.createCluster() для создания InnoDB Cluster. Кроме того, AdminAPI поддерживает администрирование некоторых задач, связанных с MySQL Router, таких как создание или обновление учетной записи пользователя, работающей с InnoDB Cluster, InnoDB ClusterSet и InnoDB ReplicaSet.

AdminAPI поддерживает следующие сценарии развертывания:

Развертывание в производстве: Если вы хотите использовать полную производственную среду, вам необходимо настроить необходимое количество машин и затем развернуть ваши серверные экземпляры на этих машинах.
Песочница (sandbox): Если вы хотите протестировать развертывание перед переходом к полному производственному развертыванию, предоставленная функция песочницы позволяет настроить тестовую среду на вашей локальной машине. Для вас будут созданы экземпляры сервера с необходимой конфигурацией. Вы можете экспериментировать, чтобы ознакомиться с используемыми технологиями.

Важно

Развертывание AdminAPI в песочнице не подходит для использования в полной производственной среде.

MySQL Shell предоставляет два режима языка, JavaScript и Python, помимо родного SQL режима. В этом руководстве MySQL Shell используется в основном в режиме JavaScript. При запуске MySQL Shell по умолчанию используется режим JavaScript. Переключение режимов осуществляется с помощью команды \js для режима JavaScript и команды \py для режима Python. Убедитесь, что вы находитесь в режиме JavaScript, выполнив команду \js.

Важно

MySQL Shell позволяет подключаться к серверам по сокетам, но AdminAPI требует TCP-соединений с экземпляром сервера. Соединения по сокетам в AdminAPI не поддерживаются.

Этот раздел предполагает знакомство с MySQL Shell; для получения дополнительной информации см. MySQL Shell 8.4. MySQL Shell также предоставляет онлайн-справочную информацию по AdminAPI. Чтобы перечислить все доступные dba команды, используйте метод dba.help(). Для получения онлайн-помощи по конкретному методу используйте общий формат object.help('methodname'). Например, используя JavaScript:

mysql-js> dba.help('getCluster')

Retrieves a cluster from the Metadata Store.

SYNTAX

  dba.getCluster([name][, options])

WHERE

  name: Parameter to specify the name of the cluster to be returned.
  options: Dictionary with additional options.
  ...

Или используя Python:

mysql-py>dba.help('get_cluster')
NAME
      get_cluster - Retrieves a cluster from the Metadata Store.

SYNTAX
      dba.get_cluster([name][, options])

WHERE
      name: Parameter to specify the name of the cluster to be returned.
      options: Dictionary with additional options.
...

Помимо этой документации, существует документация разработчика для всех методов AdminAPI в Справочнике API MySQL Shell для JavaScript или Справочнике API MySQL Shell для Python, доступные по адресу Connectors and APIs.