MySQL Shell API8.0.26
MySQL产品的统一开发接口
方法|属性|全体成员名单
会话类参考

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

方法

模式 create_schema(str名称)
在数据库上创建模式并返回相应的对象。更多…
模式 get_schema(str名称)
检索模式对象从当前会话到它的名称。更多…
模式 get_default_schema()
检索模式配置为会话的默认值。更多…
模式 get_current_schema()
检索会话上的活动模式。更多…
模式 set_current_schema(str名称)
设置此会话的当前模式,并为其返回模式对象。更多…
列表 get_schemas()
检索会话上可用的schema。更多…
str get_uri()
检索当前会话的URI。更多…
没有一个 关闭()
关闭会话。更多…
没有一个 set_fetch_warnings(bool启用)
启用或禁用生成警告。更多…
结果 start_transaction()
在服务器上启动事务上下文。更多…
结果 提交()
将调用后执行的所有操作提交给start_transaction ()更多…
结果 回滚()
调用后,放弃执行的所有操作start_transaction ()更多…
没有一个 drop_schema(str名称)
删除具有指定名称的模式。更多…
保龄球 is_open()
如果已知会话是打开的,则返回true。更多…
SqlExecute sql(str sql)
创建一个SqlExecute对象,允许在目标MySQL服务器上运行接收到的SQL语句。更多…
str quote_name(str id)
转义传递的标识符。更多…
str set_savepoint(str name = " ")
用给定的名称创建或替换事务保存点。更多…
没有一个 release_savepoint(str名称)
删除事务上定义的保存点。更多…
没有一个 rollback_to(str名称)
在不终止事务的情况下将事务回滚到指定的保存点。更多…
SqlResult run_sql(str查询,列表参数)
执行一个查询并返回相应的SqlResult对象。更多…

属性

str uri
检索当前会话的URI。
模式 default_schema
检索模式配置为会话的默认值。
模式 current_schema
检索会话上的活动模式。

详细描述

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

除了SQL之外,还可以通过该对象使用文档存储功能。

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

JavaScript的例子

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

Python示例

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

成员功能文档10bet官方网站

create_schema ()

模式create_schema str 的名字

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

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

get_schema ()

模式get_schema str 的名字

检索模式对象从当前会话到它的名称。

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

get_default_schema ()

模式get_default_schema

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

返回
一个模式对象或Null

get_current_schema ()

std:: string get_current_schema

检索会话上的活动模式。

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

set_current_schema ()

模式set_current_schema str 的名字

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

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

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

使用< new-default-schema >;

get_schemas ()

shcore: Array_t get_schemas

检索会话上可用的schema。

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

get_uri ()

str get_uri

检索当前会话的URI。

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

close ()

空白密切

关闭会话。

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

set_fetch_warnings ()

std::要查看<结果> set_fetch_warnings 保龄球 启用

启用或禁用生成警告。

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

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

在Node会话上,警告生成默认是禁用的。该功能可以根据接收到的参数设置是否生成告警。

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

start_transaction ()

空白start_transaction

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

返回
一个SqlResult对象。

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

调用此函数后执行的所有操作仅在以下情况下发生commit ()被称为。

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

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

commit ()

无效的承诺

将调用后执行的所有操作提交给start_transaction ()

返回
一个SqlResult对象。

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

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

rollback ()

空回滚

调用后,放弃执行的所有操作start_transaction ()

返回
一个SqlResult对象。

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

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

drop_schema ()

没有drop_schema str 的名字

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

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

is_open ()

bool is_open

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

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

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

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

sql ()

SqlExecutesql str sql

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

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

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

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

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

JavaScript的例子

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

quote_name ()

str quote_name str id

转义传递的标识符。

参数
id 要引用的标识符。
返回
包含转义标识符的字符串。

set_savepoint ()

str set_savepoint str 的名字=""

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

参数
的名字 可选字符串,其中包含要分配给事务保存点的名称。
返回
事务保存点的名称。

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

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

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

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

release_savepoint ()

没有release_savepoint str 的名字

删除事务上定义的保存点。

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

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

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

rollback_to ()

没有rollback_to str 的名字

在不终止事务的情况下将事务回滚到指定的保存点。

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

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

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

使用不存在的保存点调用此操作会出错。

run_sql ()

SqlResultrun_sql str 查询
列表 arg游戏

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

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