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

封装了可与启用X协议的MySQL产品交互的函数和类。更多…

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

功能

会话 get_session(ConnectionData ConnectionData, str password)
创建一个会话实例使用提供的连接数据。更多…
表达式 expr(str expressionStr)
基于字符串创建Expression对象。更多…
日期 date_value(int年,int月,int天,int小时,int分钟,int秒,int毫秒)
创建一个日期对象,它表示日期时间。更多…

详细描述

封装了可与启用X协议的MySQL产品交互的函数和类。

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

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

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

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

从mysqlsh mysql-py >进口mysqlx
//然后你可以使用模块函数和属性
//例如创建一个会话
mysql-py> mySession = mysqlx.get_session()“admin@localhost”)

当以交互模式运行shell时,该模块将被自动导入。

函数的文档10bet官方网站

get_session ()

会话get_session ( ConnectionData connectionData,
str 密码
)

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

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

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

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

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

一个基本的URI字符串的格式如下:

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

连接选项

以下选项既可以在URI中使用,也可以在字典中使用:

  • SSL -mode:使用SSL连接方式。
  • ssl-ca: PEM格式的X509证书颁发机构文件的路径。
  • ssl-capath: PEM格式X509证书颁发机构文件所在目录的路径。
  • 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密钥对密码交换所需要的服务器的公钥。当连接到MySQL 8.0服务器时使用经典的MySQL会话,SSL模式为DISABLED。
  • server-public-key-path:服务器用于RSA密钥对密码交换所需公钥的客户端副本文件的路径名。当连接到MySQL 8.0服务器时使用经典的MySQL会话,SSL模式为DISABLED。
  • connect-timeout:连接超时时间,单位为毫秒。如果没有提供,将使用缺省的10秒超时。将值指定为0将禁用连接超时。
  • compression:启用客户端/服务器协议压缩。
  • compression-algorithms:在服务器/客户端协议中使用压缩算法。
  • compression-level:在客户端/服务器协议中使用此压缩级别。
  • connection-attributes:要在PERFORMANCE_SCHEMA连接属性表上注册的连接属性列表。
  • LOCAL - INFILE:启用/禁用LOAD DATA LOCAL INFILE。

基础连接选项

  • 方案:连接时使用的协议。
  • user:连接时使用的MySQL用户名。
  • dbUser:用户别名。
  • 密码:连接时使用的密码。
  • dbPassword:与密码相同。
  • host:连接上使用的主机名或IP地址。
  • port: TCP连接使用的端口。
  • 套接字:通过Unix套接字连接时使用的套接字文件名。
  • 模式:连接完成后要选择的模式。
注意
dbUser和dbPassword选项将在未来的版本中删除。

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

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

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

expr ()

表达expr ( str expressionStr )

基于字符串创建Expression对象。

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

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

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

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

date_value ()

日期date_value ( int 一年,
int ,
int 一天,
int 小时,
int 分钟,
int ,
int 毫秒
)

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

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

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

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