用于 VS 代码的 MySQL Shell GUI / MySQL Shell  / 第 5 章 MySQL Shell 控制台  / 
5.8 ShellAPI	
            
全面上市前:2022-11-17
      ShellAPI 包含有关全局对象的信息以及支持在 MySQL 服务器上执行 SQL 的shell模块
      
      。
    utilmysql
ShellAPI 在 JavaScript和 Python中可用。
以下 Python 对象可用:
| Python对象 | 描述 | 
|---|---|
shell | 
          提供对通用功能和属性的访问。 | 
util | 
          提供一个全局对象,将各种工具分组,例如
            checkForServerUpgrade,检查升级过程是否成功,或者importJson,使用 X 协议会话将 JSON 文档从文件导入 MySQL 服务器中的集合或表。有关详细信息,请参阅MySQL Shell 实用程序。 | 
        
以下类在 JavaScript 和 Python 中可用:
| 班级 | 描述 | 
|---|---|
Column | 
          表示结果中列的元数据。 | 
Row | 
          代表结果中的一行。 | 
以下 JavaScript 对象可用:
| 对象 | 描述 | 
|---|---|
os | 
          提供对允许您与操作系统交互的功能的访问。 | 
shell | 
          提供对通用功能和属性的访问。 | 
sys | 
          提供对系统特定参数的访问。有关详细信息,请参阅 启动脚本中的模块搜索路径变量。 | 
util | 
          提供一个全局对象,将各种工具分组,例如
            checkForServerUpgrade,检查升级过程是否成功,或者importJson,使用 X 协议会话将 JSON 文档从文件导入 MySQL 服务器中的集合或表。有关详细信息,请参阅
            MySQL Shell 实用程序。 | 
        
以下 JavaScript 函数可用:
| 函数 | 描述 | 
|---|---|
dir(object) | 
          返回目标对象的可枚举属性列表。 | 
require(module_name_or_path) | 
          加载指定的 JavaScript 模块。 |