【MySQL精通之路】AdminAPI-使用

目录

1.使用

[1.1 使用场景](#1.1 使用场景)

[1.2 使用模式](#1.2 使用模式)

---

官方文档：

MySQL :: MySQL Shell 8.0 :: 6.1 Using MySQL AdminAPI

本文介绍MySQL SHELL提供的MySQL AdminAPI，使您能够管理MySQL实例 ，使用它们创建InnoDB Cluster 、InnoDB ClusterSet 和InnoDB ReplicaSet部署 ，并集成MySQL Router。

1.使用

AdminAPI由MySQL Shell提供。AdminAPI是通过dba全局变量及其相关方法访问的。dba变量的方法提供的操作使您能够部署、配置和管理InnoDB Cluster、InnoDB ClusterSet和InnoDB ReplicaSet。

例如，使用dba.createCluster（）方法创建一个InnoDB集群。

此外，AdminAPI支持管理一些与MySQL Router相关 的任务，例如创建或升级使用InnoDB Cluster、InnoDB ClusterSet和InnoDB ReplicaSet 的用户帐户。

---

1.1 使用场景

AdminAPI支持以下部署场景：

生产部署：

如果要使用完整的生产环境，则需要配置所需数量的计算机，然后将服务器实例部署到这些计算机。
沙盒部署：

如果您想在提交到完整的生产部署之前测试部署，则提供的沙盒功能使您能够在本地计算机上设置测试环境。沙盒服务器实例是使用所需的配置为您创建的。你可以通过实验来熟悉所使用的技术。

AdminAPI沙箱部署不适合在完整的生产环境中使用。

1.2 使用模式

MySQL Shell除了提供原生SQL模式 外，还提供了JavaScript 和Python两种语言模式。

在本指南中，MySQL Shell主要用于JavaScript模式。

MySQL Shell启动时，默认情况下处于JavaScript模式。

通过为JavaScript模式发出**\js** ，为Python模式发出 \py来切换模式。

通过发出**\js**确保您处于JavaScript模式。

MySQL Shell允许您通过套接字连接连接到服务器，但AdminAPI需要到服务器实例的TCP连接。AdminAPI中不支持基于套接字的连接。

本节假设您熟悉MySQL Shell；

有关更多信息，请参阅MySQL Shell 8.0。

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

除此文档外，在下面

MySQL :: Connectors and APIs

提供的MySQL Shell JavaScript API 参考或MySQL Shell Python API参考，以及所有AdminAPI方法，开发者文档。