MySQL壳API8.0.28
MySQL产品的统一开发接口
方法|属性|全体成员名单
会话类引用

允许使用X协议与MySQL服务器交互。更多…

方法

模式 createSchema(字符串名称)
在数据库上创建一个模式并返回相应的对象。更多…
模式 getSchema(字符串名称)
检索模式对象通过它的名称从当前会话获取。更多…
模式 getDefaultSchema()
检索模式为会话配置为默认值。更多…
模式 getCurrentSchema()
检索会话上的活动模式。更多…
模式 setCurrentSchema(字符串名称)
设置此会话的当前模式,并为其返回模式对象。更多…
列表 getSchemas()
检索会话上可用的schema。更多…
字符串 getUri()
检索当前会话的URI。更多…
字符串 getSshUri()
检索当前会话的URI。更多…
未定义的 关闭()
关闭会话。更多…
未定义的 setFetchWarnings(布尔启用)
启用或禁用警告生成。更多…
结果 startTransaction()
在服务器上启动事务上下文。更多…
结果 提交()
提交调用后执行的所有操作startTransaction ()更多…
结果 回滚()
的调用后,丢弃执行的所有操作startTransaction ()更多…
未定义的 dropSchema(字符串名称)
删除具有指定名称的模式。更多…
保龄球 isOpen()
如果知道会话是打开的,则返回true。更多…
SqlExecute sql(字符串sql)
创建一个SqlExecute对象允许在目标MySQL服务器上运行接收到的SQL语句。更多…
字符串 quoteName(字符串id)
转义传递的标识符。更多…
字符串 setSavepoint(String name = " ")
用给定的名称创建或替换事务保存点。更多…
未定义的 releaseSavepoint(字符串名称)
移除在事务上定义的保存点。更多…
未定义的 rollbackTo(字符串名称)
将事务回滚到指定的保存点,而不终止事务。更多…
SqlResult runSql(字符串查询,数组参数)
执行查询并返回相应的SqlResult对象。更多…

属性

字符串 uri
检索当前会话的URI。
字符串 sshUri
检索当前会话的SSH URI。
模式 defaultSchema
检索模式为会话配置为默认值。
模式 currentSchema
检索会话上的活动模式。

详细描述

允许使用X协议与MySQL服务器交互。

除了SQL之外,还可以通过该对象使用Document Store功能。

该类允许执行数据库操作,例如:

JavaScript的例子

