Blame - content/docs/0.9.5/api.html - incubator-asterixdb-site

Ian Maxon

a1cc51b

2020-08-07 13:11:35 -0700

[diff] [blame]

1

<!DOCTYPE html>

2

<!--

3

| Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/markdown/api.md at 2020-07-30

4

| Rendered using Apache Maven Fluido Skin 1.7

-->

<head>

<title>AsterixDB – HTTP API to AsterixDB</title>

</head>

</div>

<li id="publishDate">Last Published: 2020-07-30</li>

30

<li id="projectVersion" class="pull-right">Version: 0.9.5-SNAPSHOT</li>

31

<li class="pull-right"><a href="index.html" title="Documentation Home">Documentation Home</a></li>

</ul>

</div>

<li class="nav-header">Get Started - Installation</li>

39

<li><a href="ncservice.html" title="Option 1: using NCService"><span class="none"></span>Option 1: using NCService</a></li>

40

<li><a href="ansible.html" title="Option 2: using Ansible"><span class="none"></span>Option 2: using Ansible</a></li>

41

<li><a href="aws.html" title="Option 3: using Amazon Web Services"><span class="none"></span>Option 3: using Amazon Web Services</a></li>

42

<li class="nav-header">AsterixDB Primer</li>

43

<li><a href="sqlpp/primer-sqlpp.html" title="Using SQL++"><span class="none"></span>Using SQL++</a></li>

44

<li class="nav-header">Data Model</li>

45

<li><a href="datamodel.html" title="The Asterix Data Model"><span class="none"></span>The Asterix Data Model</a></li>

46

<li class="nav-header">Queries</li>

47

<li><a href="sqlpp/manual.html" title="The SQL++ Query Language"><span class="none"></span>The SQL++ Query Language</a></li>

48

<li><a href="sqlpp/builtins.html" title="Builtin Functions"><span class="none"></span>Builtin Functions</a></li>

49

50

51

<li><a href="csv.html" title="CSV Output"><span class="none"></span>CSV Output</a></li>

52

<li class="nav-header">Advanced Features</li>

53

<li><a href="aql/externaldata.html" title="Accessing External Data"><span class="none"></span>Accessing External Data</a></li>

54

<li><a href="feeds.html" title="Data Ingestion with Feeds"><span class="none"></span>Data Ingestion with Feeds</a></li>

55

<li><a href="udf.html" title="User Defined Functions"><span class="none"></span>User Defined Functions</a></li>

56

<li><a href="sqlpp/filters.html" title="Filter-Based LSM Index Acceleration"><span class="none"></span>Filter-Based LSM Index Acceleration</a></li>

57

<li><a href="sqlpp/fulltext.html" title="Support of Full-text Queries"><span class="none"></span>Support of Full-text Queries</a></li>

58

<li><a href="sqlpp/similarity.html" title="Support of Similarity Queries"><span class="none"></span>Support of Similarity Queries</a></li>

59

<li class="nav-header">Deprecated</li>

60

<li><a href="aql/primer.html" title="AsterixDB Primer: Using AQL"><span class="none"></span>AsterixDB Primer: Using AQL</a></li>

61

<li><a href="aql/manual.html" title="Queries: The Asterix Query Language (AQL)"><span class="none"></span>Queries: The Asterix Query Language (AQL)</a></li>

62

<li><a href="aql/builtins.html" title="Queries: Builtin Functions (AQL)"><span class="none"></span>Queries: Builtin Functions (AQL)</a></li>

</ul>

<hr />

</div>

</div>

</div>

<!--

! Licensed to the Apache Software Foundation (ASF) under one

77

! or more contributor license agreements. See the NOTICE file

78

! distributed with this work for additional information

79

! regarding copyright ownership. The ASF licenses this file

80

! to you under the Apache License, Version 2.0 (the

81

! "License"); you may not use this file except in compliance

82

! with the License. You may obtain a copy of the License at

83

!

84

! http://www.apache.org/licenses/LICENSE-2.0

85

!

86

! Unless required by applicable law or agreed to in writing,

87

! software distributed under the License is distributed on an

88

! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

89

! KIND, either express or implied. See the License for the

90

! specific language governing permissions and limitations

91

! under the License.

92

!-->

93

<h1>HTTP API to AsterixDB</h1>

94

95

<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>

96

<ul>

97

98

<li><a href="#queryservice">Query Service API</a></li>

99

