Movatterモバイル変換

This document covers the Python APIs available in the MySQL Shell:

• X DevAPI - NoSQL Database API for MySQL and the MySQL Document Store.
• ShellAPI - Shell API and backward compatibility API for MySQL Servers not supporting the X DevAPI.
• AdminAPI - API for setting up and managing InnoDB Clusters, InnoDB ReplicaSets, and InnoDB ClusterSets.

The functionality of the APIs is exposed through modules and global objects which are automatically available when the MySQL Shell starts.

• Themysqlx module contains a complete development API to interact with MySQL Servers using a session through the X Protocol.
• Themysql module contains a lightweight development API to interact with MySQL Servers using a classic session.
• Thedba global object enables you to administer InnoDB clusters using the AdminAPI.
• Theshell global object gives access to general purpose functions and properties.
• Thesession¹ global object is available when a global session is established.
• Thedb global object is available when the global session is established through the X protocol using a default database.
• Theutil global object that groups miscellaneous tools like upgrade checker and JSON import.¹ Thesession global object might be either aClassicSession or aSession object depending on whether the global session was established using classic MySQL protocol or X protocol respectively. For additional details look at the connect function in theshell object.

For more information on the functionality these APIs provide see the following documentation:

• TheUsing MySQL as a Document Store documentation explains how to use X DevAPI to achieve a NoSQL-like MySQL database.
• TheX DevAPI user guide provides details about and usage examples of the X DevAPI.
• TheInnoDB Cluster user guide explains how to use MySQL Shell and AdminAPI to set up and administer a highly available InnoDB Cluster.
• TheGroup Replication documentation provides detailed documentation on the replication group which InnoDB Cluster utilizes.