-
Notifications
You must be signed in to change notification settings - Fork 13
SQL FaaS API manual
sqlparser edited this page Oct 8, 2014
·
6 revisions
SQL FaaS API exposes the following endpoints:
-
URL
-
Method
- POST
-
Content-Type
- application/x-www-form-urlencoded
-
Request parameters
Name Description rqst_input_sql Required, String. SQL string need to be formatted. rqst_db_vendor Optional, String. SQL from this database, available value rqst_output_fmt Optional, String. output type of formatted SQL, available value rqst_formatOptions Optional, String of json data. options used to control format style, sample format options, Detailed explanation rqst_isf_client Optional, String. Name of client who make this request. rqst_user_id Optional, String. User who make this request. -
Response parameters
Name Description rspn_formatted_sql String. Formatted SQL string. rspn_output_fmt string, output type of formatted SQL, available value rspn_parse_sql_status integer. this value should be 0, otherwise, SQL doesn't formatted correctly. rspn_parse_sql_message if rspn_parse_sql_status is not 0, then this is the detailed message. rspn_db_vendor string, this sql is recognized from this database. rspn_http_status Integer, 200 means everything works fine. 2xx means sql formatted correctly, but there maybe something wrong when processing this sql. 401 means your request is unauthorized. 500 means internal server error.