Checking SQL Syntax
Function
This API is used to check the SQL syntax.
URI
- URI format
- Parameter descriptions
Table 1 URI parameter 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 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:
|
Response Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
is_success |
No |
Boolean |
Whether the request is successfully executed. true indicates that the request is successfully executed. |
message |
No |
String |
System prompt. If the execution succeeds, this parameter may be left blank. |
job_type |
No |
String |
Job type. Options: DDL, DCL, IMPORT, EXPORT, QUERY, and INSERT.
|
Example Request
Check the syntax of the SQL statement select * from t1.
{ "currentdb": "db1", "sql": "select * from t1" }
Example Response
{ "is_success": true, "message": "the sql is ok", "job_type":"QUERY" }
Status Codes
Table 4 describes status codes.
Error Codes
If an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot