创建数据库会话
在连接数据库执行 SQL 语句之前,需要首先创建数据库会话,获取会话 ID,这样才能保证后续的 SQL 语句是在同一个会话中。
例如,先后执行如下两条语句:
- use test;
- select * from users;
使用会话将帮助用户在执行第二条语句时记住当前是在 test 库下执行。
接口URL
/api/v1/dms/sqleditor/clusters/{clusterID}/session
请求方式
POST
Content-Type
application/json
认证方式
Bearer auth
路径变量
参数名 | 示例值 | 参数描述 |
---|---|---|
clusterID | tidb-f91e1f860d360502 | cluster ID |
请求Body参数
{
"database": "test"
}
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
database | test | String | 是 | - |
成功响应示例
{
"Data": {
"sessionID": "487b5c89-a7e4-4889-b8f7-e2b9bc1fd2f2"
},
"Success": true
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
code | - | String | |
data.sessionID | - | String | session ID |
message | - | String | |
success | - | Boolean |