database/doris
2
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity
Files
ebbe6f650ca572b9dfcce60951b7dfc8d134b4a6
doris/docs/en/administrator-guide/http-actions/fe/statement-execution-action.md
Mingyu Chen c934cf93e1 [UI Part 5] Enable HTTP Server 2 by FE config (#4684) 
This is the last PR of proposal #4308

1. Add a new FE config `enable_http_server_v2` to enable new HTTP Server implementation. The default value is false.
2. Add a new FE config `http_api_extra_base_path` so that we can set base path for Frontend UI.
3. Refactor the new HTTP API response body. The return http status code is always 200, and using internal code in response body to indicate the certain error.
2020-10-13 10:07:50 +08:00

2.7 KiB
Raw Blame History

title, language
title language
Statement Execution Action en

Statement Execution Action

Request

POST /api/query/<ns_name>/<db_name>

Description

Statement Execution Action is used to execute a statement and return the result.

Path parameters

  • <db_name>

    Specify the database name. This database will be regarded as the default database of the current session. If the table name in SQL does not qualify the database name, this database will be used.

Query parameters

None

Request body

{
    "stmt" : "select * from tbl1"
}
  • sql 字段为具体的 SQL

Response

  • 返回结果集

    {
    "msg": "success",
    "code": 0,
    "data": {
        "type": "result_set",
        "data": [
            [1],
            [2]
        ],
        "meta": [{
            "name": "k1",
            "type": "INT"
        }],
        "status": {},
        "time": 10
    },
    "count": 0
}
    • The type field is result_set, which means the result set is returned. The results need to be obtained and displayed based on the meta and data fields. The meta field describes the column information returned. The data field returns the result row. The column type in each row needs to be judged by the content of the meta field. The status field returns some information of MySQL, such as the number of alarm rows, status code, etc. The time field return the execution time, unit is millisecond.

  • Return execution result

    {
    "msg": "success",
    "code": 0,
    "data": {
        "type": "exec_status",
        "status": {}
    },
    "count": 0,
    "time": 10
}
    • The type field is exec_status, which means the execution result is returned. At present, if the return result is received, it means that the statement was executed successfully.