Query Profile Action

Request

GET /rest/v2/manager/query/query_info

GET /rest/v2/manager/query/trace/{trace_id}

GET /rest/v2/manager/query/sql/{query_id}

GET /rest/v2/manager/query/profile/text/{query_id}

GET /rest/v2/manager/query/profile/graph/{query_id}

GET /rest/v2/manager/query/profile/json/{query_id}

GET /rest/v2/manager/query/profile/fragments/{query_id}

GET /rest/v2/manager/query/current_queries

GET /rest/v2/manager/query/kill/{query_id}

Get the query information

GET /rest/v2/manager/query/query_info

Description

Gets information about select queries for all fe nodes in the cluster.

Query parameters

  • query_id

    Optional, specifies the query ID of the query to be returned, default returns information for all queries.

  • search

    Optional, specifies that query information containing strings is returned, currently only string matches are performed.

  • is_all_node

    Optional, if true, returns query information for all fe nodes, if false, returns query information for the current fe node. The default is true.

Response

  1. {
  2.     "msg": "success",
  3.     "code": 0,
  4.     "data": {
  5.         "column_names": [
  6.             "Query ID",
  7.             "FE节点",
  8.             "查询用户",
  9.             "执行数据库",
  10.             "Sql",
  11.             "查询类型",
  12.             "开始时间",
  13.             "结束时间",
  14.             "执行时长",
  15.             "状态"
  16.         ],
  17.         "rows": [
  18.             [
  19.                 ...
  20.             ]
  21.         ]
  22.     },
  23.     "count": 0
  24. }

SinceVersion 1.2

Admin 和 Root 用户可以查看所有 Query。普通用户仅能查看自己发送的 Query。

Examples

  1. GET /rest/v2/manager/query/query_info
  3. {
  4.     "msg": "success",
  5.     "code": 0,
  6.     "data": {
  7.         "column_names": [
  8.             "Query ID",
  9.             "FE节点",
  10.             "查询用户",
  11.             "执行数据库",
  12.             "Sql",
  13.             "查询类型",
  14.             "开始时间",
  15.             "结束时间",
  16.             "执行时长",
  17.             "状态"
  18.         ],
  19.         "rows": [
  20.             [
  21.                 "d7c93d9275334c35-9e6ac5f295a7134b",
  22.                 "127.0.0.1:8030",
  23.                 "root",
  24.                 "default_cluster:testdb",
  25.                 "select c.id, c.name, p.age, p.phone, c.date, c.cost from cost c join people p on c.id = p.id where p.age > 20 order by c.id",
  26.                 "Query",
  27.                 "2021-07-29 16:59:12",
  28.                 "2021-07-29 16:59:12",
  29.                 "109ms",
  30.                 "EOF"
  31.             ]
  32.         ]
  33.     },
  34.     "count": 0
  35. }

Get Query Id By Trace Id

GET /rest/v2/manager/query/trace_id/{trace_id}

Description

Get query id by trance id.

Before executing a Query, set a unique trace id:

set set session_context="trace_id:your_trace_id";

After executing the Query within the same Session, the query id can be obtained through the trace id.

Path parameters

  • {trace_id}

    User specific trace id.

Query parameters

Response

  1. {
  2.     "msg": "success", 
  3.     "code": 0, 
  4.     "data": "fb1d9737de914af1-a498d5c5dec638d3", 
  5.     "count": 0
  6. }

SinceVersion 1.2

Admin and Root user can view all queries. Ordinary users can only view the Query sent by themselves. If the specified trace id does not exist or has no permission, it will return Bad Request:

  1. {
  2.     "msg": "Bad Request", 
  3.     "code": 403, 
  4.     "data": "error messages",
  5.     "count": 0
  6. }

Get the sql and text profile for the specified query

GET /rest/v2/manager/query/sql/{query_id}

GET /rest/v2/manager/query/profile/text/{query_id}

Description

Get the sql and profile text for the specified query id.

Path parameters

  • query_id

    The query id.

Query parameters

  • is_all_node

    Optional, if true then query for the specified query id in all fe nodes, if false then query for the specified query id in the currently connected fe nodes. The default is true.

Response

  1. {
  2.     "msg": "success",
  3.     "code": 0,
  4.     "data": {
  5.         "sql": ""
  6.     },
  7.     "count": 0
  8. }
  1. {
  2.     "msg": "success",
  3.     "code": 0,
  4.     "data": {
  5.         "profile": ""
  6.     },
  7.     "count": 0
  8. }

SinceVersion 1.2

Admin and Root user can view all queries. Ordinary users can only view the Query sent by themselves. If the specified trace id does not exist or has no permission, it will return Bad Request:

  1. {
  2.     "msg": "Bad Request", 
  3.     "code": 403, 
  4.     "data": "error messages",
  5.     "count": 0
  6. }

