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

包含使用传统MySQL协议与MySQL服务器交互的函数和类。更多…

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

功能

ClassicSession getClassicSession(ConnectionData ConnectionData, String password)
打开一个经典的MySQL协议会话到MySQL服务器。更多…
ClassicSession getSession(ConnectionData ConnectionData, String password)
打开一个经典的MySQL协议会话到MySQL服务器。更多…

详细描述

包含使用传统MySQL协议与MySQL服务器交互的函数和类。

使用此模块可以使用传统的MySQL协议创建会话,例如对于X协议不可用的MySQL服务器。

注意,这个模块上的API接口是非常有限的,即使你可以将模式、表和视图加载为对象,但它们没有可用的操作。

这个模块的目的是允许在未启用X协议的MySQL服务器上执行SQL。

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

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

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

函数的文档10bet官方网站

getClassicSession ()

ClassicSessiongetClassicSession ConnectionData connectionData
字符串 密码

打开一个经典的MySQL协议会话到MySQL服务器。

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

一个ClassicSession对象使用传统的MySQL协议来允许在连接的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:使用TLS协议到TLSv1.2的连接所允许的加密密码列表。
  • tls-version:允许安全连接的协议列表。
  • TLS -ciphers:要使用的TLS v1.3密码列表。
  • auth-method:认证方法。
  • get-server-public-key:向服务器请求RSA密钥对密码交换所需的公钥。使用SSL模式DISABLED连接到经典MySQL会话的MySQL 8.0服务器。
  • server-public-key-path:一个包含客户端公钥副本的文件的路径名,该客户端公钥副本是服务器进行基于RSA密钥对的密码交换所需的。使用SSL模式DISABLED连接到经典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字符串。
  • Scheme:在连接上使用的协议。
  • user:连接时使用的MySQL用户名。
  • dbUser:用户别名。
  • 密码:连接时使用的密码。
  • dbPassword:同password。
  • host:在连接上使用的主机名或IP地址。
  • port: TCP连接中使用的端口。
  • 套接字:通过Unix套接字连接时使用的套接字文件名。
  • 模式:连接完成后要选择的模式。

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中指定的选项

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

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

连接数据格式的详细描述可在连接数据

getSession ()

ClassicSessiongetSession ConnectionData connectionData
字符串 密码

打开一个经典的MySQL协议会话到MySQL服务器。

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

一个ClassicSession对象使用传统的MySQL协议来允许在连接的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:使用TLS协议到TLSv1.2的连接所允许的加密密码列表。
  • tls-version:允许安全连接的协议列表。
  • TLS -ciphers:要使用的TLS v1.3密码列表。
  • auth-method:认证方法。
  • get-server-public-key:向服务器请求RSA密钥对密码交换所需的公钥。使用SSL模式DISABLED连接到经典MySQL会话的MySQL 8.0服务器。
  • server-public-key-path:一个包含客户端公钥副本的文件的路径名,该客户端公钥副本是服务器进行基于RSA密钥对的密码交换所需的。使用SSL模式DISABLED连接到经典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字符串。
  • Scheme:在连接上使用的协议。
  • user:连接时使用的MySQL用户名。
  • dbUser:用户别名。
  • 密码:连接时使用的密码。
  • dbPassword:同password。
  • host:在连接上使用的主机名或IP地址。
  • port: TCP连接中使用的端口。
  • 套接字:通过Unix套接字连接时使用的套接字文件名。
  • 模式:连接完成后要选择的模式。

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中指定的选项

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

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

连接数据格式的详细描述可在连接数据