SQL 语句执行

在连接数据库执行完 SQL 语句之后，需要主动关闭会话，避免出现资源泄露、连接限制用尽等问题

接口URL

/api/v1/dms/sqleditor/statement

请求方式

POST

Content-Type

application/json

认证方式

Bearer auth

请求Body参数

{
    "clusterID": "tidb-f91e1f860d360502",
    "database": "test",
    "sessionID": "dd832b71-2bcf-4da2-af51-699afb3ac945",
    "sql": "SELECT * FROM regions;",
    "userID": "haibo"
}

成功响应示例

{
    "Data": {
        "statementResults": [
            {
                "ResultID": "stmt-3478642343338540",
                "clusterID": "tidb-f91e1f860d360502",
                "execPlan": {
                    "columns": [
                        {
                            "name": "id",
                            "dataType": "CHAR",
                            "nullable": true
                        },
                        {
                            "name": "estRows",
                            "dataType": "CHAR",
                            "nullable": true
                        },
                        {
                            "name": "task",
                            "dataType": "CHAR",
                            "nullable": true
                        },
                        {
                            "name": "access object",
                            "dataType": "CHAR",
                            "nullable": true
                        },
                        {
                            "name": "operator info",
                            "dataType": "CHAR",
                            "nullable": true
                        }
                    ],
                    "rows": [
                        [
                            "TableReader_5",
                            "5.00",
                            "root",
                            "",
                            "data:TableFullScan_4"
                        ],
                        [
                            "└─TableFullScan_4",
                            "5.00",
                            "cop[tikv]",
                            "table:regions",
                            "keep order:false, stats:pseudo"
                        ]
                    ],
                    "matrix": true,
                    "msg": "",
                    "summary": "Query OK!"
                },
                "execInfo": {
                    "startTime": "2023-09-21T15:17:48.625398691+08:00",
                    "endTime": "2023-09-21T15:17:48.62738171+08:00",
                    "executeTime": "0.002 s",
                    "query": "SELECT * FROM regions;",
                    "limit": 1000,
                    "rowCount": 5
                },
                "resultSet": {
           "code": 0, // 0 表示成功，非 0 表示失败（比如下面 msg )
                    "columns": [
                        {
                            "name": "region_id",
                            "dataType": "INT",
                            "nullable": false
                        },
                        {
                            "name": "region_name",
                            "dataType": "VARCHAR",
                            "nullable": true
                        }
                    ],
                    "rows": [
                        [
                            "1",
                            "欧洲"
                        ],
                        [
                            "2",
                            "美洲"
                        ],
                        [
                            "3",
                            "亚洲"
                        ],
                        [
                            "4",
                            "中东和非洲"
                        ],
                        [
                            "5",
                            "澳洲"
                        ]
                    ],
                    "matrix": true,
                    "msg": "",
                    "summary": "Query OK!"
                },
                "database": "test",
                "userID": "haibo"
            }
        ]
    },
    "Success": true
}