### Examples

  1. get sql.

    1. GET /rest/v2/manager/query/sql/d7c93d9275334c35-9e6ac5f295a7134b
    3. Response:
    4. {
    5.     "msg": "success",
    6.     "code": 0,
    7.     "data": {
    8.         "sql": "select c.id, c.name, p.age, p.phone, c.date, c.cost from cost c join people p on c.id = p.id where p.age > 20 order by c.id"
    9.     },
    10.     "count": 0
    11. }

Get the specified query fragment and instance information

GET /rest/v2/manager/query/profile/fragments/{query_id}

Description

Get the fragment name, instance id and execution time for the specified query id.

Path parameters

  • query_id

    The query id.

Query parameters

  • is_all_node

    Optional, if true then query for the specified query id in all fe nodes, if false then query for the specified query id in the currently connected fe nodes. The default is true.

Response

  1. {
  2.     "msg": "success",
  3.     "code": 0,
  4.     "data": [
  5.         {
  6.             "fragment_id": "",
  7.             "time": "",
  8.             "instance_id": {
  9.                 "": ""
  10.             }
  11.         }
  12.     ],
  13.     "count": 0
  14. }

SinceVersion 1.2

Admin and Root user can view all queries. Ordinary users can only view the Query sent by themselves. If the specified trace id does not exist or has no permission, it will return Bad Request:

  1. {
  2.     "msg": "Bad Request", 
  3.     "code": 403, 
  4.     "data": "error messages",
  5.     "count": 0
  6. }

### Examples

  1. ```
  2. GET /rest/v2/manager/query/profile/fragments/d7c93d9275334c35-9e6ac5f295a7134b
  4. Response:
  5. {
  6.     "msg": "success",
  7.     "code": 0,
  8.     "data": [
  9.         {
  10.             "fragment_id": "0",
  11.             "time": "36.169ms",
  12.             "instance_id": {
  13.                 "d7c93d9275334c35-9e6ac5f295a7134e": "36.169ms"
  14.             }
  15.         },
  16.         {
  17.             "fragment_id": "1",
  18.             "time": "20.710ms",
  19.             "instance_id": {
  20.                 "d7c93d9275334c35-9e6ac5f295a7134c": "20.710ms"
  21.             }
  22.         },
  23.         {
  24.             "fragment_id": "2",
  25.             "time": "7.83ms",
  26.             "instance_id": {
  27.                 "d7c93d9275334c35-9e6ac5f295a7134d": "7.83ms"
  28.             }
  29.         }
  30.     ],
  31.     "count": 0
  32. }
  33. ```

Get the specified query id tree profile information

GET /rest/v2/manager/query/profile/graph/{query_id}

Description

Get the tree profile information of the specified query id, same as show query profile command.

Path parameters

  • query_id

    The query id.

Query parameters

  • fragment_id and instance_id

    Optional, both parameters must be specified or not.
    If both are not specified, a simple tree of profiles is returned, equivalent to show query profile '/query_id';
    If both are specified, a detailed profile tree is returned, which is equivalent to show query profile '/query_id/fragment_id/instance_id'.

  • is_all_node

    Optional, if true then query information about the specified query id in all fe nodes, if false then query information about the specified query id in the currently connected fe nodes. The default is true.

Response

  1. {
  2.     "msg": "success",
  3.     "code": 0,
  4.     "data": {
  5.         "graph":""
  6.     },
  7.     "count": 0
  8. }

SinceVersion 1.2

Admin and Root user can view all queries. Ordinary users can only view the Query sent by themselves. If the specified trace id does not exist or has no permission, it will return Bad Request:

  1. {
  2.     "msg": "Bad Request", 
  3.     "code": 403, 
  4.     "data": "error messages",
  5.     "count": 0
  6. }

Current running queries

GET /rest/v2/manager/query/current_queries

Description

Same as show proc "/current_query_stmts", return current running queries.

Path parameters

Query parameters

  • is_all_node

    Optional. Return current running queries from all FE if set to true. Default is true.

Response

  1. {
  2.     "msg": "success",
  3.     "code": 0,
  4.     "data": {
  5.         "columnNames": ["Frontend", "QueryId", "ConnectionId", "Database", "User", "ExecTime", "SqlHash", "Statement"],
  6.         "rows": [
  7.             ["172.19.0.3", "108e47ab438a4560-ab1651d16c036491", "2", "", "root", "6074", "1a35f62f4b14b9d7961b057b77c3102f", "select sleep(60)"],
  8.             ["172.19.0.11", "3606cad4e34b49c6-867bf6862cacc645", "3", "", "root", "9306", "1a35f62f4b14b9d7961b057b77c3102f", "select sleep(60)"]
  9.         ]
  10.     },
  11.     "count": 0
  12. }

Cancel query

POST /rest/v2/manager/query/kill/{query_id}

Description

Cancel query of specified connection.

Path parameters

  • {query_id}

    query id. You can get query id by trance_id api.

Query parameters

Response

  1. {
  2.     "msg": "success",
  3.     "code": 0,
  4.     "data": null,
  5.     "count": 0
  6. }