<li><a href="#querystatus">Query Status API</a></li>

100

<li><a href="#queryresult">Query Result API</a></li>

101

</ul></div>

102

103

<h2><a name="POST_.2Fquery.2Fservice_.5BBack_to_TOC.5D"></a><a name="queryservice" id="queryservice">POST /query/service</a><font size="4"> <a href="#toc">[Back to TOC]</a></font></h2>

104

<p><b>Description</b> Returns result for query as JSON. The response is a JSON object that contains some result metadata along with either an embedded result or an opaque handle that can be used to navigate to the result (see the decription of the <tt>mode</tt> parameter for more details).</p>

105

<p><b>Parameters</b></p>

106

<ul>

107

108

<li><tt>statement</tt> - Specifies at least one valid SQL++ statement to run. The statements need to be urlencoded. Required.</li>

109

<li><tt>pretty</tt> - If the parameter <tt>pretty</tt> is given with the value <tt>true</tt>, the result will be indented. (Optional)</li>

110

<li><tt>client_context_id</tt> - A user-defined sequence of characters that the API receives and returns unchanged. This can be used e.g. to match individual requests, jobs, and responses. Another option could be to use it for groups of requests if an application decides to put e.g. an group identifier into that field to route groups of responses to a particular response processor.</li>

111

<li><tt>mode</tt> - Result delivery mode. Possible values are <tt>immediate</tt>, <tt>deferred</tt>, <tt>async</tt> (default: <tt>immediate</tt>). If the delivery mode is <tt>immediate</tt> the query result is returned with the response. If the delivery mode is <tt>deferred</tt> the response contains a handle to the <a href="#queryresult">result</a>. If the delivery mode is <tt>async</tt> the response contains a handle to the query’s <a href="#querystatus">status</a>.</li>

112

<li><tt>readonly</tt> - Reject DDL and DML statements, only accept the following kinds: <a href="sqlpp/manual.html#SELECT_statements">SELECT</a>, <a href="sqlpp/manual.html#Declarations">USE</a>, <a href="sqlpp/manual.html#Declarations">DECLARE FUNCTION</a>, and <a href="sqlpp/manual.html#Performance_tuning">SET</a></li>

113

<li><tt>args</tt> - (SQL++ only) A JSON array where each item is a value of a <a href="sqlpp/manual.html#Parameter_references">positional query parameter</a></li>

114

<li><tt>$parameter_name</tt> - (SQL++ only) a JSON value of a <a href="sqlpp/manual.html#Parameter_references">named query parameter</a>.</li>

115

</ul>

116

<p><b>Command (immediate result delivery)</b></p>

<div>

<div>

<pre class="source">$ curl -v --data-urlencode "statement=select 1;" \

121

--data pretty=true \

122

--data client_context_id=xyz \

123

http://localhost:19002/query/service

124

</pre></div></div>

125

126

<p><b>Sample response</b></p>

<div>

<div>

<pre class="source">> POST /query/service HTTP/1.1

131

> Host: localhost:19002

132

> User-Agent: curl/7.43.0

133

> Accept: */*

134

> Content-Length: 57

135

> Content-Type: application/x-www-form-urlencoded

136

>

137

< HTTP/1.1 200 OK

138

< transfer-encoding: chunked

139

< connection: keep-alive

140

< content-type: application/json; charset=utf-8

141

<

142

{

143

"requestID": "5f72e78c-482a-45bf-b174-6443c8273025",

144

"clientContextID": "xyz",

"signature": "*",

"results": [ {

"$1" : 1

} ]

,

"status": "success",

"metrics": {

"elapsedTime": "20.263371ms",

153

"executionTime": "19.889389ms",

"resultCount": 1,

"resultSize": 15

}

}

</pre></div></div>

<p><b>Command (<a name="deferred" id="deferred">deferred result delivery</a>)</b></p>

<div>

<div>

<pre class="source">$ curl -v --data-urlencode "statement=select 1;" \

165

--data mode=deferred \

166

http://localhost:19002/query/service

167

</pre></div></div>

168

169

<p><b>Sample response</b></p>

<div>

<div>

<pre class="source">> POST /query/service HTTP/1.1

174

> Host: localhost:19002

175

> User-Agent: curl/7.43.0

176

> Accept: */*

177

> Content-Length: 37

178

> Content-Type: application/x-www-form-urlencoded

179

>

180

< HTTP/1.1 200 OK

181

< transfer-encoding: chunked

182

