MySQL Shell API8.0.28
MySQL产品的统一开发接口
模块||功能
ShellAPI

模块

mysql
包含了使用传统MySQL协议与MySQL服务器交互的函数和类。
跑龙套
全局对象,它将各种工具(如升级检查器和JSON导入)分组。

ClassicResult
ClassicSession
启用使用MySQL协议与MySQL服务器交互。更多…
操作系统
提供对允许与操作系统交互的函数的访问。更多…
路径
提供对路径相关函数的访问。更多…
壳牌
提供对通用函数和属性的访问。更多…
选项
报告
提供对内置报表和用户定义报表的访问。更多…
Sys
提供对系统特定参数的访问。更多…
DatabaseObject
提供数据库对象的基本功能。更多…
表示a对结果的定义。更多…
表示a在结果中。创建行对象时,其字段将作为属性公开如果满足以下两个条件,则反对:
  • 它的名称必须是有效的标识符:[_a-zA-Z][_a-zA-Z0-9]*
  • 它的名称不能与该对象成员的名称相同。

如果字段不满足这些条件,则必须通过this函数检索它。更多…

功能

数组 dir(对象对象)
返回目标对象上可枚举属性的列表。更多…
任何 需要(字符串module_name_or_path)
加载指定的JavaScript模块。更多…

详细描述

Shell API和MySQL服务器的向后兼容API不支持X DevAPI。

函数的文档10bet官方网站

dir ()

数组dir 对象 对象

返回目标对象上可枚举属性的列表。

参数
对象 将列出其属性的对象。
返回
对象上可枚举属性的列表。

遍历对象,检索其可枚举属性。返回列表的内容取决于对象:

  • 对于字典,返回键的列表。
  • 对于API对象,返回成员列表。

传递其他类型对象的函数的行为未定义,也不受支持。

要求()

任何需要 字符串 module_name_or_path

加载指定的JavaScript模块。

参数
module_name_or_path 要加载的模块的名称或路径。
返回
已加载模块的导出内容。

module_name_or_path参数可以是内置模块的名称(如mysql或mysqlx),也可以是本地文件系统上JavaScript模块的路径。在以下文件夹中查找本地模块:

  • 如果module_name_or_path以`开头。/'或'../'字符,使用包含当前正在执行的JavaScipt文件或模块的文件夹,如果没有这样的文件或模块,则使用当前工作目录(即shell以交互模式运行),
  • 目录中列出的文件夹。路径变量。

包含要加载的模块的文件通过遍历这些文件夹来定位,对于每个文件夹路径:

  • 附加module_name_or_path,如果存在,使用它。
  • 附加module_name_or_path,附加'.js'扩展名,如果存在,使用它。
  • 附加module_name_or_path,如果存在,附加'init.js'文件名,如果存在,使用它。

加载的模块可以访问以下变量:

  • 导出——一个空对象,模块应该使用它来导出它的功能;方法返回的值要求()函数,
  • Module——一个模块对象,包含上面描述的exports对象;可以用来改变导出的类型或存储模块特定的数据,
  • __filename—模块文件的绝对路径,
  • __dirname—包含模块文件的目录的绝对路径。

每个模块只加载一次,任何后续调用要求()它将使用相同的模块返回一个缓存值。

如果两个模块形成一个循环(尝试使用要求()函数),其中一个将接收另一个导出对象的未完成副本。

下面是一个名为. js哪个在模块对象中存储一些数据并导出一个函数callme ()

模块。Counter = 0;
出口。callme =函数() {
常量复数= ++模块。计数器> 1 ?“年代”''
println('我被调用$(module.counter) time$(复数). ');
};

如果放在当前工作目录中,它可以在shell中如下使用:

Mysql-js > var test =需要“。/测试”);
mysql-js > test.callme ();
我被打了一次电话。
mysql-js > test.callme ();
我被打了两次电话。
mysql-js > test.callme ();
我被打了三次电话。
(字符串module_name_or_path)
加载指定的JavaScript模块。
定义:mod_shell.cc: 74
异常
TypeError 以下场景:
  • 如果module_name_or_path不是字符串。
错误 以下场景:
  • 如果module_name_or_path为空,
  • 如果module_name_or_path包含反斜杠字符,
  • 如果module_name_or_path是绝对路径,
  • 如果找不到本地模块,
  • 如果无法加载本地模块。