//连接MySQL并使用Session
Var mysqlx = require('mysqlx');
//使用连接URL连接到专用的MySQL服务器
var mySession = mysqlx.getSession('mike:paSSw0rd@localhost');
//获取所有可用模式的列表
var schemaList = myssession . getschemas ();
print('此会话中可用的模式:\n');
//遍历所有可用模式并打印它们的名称
for (schemaList中的索引){
print (schemaList(指数). name + ' \ n ');
mySession.close ();

Python示例

#连接MySQL并使用会话
mysqlsh进口mysqlx
使用连接URL连接到一个专用的MySQL服务器
mySession = mysqlx.get_session (迈克:paSSw0rd@localhost”
#获取所有可用模式的列表
schemaList = mySession.get_schemas ()
打印('此会话中可用的模式:\n'
#循环所有可用的模式并打印它们的名称
模式schemaList:
打印(“% s \ n”% schema.name)
mySession.close ()
另请参阅
mysqlx。getSession(字符串连接数据,字符串密码)
mysqlx。getSession(映射connectionData,字符串密码)

成员函数的文档10bet官方网站

createSchema ()

模式createSchema 字符串 的名字

在数据库上创建一个模式并返回相应的对象。

参数
的名字 指示模式名称的字符串值。
返回
创建的模式对象。
异常
一个 如果创建模式失败,抛出MySQL错误。

getSchema ()

模式getSchema 字符串 的名字

检索模式对象通过它的名称从当前会话获取。

参数
的名字 的名称模式要检索的对象。
返回
模式具有给定名称的。
异常
RuntimeError 如果给定的名称不是有效的模式。
另请参阅
模式

getDefaultSchema ()

模式getDefaultSchema

检索模式为会话配置为默认值。

返回
一个模式对象或零

getCurrentSchema ()

模式getCurrentSchema

检索会话上的活动模式。

返回
一个模式对象,如果模式在会话上是活动的。

setCurrentSchema ()

模式setCurrentSchema 字符串 的名字

设置此会话的当前模式,并为其返回模式对象。

参数
的名字 要切换到的新模式的名称。
返回
模式对象的新模式。

在数据库级别,这相当于发出以下SQL查询:

使用< new-default-schema >;

getSchemas ()

getSchemas列表

检索会话上可用的schema。

返回
包含模式会话上可用的对象。

getUri ()

字符串getUri

检索当前会话的URI。

返回
表示连接数据的字符串。

getSshUri ()

字符串getSshUri

检索当前会话的URI。

检索当前会话的SSH URI。

返回
表示连接数据的字符串。
返回
表示SSH连接数据的字符串。

close ()

空白密切

关闭会话。

在关闭会话之后,仍然可以执行只读操作来收集元数据信息,如getttable (name)或getSchemas ()

setFetchWarnings ()

结果setFetchWarnings 布尔 启用

启用或禁用警告生成。

参数
启用 布尔值来启用或禁用警告。

在执行数据库操作(如SQL语句)时,有时会产生警告。

默认情况下,在Node会话中,警告生成是禁用的。此功能可用于根据接收的参数启用或禁用警告生成。

当启用警告生成时,警告将通过执行的操作返回的结果对象可用。

startTransaction ()

结果startTransaction

在服务器上启动事务上下文。

返回
一个SqlResult对象。

调用此函数将关闭服务器上的自动提交模式。

调用此函数后执行的所有操作仅在commit ()被称为。

调用此函数后执行的所有操作将被丢弃rollback ()被称为。

commit ()rollback ()调用时,服务器自动提交模式将返回到调用前的状态startTransaction ()

commit ()

无效的承诺

提交调用后执行的所有操作startTransaction ()

返回
一个SqlResult对象。

调用后执行的所有操作startTransaction ()将在调用此函数时发生。

服务器自动提交模式将返回到调用之前的状态startTransaction ()

rollback ()

空回滚

的调用后,丢弃执行的所有操作startTransaction ()

返回
一个SqlResult对象。

调用后执行的所有操作startTransaction ()将在调用此函数时丢弃。

服务器自动提交模式将返回到调用之前的状态startTransaction ()

dropSchema ()

未定义dropSchema 字符串 的名字

删除具有指定名称的模式。

参数
的名字 要删除的模式的名称。
返回
什么都没有。

isOpen ()

Bool isOpen

如果知道会话是打开的,则返回true。

返回
一个布尔值,指示会话是否仍然打开。

如果会话仍然打开,则返回true,否则返回false。

请注意
如果连接丢失,此函数可能返回true。

sql ()

SqlExecutesql 字符串 sql

创建一个SqlExecute对象允许在目标MySQL服务器上运行接收到的SQL语句。

参数
sql 包含要执行的SQL语句的字符串。
返回
一个SqlExecute对象。

此方法创建一个SqlExecute对象,它是一个SQL执行处理程序。

SqlExecute类具有允许定义语句执行方式和允许进行参数绑定的函数。

在执行处理程序上设置接收到的SQL。

JavaScript的例子

Var SQL = session。sql("select * from mydb.students where age > ?");
Var结果= sql.bind(18).execute();
另请参阅
SqlExecute

quoteName ()

字符串quoteName 字符串 id

转义传递的标识符。

参数
id 要加引号的标识符。
返回
一个包含转义标识符的字符串。

setSavepoint ()

字符串setSavepoint 字符串 的名字""

用给定的名称创建或替换事务保存点。

参数
的名字 具有要分配给事务保存点的名称的可选字符串。
返回
事务保存点的名称。

在处理事务时,使用保存点允许回滚在保存点之后执行的操作,而不终止事务。

使用此函数可在事务中设置保存点。

如果用之前设置的另一个保存点的相同名称调用此函数,则将删除原来的保存点,并创建一个新的保存点。

如果没有提供名称,则会分配一个自动生成的名称“txsp#”,其中#是一个连续数字,保证保存点的唯一性会话的水平。

releaseSavepoint ()

未定义releaseSavepoint 字符串 的名字

移除在事务上定义的保存点。

参数
的名字 带有要删除的保存点名称的字符串。

从当前事务上定义的保存点集合中删除命名保存点。这不会影响在事务上执行的操作,因为没有发生提交或回滚。

这是一个试图删除不存在的保存点的错误。

rollbackTo ()

未定义rollbackTo 字符串 的名字

将事务回滚到指定的保存点,而不终止事务。

参数
的名字 带有回滚操作保存点名称的字符串。

在定义保存点之后,当前事务对行所做的修改将被回滚。

给定的保存点不会被删除,但是在定义给定保存点之后定义的任何保存点都会被删除。

这是一个使用不存在的保存点调用此操作的错误。

runSql ()

SqlResultrunSql 字符串 查询
数组 arg游戏

执行查询并返回相应的SqlResult对象。

参数
查询 要对数据库执行的SQL查询。
arg游戏 替换时要使用的可选文字列表?查询字符串中的占位符。
返回
一个SqlResult对象。
异常
LogicError 如果没有公开会议。
ArgumentError 参数无效。