MySQL壳API8.0.28
MySQL产品的统一开发接口
|功能
mysqlx

包含了与X协议支持的MySQL产品交互的函数和类。更多…

类型
表示数据类型的常量对象。更多…
LockContention
常量来表示锁争用类型。更多…

功能

会话 getSession(连接数据,字符串密码)
创建一个会话实例使用提供的连接数据。更多…
表达式 expr(字符串expressionStr)
基于字符串创建Expression对象。更多…
日期 dateValue(整数年、整数月、整数日、整数小时、整数分钟、整数秒、整数毫秒)
创建一个日期对象,该对象表示日期时间。更多…

详细描述

包含了与X协议支持的MySQL产品交互的函数和类。

这个模块中包含的对象提供了一个完整的API来与实现X协议的不同MySQL产品进行交互。

在MySQL服务器的情况下,API将支持对不同的数据库对象进行操作,如模式管理操作、表和集合管理以及CRUD操作。(CRUD:创建,读取,更新,删除)。

该模块的目的是通过JavaScript和Python等脚本语言为开发提供完整的API,这通常通过一个正常的会话实现。

要使用此模块上可用的属性和函数,首先需要导入它。

Mysql-js > var mysqlx =需要“mysqlx”);
//然后你可以使用模块的函数和属性
//例如创建会话
mysql-js> var mySession = mysqlx.getSession(“admin@localhost”);
任何要求(字符串module_name_or_path)
加载指定的JavaScript模块。
定义:mod_shell.cc: 74

在交互模式下运行shell时,会自动导入此模块。

函数的文档10bet官方网站

getSession ()

会话getSession ConnectionData connectionData
字符串 密码

创建一个会话实例使用提供的连接数据。

参数
connectionData 会话的连接数据
密码 会话的可选密码
返回
一个会话

一个会话对象使用X协议允许在连接的MySQL服务器上执行操作。

连接数据可以用以下格式指定:

  • 一个URI字符串
  • 一个带有连接选项的字典

一个基本URI字符串有以下格式:

[方案:/ /][用户(密码):@]<主机(港口):|套接字>[/模式][?选项=价值选择=值…]

连接选项

以下选项在URI或字典中使用都是有效的:

  • SSL -mode:连接中使用的SSL模式。
  • ssl-ca: PEM格式的X509证书颁发机构文件路径。
  • ssl-capath: X509证书颁发机构PEM格式文件所在目录的路径。
  • SSL -cert: PEM格式的SSL公钥证书文件路径。
  • SSL -key: PEM格式的SSL私钥文件路径。
  • ssl-crl:包含证书吊销列表的文件路径。
  • ssl-crlpath:证书吊销列表文件所在目录的路径。
  • ssl-cipher:使用TLSv1.2以下TLS协议的连接所允许的加密密码列表。
  • tls-version:允许安全连接的协议列表。
  • TLS -ciphers:要使用的TLS v1.3密码列表。
  • auth方法:身份验证方法。
  • get-server-public-key:向服务器请求基于RSA密钥对的密码交换所需的公钥。当使用禁用SSL模式的经典MySQL会话连接MySQL 8.0服务器时使用。
  • server-public-key-path:一个文件的路径名,该文件包含服务器用于基于RSA密钥对的密码交换所需的公钥的客户端副本。当使用禁用SSL模式的经典MySQL会话连接MySQL 8.0服务器时使用。
  • connect-timeout:连接超时时间,以毫秒为单位。如果没有提供,将使用默认的10秒超时。指定值为0将禁用连接超时。
  • compression:在客户/服务器协议中启用压缩。
  • compression-algorithms:在服务器/客户端协议中使用压缩算法。
  • compression-level:在客户端/服务器协议中使用此压缩级别。
  • connection-attributes:要在PERFORMANCE_SCHEMA连接属性表中注册的连接属性列表。
  • LOCAL - INFILE:启用/禁用LOAD DATA LOCAL INFILE。
  • net-buffer-length:用于TCP/IP和套接字通信的缓冲区大小。

当在URI中定义这些选项时,它们的值必须是URL编码的。

当使用字典时,以下选项也有效:

基础连接选项

  • uri: uri字符串。
  • 方案:连接时使用的协议。
  • user:连接时使用的MySQL用户名。
  • dbUser:用户别名。
  • Password:连接时使用的密码。
  • dbPassword:与password相同。
  • host:连接中要使用的主机名或IP地址。
  • port: TCP连接使用的端口号。
  • Socket:通过Unix套接字连接时使用的套接字文件名。
  • Schema:连接完成后要选择的模式。

SSH隧道连接选项

  • ssh:需要ssh隧道时使用的SSHURI字符串。
  • SSH -password: SSH连接时使用的密码。
  • SSH -identity-file: SSH连接时使用的密钥文件。
  • SSH -identity-file-password: SSH私钥文件密码。
  • SSH -config-file: SSH配置文件,默认值为shell.options[' SSH . configfile ']
注意
dbUser和dbPassword选项将在未来的版本中删除。
连接选项优先于连接选项uri中指定的选项

连接选项不区分大小写,只能定义一次。

如果一个选项被定义了不止一次,就会产生一个错误。

有关连接数据格式的详细说明,请参阅连接数据

expr ()

表达expr 字符串 expressionStr

基于字符串创建Expression对象。

参数
expressionStr 要由对象表示的表达式

在X DevAPI的许多操作中都需要表达式对象。

表达式对象的一些应用包括:

  • 基于JSON字符串创建文档
  • 在数据库中插入数据时定义计算字段
  • 从数据库提取数据时定义计算字段

dateValue ()

日期dateValue 整数 一年
整数
整数 一天
整数 小时
整数 分钟
整数
整数 毫秒

创建一个日期对象,该对象表示日期时间。

参数
一年 要在新Date对象中使用的年份。
要在新Date对象中使用的月份。
一天 要在新Date对象中使用的月份。
小时 要在新Date对象中使用的可选时间。
分钟 在新Date对象中使用的可选分钟。
在新Date对象中使用的可选秒。
毫秒 在新Date对象中使用的可选毫秒。

这个函数创建了一个Date对象,包含:

  • 一个日期值。
  • 日期和时间值。
  • 以毫秒为单位的日期和时间值。