正式发布前：2024-07-17
ShellAPI 包含有关 shell 和 util 全局对象以及允许在 MySQL 服务器上执行 SQL 的 mysql 模块的信息。
ShellAPI 在 JavaScript 和 Python 中可用。
以下 Python 对象可用
| Python 对象 | 描述 |
|---|---|
shell |
提供对通用函数和属性的访问。 |
util |
提供一个全局对象，用于对各种工具进行分组，例如 checkForServerUpgrade（用于检查升级过程是否成功）或 importJson（用于使用 X 协议会话将 JSON 文档从文件导入到 MySQL 服务器中的集合或表）。有关更多信息，请参阅 MySQL Shell 实用工具。 |
以下类在 JavaScript 和 Python 中可用
| 类 | 描述 |
|---|---|
Column |
表示结果中列的元数据。 |
Row |
表示结果中的一行。 |
以下 JavaScript 对象可用
| JavaScript 对象 | 描述 |
|---|---|
os |
提供对允许您与操作系统交互的函数的访问。 |
shell |
提供对通用函数和属性的访问。 |
sys |
提供对系统特定参数的访问。有关更多信息，请参阅 启动脚本中的模块搜索路径变量。 |
util |
提供一个全局对象，用于对各种工具进行分组，例如 checkForServerUpgrade（用于检查升级过程是否成功）或 importJson（用于使用 X 协议会话将 JSON 文档从文件导入到 MySQL 服务器中的集合或表）。有关更多信息，请参阅 MySQL Shell 实用工具。 |
以下 JavaScript 函数可用
| JavaScript 函数 | 描述 |
|---|---|
dir(object) |
返回目标对象上可枚举属性的列表。 |
require(module_name_or_path) |
加载指定的 JavaScript 模块。 |