Help Center/ Data Lake Insight/ API Reference (ME-Abu Dhabi Region)/ APIs Related to SQL Jobs/ Job-related APIs/ Checking SQL Syntax
Updated on 2022-12-07 GMT+08:00
View PDF
Share

Checking SQL Syntax

Function

This API is used to check the SQL syntax.

URI

  • URI format

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

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

sql

Yes

String

SQL statement that you want to execute.

currentdb

No

String

Database where the SQL statement is executed.

NOTE:
  • If the SQL statement contains db_name, for example, select * from db1.t1, you do not need to set this parameter.
  • If the SQL statement does not contain db_name, the semantics check will fail when you do not set this parameter or set this parameter to an incorrect value.

Response

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

System prompt. If execution succeeds, the parameter setting may be left blank.

job_type

No

String

Type of a job. Job types include the following: DDL, DCL, IMPORT, EXPORT, QUERY, and INSERT.

Example Request

{
   "currentdb": "db1",
   "sql": "select * from t1"   
}

Example Response

{
  "is_success": true,
  "message": "the sql is ok",
  "job_type":"QUERY"
}

Status Codes

Table 4 describes the status code.

Table 4 Status codes

Status Code

Description

200

The request is successful.

400

Request error.

500

Internal service error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.

Parent topic: Job-related APIs