< connection: keep-alive

183

< content-type: application/json; charset=utf-8

184

<

185

{

186

"requestID": "6df7afb4-5f83-49b6-8c4b-f11ec84c4d7e",

187

"signature": "*",

188

"handle": "http://localhost:19002/query/service/result/7-0",

189

"status": "success",

190

"metrics": {

191

"elapsedTime": "12.270570ms",

192

"executionTime": "11.948343ms",

"resultCount": 0,

"resultSize": 0

}

}

</pre></div></div>

<p><b>Command (<a name="async" id="async>">async result delivery</a>)</b></p>

<div>

<div>

<pre class="source">$ curl -v --data-urlencode "statement=select 1;" \

204

--data mode=async \

205

http://localhost:19002/query/service

206

</pre></div></div>

207

208

<p><b>Sample response</b></p>

<div>

<div>

<pre class="source">> POST /query/service HTTP/1.1

213

> Host: localhost:19002

214

> User-Agent: curl/7.43.0

215

> Accept: */*

216

> Content-Length: 34

217

> Content-Type: application/x-www-form-urlencoded

218

>

219

< HTTP/1.1 200 OK

220

< transfer-encoding: chunked

221

< connection: keep-alive

222

< content-type: application/json; charset=utf-8

223

<

224

{

225

"requestID": "c5858420-d821-4c0c-81a4-2364386827c2",

226

"signature": "*",

227

"status": "running",

228

"handle": "http://localhost:19002/query/service/status/9-0",

229

"metrics": {

230

"elapsedTime": "9.727006ms",

231

"executionTime": "9.402282ms",

"resultCount": 0,

"resultSize": 0

}

}

</pre></div></div>

</div>

<h2><a name="GET_.2Fquery.2Fservice.2Fstatus_.5BBack_to_TOC.5D"></a><a name="querystatus" id="querystatus">GET /query/service/status</a><font size="4"> <a href="#toc">[Back to TOC]</a></font></h2>

240

<p><b>Description</b> Returns status of an <tt>async</tt> query request. The response is a JSON object that has a similar structure to the responses for the <a href="#queryservice">/query/service</a> endpoint. Possible status values for the status are <tt>running</tt>, <tt>success</tt>, <tt>timeout</tt>, <tt>failed</tt>, and <tt>fatal</tt>. If the status value is <tt>success</tt>, the response also contains a handle to the <a href="#queryresult">result</a>. URLs for this endpoint are usually not constructed by the application, they are simply extracted from the <tt>handle</tt> field of the response to a request to the <a href="#queryservice">/query/service</a> endpoint.</p>

241

<p><b>Command</b></p>

242

<p>This example shows a request/reponse for the (opaque) status handle that was returned by the <a href="#async">async result delivery</a> example.</p>

<div>

<div>

<pre class="source">$ curl -v http://localhost:19002/query/service/status/9-0

247

</pre></div></div>

248

249

<p><b>Sample response</b></p>

<div>

<div>

<pre class="source">> GET /query/service/status/9-0 HTTP/1.1

254

> Host: localhost:19002

255

> User-Agent: curl/7.43.0

> Accept: */*

>

< HTTP/1.1 200 OK

< transfer-encoding: chunked

260

< connection: keep-alive

261

< content-type: application/json; charset=utf-8

<

{

"status": "success",

"handle": "http://localhost:19002/query/service/result/9-0"

}

</pre></div></div>

</div>

<h2><a name="GET_.2Fquery.2Fservice.2Fresult_.5BBack_to_TOC.5D"></a><a name="queryresult" id="queryresult">GET /query/service/result</a><font size="4"> <a href="#toc">[Back to TOC]</a></font></h2>

271

<p><b>Description</b> Returns result set for an <tt>async</tt> or <tt>deferred</tt> query request. The response is a plain result without a wrapping JSON object. URLs for this endpoint are usually not constructed by the application, they are simply extracted from the <tt>handle</tt> field of the response to a request to the <a href="#queryservice">/query/service</a> or the <a href="#querystatus">/query/service/status</a> endpoint.</p>

272

<p><b>Command</b></p>

273

<p>This example shows a request/reponse for the (opaque) result handle that was returned by the <a href="#deferred">deferred result delivery</a> example.</p>

<div>

<div>

<pre class="source">$ curl -v http://localhost:19002/query/service/result/7-0

278

</pre></div></div>

279

280

<p><b>Sample response</b></p>