Pulsar SQL REST APIs

本部分列出了构成 Presto REST API v1的资源。

请求 Presto 服务

Presto 服务的所有请求都应该使用 Presto REST API v1 版本。

若要请求服务，请使用显式的 URL http://presto.service:8081/v1。 你需要在发送请求前用真实的 Presto 地址更新 presto.service:8081。

POST 请求需要 X-Presto-User Header。 如果你使用身份认证，则必须使用认证配置中指定的相同的 username。 如果你不使用身份认证，可随意设置 username 。

  1. X-Presto-User: username

关于 Header 的更新信息，可参考PrestoHeaders。

Schema

你可以在 HTTP 正文中使用声明。 所有数据都以 JSON 文档格式接收，JSON 中可能包含一个 nextUri 链接。 如果收到的 JSON 文档包含一个 nextUri 链接，请求会继续带有 nextUri 链接进行，直到收到的数据不包含 nextUri 链接为止。 如果没有返回错误，则查询成功。 如果在 stats 中显示一个 error 字段，则意味着查询失败。

下面是 show catalogs 的示例。 此查询将持续进行，直到接收的 JSON 文档不包含 nextUri 链接为止。 如果在 stats 中未显示 error，就说明查询成功。

  1. ➜  ~ curl --header "X-Presto-User: test-user" --request POST --data 'show catalogs' http://localhost:8081/v1/statement
  2. {
  3.    "infoUri" : "http://localhost:8081/ui/query.html?20191113_033653_00006_dg6hb",
  4.    "stats" : {
  5.       "queued" : true,
  6.       "nodes" : 0,
  7.       "userTimeMillis" : 0,
  8.       "cpuTimeMillis" : 0,
  9.       "wallTimeMillis" : 0,
  10.       "processedBytes" : 0,
  11.       "processedRows" : 0,
  12.       "runningSplits" : 0,
  13.       "queuedTimeMillis" : 0,
  14.       "queuedSplits" : 0,
  15.       "completedSplits" : 0,
  16.       "totalSplits" : 0,
  17.       "scheduled" : false,
  18.       "peakMemoryBytes" : 0,
  19.       "state" : "QUEUED",
  20.       "elapsedTimeMillis" : 0
  21.    },
  22.    "id" : "20191113_033653_00006_dg6hb",
  23.    "nextUri" : "http://localhost:8081/v1/statement/20191113_033653_00006_dg6hb/1"
  24. }
  26. ➜  ~ curl http://localhost:8081/v1/statement/20191113_033653_00006_dg6hb/1
  27. {
  28.    "infoUri" : "http://localhost:8081/ui/query.html?20191113_033653_00006_dg6hb",
  29.    "nextUri" : "http://localhost:8081/v1/statement/20191113_033653_00006_dg6hb/2",
  30.    "id" : "20191113_033653_00006_dg6hb",
  31.    "stats" : {
  32.       "state" : "PLANNING",
  33.       "totalSplits" : 0,
  34.       "queued" : false,
  35.       "userTimeMillis" : 0,
  36.       "completedSplits" : 0,
  37.       "scheduled" : false,
  38.       "wallTimeMillis" : 0,
  39.       "runningSplits" : 0,
  40.       "queuedSplits" : 0,
  41.       "cpuTimeMillis" : 0,
  42.       "processedRows" : 0,
  43.       "processedBytes" : 0,
  44.       "nodes" : 0,
  45.       "queuedTimeMillis" : 1,
  46.       "elapsedTimeMillis" : 2,
  47.       "peakMemoryBytes" : 0
  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,
  94.       "processedRows" : 0,
  95.       "queuedSplits" : 0,
  96.       "rootStage" : {
  97.          "cpuTimeMillis" : 1,
  98.          "runningSplits" : 0,
  99.          "state" : "FINISHED",
  100.          "completedSplits" : 1,
  101.          "subStages" : [
  102.             {
  103.                "cpuTimeMillis" : 14,
  104.                "runningSplits" : 0,
  105.                "state" : "FINISHED",
  106.                "completedSplits" : 17,
  107.                "subStages" : [
  108.                   {
  109.                      "wallTimeMillis" : 7,
  110.                      "subStages" : [],
  111.                      "stageId" : "2",
  112.                      "done" : true,
  113.                      "nodes" : 1,
  114.                      "totalSplits" : 1,
  115.                      "processedBytes" : 22,
  116.                      "processedRows" : 2,
  117.                      "queuedSplits" : 0,
  118.                      "userTimeMillis" : 1,
  119.                      "cpuTimeMillis" : 1,
  120.                      "runningSplits" : 0,
  121.                      "state" : "FINISHED",
  122.                      "completedSplits" : 1
  123.                   }
  124.                ],
  125.                "wallTimeMillis" : 92,
  126.                "nodes" : 1,
  127.                "done" : true,
  128.                "stageId" : "1",
  129.                "userTimeMillis" : 12,
  130.                "processedRows" : 2,
  131.                "processedBytes" : 51,
  132.                "queuedSplits" : 0,
  133.                "totalSplits" : 17
  134.             }
  135.          ],
  136.          "wallTimeMillis" : 5,
  137.          "done" : true,
  138.          "nodes" : 1,
  139.          "stageId" : "0",
  140.          "userTimeMillis" : 1,
  141.          "processedRows" : 2,
  142.          "processedBytes" : 22,
  143.          "totalSplits" : 1,
  144.          "queuedSplits" : 0
  145.       },
  146.       "runningSplits" : 0,
  147.       "completedSplits" : 19
  148.    }
  149. }

Note

因为从客户端角度看响应数据与查询状态不同步， 所以不能依靠响应数据来确定查询是否完成。

关于 Presto REST API 的更多信息，请参阅 Presto HTTP 协议。