Pulsar SQL REST APIs

    All requests for Presto services should use Presto REST API v1 version.

    To request services, use explicit URL . You need to update presto.service:8081 with your real Presto address before sending requests.

    For more information about headers, refer to PrestoHeaders.

    Schema

    You can use statement in the HTTP body. All data is received as JSON document that might contain a nextUri link. If the received JSON document contains a nextUri link, the request continues with the nextUri link until the received data does not contain a nextUri link. If no error is returned, the query completes successfully. If an error field is displayed in stats, it means the query fails.

    2. ➜  ~ curl --header "X-Presto-User: test-user" --request POST --data 'show catalogs' http://localhost:8081/v1/statement
    3. {
    4.    "infoUri" : "http://localhost:8081/ui/query.html?20191113_033653_00006_dg6hb",
    5.    "stats" : {
    6.       "queued" : true,
    7.       "nodes" : 0,
    8.       "userTimeMillis" : 0,
    9.       "cpuTimeMillis" : 0,
    10.       "wallTimeMillis" : 0,
    11.       "processedBytes" : 0,
    12.       "processedRows" : 0,
    13.       "runningSplits" : 0,
    14.       "queuedTimeMillis" : 0,
    15.       "queuedSplits" : 0,
    16.       "completedSplits" : 0,
    17.       "totalSplits" : 0,
    18.       "scheduled" : false,
    19.       "peakMemoryBytes" : 0,
    20.       "state" : "QUEUED",
    21.       "elapsedTimeMillis" : 0
    22.    },
    23.    "id" : "20191113_033653_00006_dg6hb",
    24.    "nextUri" : "http://localhost:8081/v1/statement/20191113_033653_00006_dg6hb/1"
    25. }
    27. ➜  ~ curl http://localhost:8081/v1/statement/20191113_033653_00006_dg6hb/1
    28. {
    29.    "infoUri" : "http://localhost:8081/ui/query.html?20191113_033653_00006_dg6hb",
    30.    "nextUri" : "http://localhost:8081/v1/statement/20191113_033653_00006_dg6hb/2",
    31.    "id" : "20191113_033653_00006_dg6hb",
    32.    "stats" : {
    33.       "state" : "PLANNING",
    34.       "totalSplits" : 0,
    35.       "queued" : false,
    36.       "userTimeMillis" : 0,
    37.       "completedSplits" : 0,
    38.       "scheduled" : false,
    39.       "wallTimeMillis" : 0,
    41.       "queuedSplits" : 0,
    42.       "cpuTimeMillis" : 0,
    43.       "processedRows" : 0,
    44.       "processedBytes" : 0,
    45.       "nodes" : 0,
    46.       "queuedTimeMillis" : 1,
    47.       "elapsedTimeMillis" : 2,
    48.    }
    49. }
    51. ➜  ~ curl http://localhost:8081/v1/statement/20191113_033653_00006_dg6hb/2
    52. {
    53.    "id" : "20191113_033653_00006_dg6hb",
    54.    "data" : [
    55.       [
    56.          "pulsar"
    57.       ],
    58.       [
    59.          "system"
    60.       ]
    61.    ],
    62.    "infoUri" : "http://localhost:8081/ui/query.html?20191113_033653_00006_dg6hb",
    63.    "columns" : [
    64.       {
    65.          "typeSignature" : {
    66.             "rawType" : "varchar",
    67.             "arguments" : [
    68.                {
    69.                   "kind" : "LONG_LITERAL",
    70.                   "value" : 6
    71.                }
    72.             ],
    73.             "literalArguments" : [],
    74.             "typeArguments" : []
    75.          },
    76.          "name" : "Catalog",
    77.          "type" : "varchar(6)"
    78.       }
    79.    ],
    80.    "stats" : {
    81.       "wallTimeMillis" : 104,
    82.       "scheduled" : true,
    83.       "userTimeMillis" : 14,
    84.       "progressPercentage" : 100,
    85.       "totalSplits" : 19,
    86.       "nodes" : 1,
    87.       "cpuTimeMillis" : 16,
    88.       "queued" : false,
    89.       "queuedTimeMillis" : 1,
    90.       "state" : "FINISHED",
    91.       "peakMemoryBytes" : 0,
    92.       "elapsedTimeMillis" : 111,
    93.       "processedBytes" : 0,
    95.       "queuedSplits" : 0,
    96.       "rootStage" : {
    97.          "cpuTimeMillis" : 1,
    98.          "state" : "FINISHED",
    99.          "completedSplits" : 1,
    100.          "subStages" : [
    101.             {
    102.                "cpuTimeMillis" : 14,
    103.                "runningSplits" : 0,
    104.                "state" : "FINISHED",
    105.                "completedSplits" : 17,
    106.                "subStages" : [
    107.                   {
    108.                      "wallTimeMillis" : 7,
    109.                      "subStages" : [],
    110.                      "stageId" : "2",
    111.                      "done" : true,
    112.                      "nodes" : 1,
    113.                      "totalSplits" : 1,
    114.                      "processedBytes" : 22,
    115.                      "processedRows" : 2,
    116.                      "queuedSplits" : 0,
    117.                      "userTimeMillis" : 1,
    118.                      "cpuTimeMillis" : 1,
    119.                      "runningSplits" : 0,
    120.                      "state" : "FINISHED",
    121.                      "completedSplits" : 1
    122.                   }
    123.                ],
    124.                "wallTimeMillis" : 92,
    125.                "nodes" : 1,
    126.                "done" : true,
    127.                "stageId" : "1",
    128.                "userTimeMillis" : 12,
    129.                "processedRows" : 2,
    130.                "processedBytes" : 51,
    131.                "queuedSplits" : 0,
    132.                "totalSplits" : 17
    133.             }
    134.          ],
    135.          "wallTimeMillis" : 5,
    136.          "done" : true,
    137.          "nodes" : 1,
    138.          "stageId" : "0",
    139.          "userTimeMillis" : 1,
    140.          "processedRows" : 2,
    141.          "processedBytes" : 22,
    142.          "totalSplits" : 1,
    143.          "queuedSplits" : 0
    144.       },
    145.       "runningSplits" : 0,
    146.       "completedSplits" : 19
    147.    }
    note

    Since the response data is not in sync with the query state from the perspective of clients, you cannot rely on the response data to determine whether the query completes.

    For more information about Presto REST API, refer to .