更新时间:2022-04-16 GMT+08:00
分享

检查SQL语法

功能介绍

该API用于检查SQL语法。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    POST /v1.0/{project_id}/jobs/check-sql

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

sql

String

待执行的SQL语句。

currentdb

String

SQL语句执行所在的数据库。

说明:
  • 在SQL里面已经包含db_name的情况下可以不选该参数,例如SQL为:select * from db1.t1
  • SQL里面不包含db_name时,不选该参数或者选错该参数均会导致语法校验不通过。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

job_type

String

作业类型。包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT。

示例

  • 请求样例:
    {
       "currentdb": "db1",
       "sql": "select * from t1"   
    }
  • 成功响应样例:
    {
      "is_success": true,
      "message": "the sql is ok",
      "job_type":QUERY
    }

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

请求成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close