@dynatrace-sdk/client-query 1.1.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -7
- package/README.md +12 -41
- package/cjs/index.js +16 -8
- package/docs/DOCS.md +255 -795
- package/dynatrace-metadata.json +3 -6
- package/esm/index.js +16 -8
- package/package.json +1 -1
- package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts +33 -0
- package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts +34 -0
- package/types/packages/client/query/src/lib/models/grail-metadata.d.ts +4 -0
- package/types/packages/client/query/src/lib/models/grail-metadata.transformation.d.ts +1 -0
package/docs/DOCS.md
CHANGED
|
@@ -1,20 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Storage – Query Service
|
|
3
|
+
description: Exposes an API to fetch records stored in Grail.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Storage – Query Service
|
|
2
7
|
|
|
3
|
-
|
|
8
|
+
Exposes an API to fetch records stored in Grail
|
|
9
|
+
|
|
10
|
+
import NpmLogo from '@site/static/img/npm-logo.png';
|
|
11
|
+
|
|
12
|
+
<div class="row margin-bottom--md">
|
|
13
|
+
<div class="col">
|
|
14
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query">
|
|
15
|
+
<span class="margin-right--xs">@dynatrace-sdk/client-query</span>
|
|
16
|
+
<img className="no-zoom" width="20px" src={NpmLogo} />
|
|
17
|
+
</a>
|
|
18
|
+
</div>
|
|
19
|
+
<div class="col" style={{textAlign: 'right'}}>
|
|
20
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.2.2">v1.2.2</a>
|
|
21
|
+
</div>
|
|
22
|
+
</div>
|
|
4
23
|
|
|
5
24
|
```bash
|
|
6
25
|
npm install @dynatrace-sdk/client-query
|
|
7
26
|
```
|
|
8
27
|
|
|
9
|
-
Exposes an API to fetch records stored in Grail
|
|
10
|
-
|
|
11
28
|
## queryAssistanceClient
|
|
12
29
|
|
|
13
30
|
```js
|
|
14
|
-
import { queryAssistanceClient } from
|
|
31
|
+
import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
|
|
15
32
|
```
|
|
16
33
|
|
|
17
|
-
|
|
18
34
|
### queryAutocomplete
|
|
19
35
|
|
|
20
36
|
<div class="padding-bottom--md">
|
|
@@ -24,26 +40,28 @@ import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
|
|
|
24
40
|
|
|
25
41
|
Get a structured list of suggestions for the query at the given position.
|
|
26
42
|
|
|
43
|
+
For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
|
|
44
|
+
|
|
27
45
|
## Overview
|
|
28
46
|
|
|
29
47
|
We provide a list of suggestions that may be used after the cursor position. The following queries will all provide the
|
|
30
48
|
same results:
|
|
31
49
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
50
|
+
- `query: "f"`
|
|
51
|
+
- `query: "f", cursorPosition:1`
|
|
52
|
+
- `query: "fetch ", cursorPosition:1`
|
|
35
53
|
|
|
36
54
|
Available fields:
|
|
37
55
|
|
|
38
56
|
| Field | Description |
|
|
39
|
-
|
|
57
|
+
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
40
58
|
| suggestions | a list of suggestions. Each item is a separate possible suggestion, despite they might have the same outputs. |
|
|
41
59
|
| optional | whether the suggestion is optional. If `true`, the query until the cursor position might work. If `false`, the query is definitely incomplete or invalid if cut at the cursor position. |
|
|
42
60
|
|
|
43
61
|
Fields in the `suggestions`
|
|
44
62
|
|
|
45
63
|
| Field | Description |
|
|
46
|
-
|
|
64
|
+
| ---------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
47
65
|
| suggestion | a string representing the whole suggestion. This information could also be derived from the parts. |
|
|
48
66
|
| alreadyTypedCharacters | how many characters of this suggestion have already been typed (and will be overridden by the suggestion). |
|
|
49
67
|
| parts | a list of semantically enriched information on what are the parts of a suggestion. |
|
|
@@ -51,40 +69,29 @@ Fields in the `suggestions`
|
|
|
51
69
|
Fields in `parts`
|
|
52
70
|
|
|
53
71
|
| Field | Description |
|
|
54
|
-
|
|
72
|
+
| ---------- | --------------------------------------------------------- |
|
|
55
73
|
| suggestion | a string representing the current part of the suggestion. |
|
|
56
74
|
| type | current types: SPACE, PIPE, COMMAND (may be extended) |
|
|
57
75
|
|
|
58
76
|
The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
|
|
59
77
|
a link to docs, etc.
|
|
60
78
|
|
|
61
|
-
|
|
62
79
|
**Parameters**
|
|
63
80
|
|
|
64
81
|
<div class="padding-left--md padding-bottom--md">
|
|
65
82
|
<strong>config</strong>: Object
|
|
66
83
|
<div class="padding-left--md">
|
|
67
84
|
|
|
68
|
-
|
|
69
|
-
|
|
70
85
|
</div>
|
|
71
86
|
|
|
72
|
-
|
|
73
|
-
|
|
74
87
|
</div>
|
|
75
|
-
|
|
76
88
|
<div class="padding-left--md padding-bottom--md">
|
|
77
89
|
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
78
90
|
<div class="padding-left--md">
|
|
79
91
|
|
|
80
|
-
|
|
81
|
-
|
|
82
92
|
</div>
|
|
83
93
|
|
|
84
|
-
|
|
85
|
-
|
|
86
94
|
</div>
|
|
87
|
-
|
|
88
95
|
<div class="padding-left--md padding-bottom--md">
|
|
89
96
|
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
90
97
|
<div class="padding-left--md">
|
|
@@ -93,24 +100,15 @@ The authorization context. Typically start with 'Bearer '.
|
|
|
93
100
|
|
|
94
101
|
</div>
|
|
95
102
|
|
|
96
|
-
|
|
97
|
-
|
|
98
103
|
</div>
|
|
99
|
-
|
|
100
104
|
<div class="padding-left--md padding-bottom--md">
|
|
101
105
|
<strong>config.body</strong>: <a href="#autocompleterequest">AutocompleteRequest</a>
|
|
102
106
|
<div class="padding-left--md">
|
|
103
107
|
|
|
104
|
-
|
|
105
|
-
|
|
106
108
|
</div>
|
|
107
109
|
|
|
108
|
-
|
|
109
|
-
|
|
110
110
|
</div>
|
|
111
111
|
|
|
112
|
-
|
|
113
|
-
|
|
114
112
|
#### Returns
|
|
115
113
|
|
|
116
114
|
<div class="padding-left--md">
|
|
@@ -118,16 +116,26 @@ A list of structured autocomplete suggestions.
|
|
|
118
116
|
|
|
119
117
|
</div>
|
|
120
118
|
|
|
119
|
+
<details>
|
|
120
|
+
<summary>
|
|
121
|
+
Code example
|
|
121
122
|
|
|
123
|
+
</summary>
|
|
122
124
|
|
|
125
|
+
```ts
|
|
126
|
+
import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
|
|
123
127
|
|
|
128
|
+
const data = await queryAssistanceClient.queryAutocomplete({
|
|
129
|
+
authorization: "...",
|
|
130
|
+
body: {} as AutocompleteRequest,
|
|
131
|
+
});
|
|
132
|
+
```
|
|
124
133
|
|
|
125
|
-
</
|
|
126
|
-
|
|
127
|
-
|
|
134
|
+
</details>
|
|
128
135
|
|
|
129
136
|
</div>
|
|
130
137
|
|
|
138
|
+
</div>
|
|
131
139
|
|
|
132
140
|
### queryParse
|
|
133
141
|
|
|
@@ -138,6 +146,8 @@ A list of structured autocomplete suggestions.
|
|
|
138
146
|
|
|
139
147
|
Get a structured tree of the canonical form of the query.
|
|
140
148
|
|
|
149
|
+
For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
|
|
150
|
+
|
|
141
151
|
## Overview
|
|
142
152
|
|
|
143
153
|
Returns the parsed query as a tree, containing the structure of the canonical query. Tree-nodes can contain references to
|
|
@@ -150,20 +160,20 @@ The query tree consists of nodes that contain different additional information (
|
|
|
150
160
|
|
|
151
161
|
### General Fields
|
|
152
162
|
|
|
153
|
-
Field
|
|
154
|
-
|
|
155
|
-
tokenPosition
|
|
156
|
-
isOptional
|
|
163
|
+
| Field | Mandatory | Description |
|
|
164
|
+
| ------------- | --------- | -------------------------------------------------------------------------------------------------- |
|
|
165
|
+
| tokenPosition | no | optional. If present, it represents the position within the query string where the node refers to. |
|
|
166
|
+
| isOptional | no | whether this node could be left out and the result would still be the same query (semantically). |
|
|
157
167
|
|
|
158
168
|
#### tokenPosition
|
|
159
169
|
|
|
160
170
|
contains `start` (inclusive) and `end` (inclusive), both contain `index` (0 based; fur substrings), `line`
|
|
161
171
|
and `column` (both 1-based; for readability).
|
|
162
172
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
173
|
+
- If `tokenPosition` is present, it always contains start and end with all fields
|
|
174
|
+
- If `tokenPosition` is not present, there might still be nested nodes that do contain a position
|
|
175
|
+
- If `start == end`, the position refers to a single character
|
|
176
|
+
- If `start > end`, we know for sure that something was inserted.
|
|
167
177
|
|
|
168
178
|
We can always check whether the canonical representation of a node matches the text in the tokenPosition to see whether
|
|
169
179
|
something was inserted, removed, or changed.
|
|
@@ -173,93 +183,93 @@ something was inserted, removed, or changed.
|
|
|
173
183
|
only present if it is true.
|
|
174
184
|
|
|
175
185
|
Optional nodes can e.g. be optional braces that make a query more readable, but are not necessary. This could be used to
|
|
176
|
-
enter
|
|
186
|
+
enter _ghost braces_ and _implicit functions_ in the user's input field; maybe with different formatting
|
|
177
187
|
(using the tokenPosition of sibling nodes we can also check whether the user wrote these or not).
|
|
178
188
|
|
|
179
189
|
### Advanced Token Types
|
|
180
190
|
|
|
181
191
|
each node is of one of following types and may contain more fields:
|
|
182
192
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
193
|
+
- Terminal Node
|
|
194
|
+
- ContainerNode
|
|
195
|
+
- Alternative Node
|
|
186
196
|
|
|
187
197
|
#### Terminal Node
|
|
188
198
|
|
|
189
199
|
can be identified by checking whether `canonicalString` is present
|
|
190
200
|
|
|
191
|
-
Field
|
|
192
|
-
|
|
193
|
-
type
|
|
194
|
-
canonicalString
|
|
195
|
-
isMandatoryOnUserOrder
|
|
201
|
+
| Field | Mandatory | Description |
|
|
202
|
+
| ---------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
203
|
+
| type | yes | the type of the terminal node - do not confuse with the type of container nodes |
|
|
204
|
+
| canonicalString | yes | the canonical string representation. Concatenating the canonicalString of all nested terminal nodes provides the canonical form of the query. |
|
|
205
|
+
| isMandatoryOnUserOrder | no | may only be present if (`type="BRACE_OPEN"` or `type="BRACE_CLOSE"`) and `isOptional=true`. For usage see section [Special node type: PARAMETERS](#special-node-type-parameters) |
|
|
196
206
|
|
|
197
207
|
##### Current types of terminal nodes (list might grow):
|
|
198
208
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
209
|
+
- SPACE
|
|
210
|
+
- LINEBREAK
|
|
211
|
+
- INDENT
|
|
212
|
+
- PIPE
|
|
213
|
+
- DOT
|
|
214
|
+
- COLON
|
|
215
|
+
- COMMA
|
|
216
|
+
- BRACE_OPEN
|
|
217
|
+
- BRACE_CLOSE
|
|
218
|
+
- BRACKET_OPEN
|
|
219
|
+
- BRACKET_CLOSE
|
|
220
|
+
- PARENTHESIS_OPEN
|
|
221
|
+
- PARENTHESIS_CLOSE
|
|
222
|
+
- QUOTE
|
|
223
|
+
- SLASH
|
|
224
|
+
- BOOLEAN_TRUE
|
|
225
|
+
- BOOLEAN_FALSE
|
|
226
|
+
- NULL
|
|
227
|
+
- COMMAND_NAME
|
|
228
|
+
- PARAMETER_KEY
|
|
229
|
+
- PARAMETER_VALUE_SCOPE
|
|
230
|
+
- FUNCTION_NAME
|
|
231
|
+
- OPERATOR
|
|
232
|
+
- TRAVERSAL_OPERATOR
|
|
233
|
+
- TRAVERSAL_RELATION_NAME
|
|
234
|
+
- TRAVERSAL_HOP_COUNT
|
|
235
|
+
- SIMPLE_IDENTIFIER
|
|
236
|
+
- NUMBER
|
|
237
|
+
- STRING
|
|
238
|
+
- TIME_UNIT
|
|
239
|
+
- TIMESTAMP_VALUE
|
|
240
|
+
- METRIC_KEY
|
|
241
|
+
- VARIABLE
|
|
232
242
|
|
|
233
243
|
#### ContainerNode
|
|
234
244
|
|
|
235
245
|
can be identified by checking whether `children` is present
|
|
236
246
|
|
|
237
|
-
Field
|
|
238
|
-
|
|
239
|
-
type
|
|
240
|
-
children
|
|
247
|
+
| Field | Mandatory | Description |
|
|
248
|
+
| -------- | --------- | ------------------------------------------------------------------------------- |
|
|
249
|
+
| type | yes | the type of the container node - do not confuse with the type of terminal nodes |
|
|
250
|
+
| children | yes | the children for the node. might be of any type |
|
|
241
251
|
|
|
242
252
|
##### Current types of container nodes (list might grow):
|
|
243
253
|
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
254
|
+
- QUERY
|
|
255
|
+
- EXECUTION_BLOCK
|
|
256
|
+
- COMMAND
|
|
257
|
+
- COMMAND_SEPARATOR
|
|
258
|
+
- PARAMETER_WITH_KEY
|
|
259
|
+
- GROUP
|
|
260
|
+
- PARAMETERS - check examples further down
|
|
261
|
+
- PARAMETER_NAMING
|
|
262
|
+
- PARAMETER_SEPARATOR
|
|
263
|
+
- FUNCTION
|
|
264
|
+
- FUNCTION_PART - check examples further down
|
|
265
|
+
- EXPRESSION
|
|
266
|
+
- IDENTIFIER
|
|
267
|
+
- SOURCE_ID
|
|
268
|
+
- DURATION
|
|
269
|
+
- TIMESTAMP
|
|
270
|
+
- TIMEFRAME
|
|
271
|
+
- TRAVERSAL_PATH
|
|
272
|
+
- TRAVERSAL_STEP
|
|
263
273
|
|
|
264
274
|
##### Special node type: PARAMETERS
|
|
265
275
|
|
|
@@ -290,10 +300,10 @@ are only optional if `isOptional && !isMandatoryOnUserOrder`.
|
|
|
290
300
|
|
|
291
301
|
A container node of type `FUNCTION` may contain nodes of type `FUNCTION_PART`.
|
|
292
302
|
|
|
293
|
-
If those `FUNCTION_PART`s are marked as optional, this means you have to either include
|
|
303
|
+
If those `FUNCTION_PART`s are marked as optional, this means you have to either include _all_ or _none_ of these
|
|
294
304
|
optional function parts.
|
|
295
305
|
|
|
296
|
-
|
|
306
|
+
_Example_:
|
|
297
307
|
|
|
298
308
|
`filter anyMatch(a.b == 1, input:a)`
|
|
299
309
|
|
|
@@ -305,56 +315,45 @@ to an invalid query.
|
|
|
305
315
|
|
|
306
316
|
can be identified by checking whether `alternatives` is present
|
|
307
317
|
|
|
308
|
-
Field
|
|
309
|
-
|
|
310
|
-
alternatives
|
|
318
|
+
| Field | Mandatory | Description |
|
|
319
|
+
| ------------ | --------- | ----------------------------------------- |
|
|
320
|
+
| alternatives | yes | Type: Map<AlternativeType, DQLNode> |
|
|
311
321
|
|
|
312
322
|
When displaying the query, pick one option. You may use the other options for hovering, replacing, and more.
|
|
313
323
|
|
|
314
324
|
##### Current values of AlternativeType (list might grow):
|
|
315
325
|
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
326
|
+
- CANONICAL: This node is the one we will use for our canonical form
|
|
327
|
+
- USER: An alternative that is also valid, but not canonical; and this version was picked by the user.
|
|
328
|
+
- INFO: only if the canonical version is not present
|
|
319
329
|
|
|
320
|
-
|
|
330
|
+
_Examples_:
|
|
321
331
|
|
|
322
|
-
|
|
332
|
+
- `CANONICAL` is not present, `USER` is present: user's nodes are optional, but not canonical (usually optional nodes
|
|
323
333
|
are still canonical)
|
|
324
|
-
|
|
334
|
+
- `CANONICAL` is present, `USER` is not present: same as if the canonical node was optional. If this happens, it is
|
|
325
335
|
likely that there is also an `INFO` node
|
|
326
|
-
|
|
327
|
-
|
|
336
|
+
- `CANONICAL` is present, `USER` is present: there are different alternatives
|
|
337
|
+
- `INFO` is present: usually if `CANONICAL` is not present (e.g. the parameter key for `FILTER a == 1`), there is an info node
|
|
328
338
|
for `FILTER condition:a == 1`. This `condition:` was neither written by the user nor is it canonical; but it might be
|
|
329
339
|
used to help the user understand what this parameter means.
|
|
330
340
|
|
|
331
|
-
|
|
332
341
|
**Parameters**
|
|
333
342
|
|
|
334
343
|
<div class="padding-left--md padding-bottom--md">
|
|
335
344
|
<strong>config</strong>: Object
|
|
336
345
|
<div class="padding-left--md">
|
|
337
346
|
|
|
338
|
-
|
|
339
|
-
|
|
340
347
|
</div>
|
|
341
348
|
|
|
342
|
-
|
|
343
|
-
|
|
344
349
|
</div>
|
|
345
|
-
|
|
346
350
|
<div class="padding-left--md padding-bottom--md">
|
|
347
351
|
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
348
352
|
<div class="padding-left--md">
|
|
349
353
|
|
|
350
|
-
|
|
351
|
-
|
|
352
354
|
</div>
|
|
353
355
|
|
|
354
|
-
|
|
355
|
-
|
|
356
356
|
</div>
|
|
357
|
-
|
|
358
357
|
<div class="padding-left--md padding-bottom--md">
|
|
359
358
|
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
360
359
|
<div class="padding-left--md">
|
|
@@ -363,24 +362,15 @@ The authorization context. Typically start with 'Bearer '.
|
|
|
363
362
|
|
|
364
363
|
</div>
|
|
365
364
|
|
|
366
|
-
|
|
367
|
-
|
|
368
365
|
</div>
|
|
369
|
-
|
|
370
366
|
<div class="padding-left--md padding-bottom--md">
|
|
371
367
|
<strong>config.body</strong>: <a href="#parserequest">ParseRequest</a>
|
|
372
368
|
<div class="padding-left--md">
|
|
373
369
|
|
|
374
|
-
|
|
375
|
-
|
|
376
370
|
</div>
|
|
377
371
|
|
|
378
|
-
|
|
379
|
-
|
|
380
372
|
</div>
|
|
381
373
|
|
|
382
|
-
|
|
383
|
-
|
|
384
374
|
#### Returns
|
|
385
375
|
|
|
386
376
|
<div class="padding-left--md">
|
|
@@ -388,16 +378,26 @@ A node containing more nodes, a node offering different (semantically equivalen
|
|
|
388
378
|
|
|
389
379
|
</div>
|
|
390
380
|
|
|
381
|
+
<details>
|
|
382
|
+
<summary>
|
|
383
|
+
Code example
|
|
391
384
|
|
|
385
|
+
</summary>
|
|
392
386
|
|
|
387
|
+
```ts
|
|
388
|
+
import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
|
|
393
389
|
|
|
390
|
+
const data = await queryAssistanceClient.queryParse({
|
|
391
|
+
authorization: "...",
|
|
392
|
+
body: {} as ParseRequest,
|
|
393
|
+
});
|
|
394
|
+
```
|
|
394
395
|
|
|
395
|
-
</
|
|
396
|
-
|
|
397
|
-
|
|
396
|
+
</details>
|
|
398
397
|
|
|
399
398
|
</div>
|
|
400
399
|
|
|
400
|
+
</div>
|
|
401
401
|
|
|
402
402
|
### queryVerify
|
|
403
403
|
|
|
@@ -408,38 +408,29 @@ A node containing more nodes, a node offering different (semantically equivalen
|
|
|
408
408
|
|
|
409
409
|
Verifies a query without executing it.
|
|
410
410
|
|
|
411
|
+
For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
|
|
412
|
+
|
|
411
413
|
## Overview
|
|
412
414
|
|
|
413
415
|
Verifies the supplied query string and other query parameters for lack of any errors, but without actually
|
|
414
416
|
submitting the query for execution.
|
|
415
417
|
|
|
416
|
-
|
|
417
418
|
**Parameters**
|
|
418
419
|
|
|
419
420
|
<div class="padding-left--md padding-bottom--md">
|
|
420
421
|
<strong>config</strong>: Object
|
|
421
422
|
<div class="padding-left--md">
|
|
422
423
|
|
|
423
|
-
|
|
424
|
-
|
|
425
424
|
</div>
|
|
426
425
|
|
|
427
|
-
|
|
428
|
-
|
|
429
426
|
</div>
|
|
430
|
-
|
|
431
427
|
<div class="padding-left--md padding-bottom--md">
|
|
432
428
|
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
433
429
|
<div class="padding-left--md">
|
|
434
430
|
|
|
435
|
-
|
|
436
|
-
|
|
437
431
|
</div>
|
|
438
432
|
|
|
439
|
-
|
|
440
|
-
|
|
441
433
|
</div>
|
|
442
|
-
|
|
443
434
|
<div class="padding-left--md padding-bottom--md">
|
|
444
435
|
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
445
436
|
<div class="padding-left--md">
|
|
@@ -448,24 +439,15 @@ The authorization context. Typically start with 'Bearer '.
|
|
|
448
439
|
|
|
449
440
|
</div>
|
|
450
441
|
|
|
451
|
-
|
|
452
|
-
|
|
453
442
|
</div>
|
|
454
|
-
|
|
455
443
|
<div class="padding-left--md padding-bottom--md">
|
|
456
444
|
<strong>config.body</strong>: <a href="#verifyrequest">VerifyRequest</a>
|
|
457
445
|
<div class="padding-left--md">
|
|
458
446
|
|
|
459
|
-
|
|
460
|
-
|
|
461
447
|
</div>
|
|
462
448
|
|
|
463
|
-
|
|
464
|
-
|
|
465
449
|
</div>
|
|
466
450
|
|
|
467
|
-
|
|
468
|
-
|
|
469
451
|
#### Returns
|
|
470
452
|
|
|
471
453
|
<div class="padding-left--md">
|
|
@@ -473,26 +455,33 @@ Supplied query and parameters were verified.
|
|
|
473
455
|
|
|
474
456
|
</div>
|
|
475
457
|
|
|
458
|
+
<details>
|
|
459
|
+
<summary>
|
|
460
|
+
Code example
|
|
476
461
|
|
|
462
|
+
</summary>
|
|
477
463
|
|
|
464
|
+
```ts
|
|
465
|
+
import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
|
|
478
466
|
|
|
467
|
+
const data = await queryAssistanceClient.queryVerify({
|
|
468
|
+
authorization: "...",
|
|
469
|
+
body: {} as VerifyRequest,
|
|
470
|
+
});
|
|
471
|
+
```
|
|
479
472
|
|
|
480
|
-
</
|
|
481
|
-
|
|
482
|
-
|
|
473
|
+
</details>
|
|
483
474
|
|
|
484
475
|
</div>
|
|
485
476
|
|
|
486
|
-
|
|
487
|
-
|
|
477
|
+
</div>
|
|
488
478
|
|
|
489
479
|
## queryExecutionClient
|
|
490
480
|
|
|
491
481
|
```js
|
|
492
|
-
import { queryExecutionClient } from
|
|
482
|
+
import { queryExecutionClient } from "@dynatrace-sdk/client-query";
|
|
493
483
|
```
|
|
494
484
|
|
|
495
|
-
|
|
496
485
|
### queryCancel
|
|
497
486
|
|
|
498
487
|
<div class="padding-bottom--md">
|
|
@@ -502,6 +491,8 @@ import { queryExecutionClient } from '@dynatrace-sdk/client-query';
|
|
|
502
491
|
|
|
503
492
|
Cancels the query and returns the result if the query was already finished, otherwise discards it.
|
|
504
493
|
|
|
494
|
+
For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
|
|
495
|
+
|
|
505
496
|
### Overview:
|
|
506
497
|
|
|
507
498
|
Cancels a running Grail query and returns a list of records if the query already finished.
|
|
@@ -511,9 +502,10 @@ Cancels a running Grail query and returns a list of records if the query already
|
|
|
511
502
|
If the query was already finished, a response body including the result will be returned. Otherwise the response will contain no body.
|
|
512
503
|
|
|
513
504
|
The result has three main sections:
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
505
|
+
|
|
506
|
+
- the 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
|
|
507
|
+
- the 'types' section describes the corresponding data types that a record field has.
|
|
508
|
+
- the 'metadata' section contains information about the query like 'analysisTimeframe', 'timezone' or 'locale'.
|
|
517
509
|
|
|
518
510
|
Every record has an implicit 'index' according to the position in the 'records' JSON array.
|
|
519
511
|
The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
|
|
@@ -527,7 +519,6 @@ startIndex <= i <= endIndex
|
|
|
527
519
|
|
|
528
520
|
Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
|
|
529
521
|
|
|
530
|
-
|
|
531
522
|
Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
|
|
532
523
|
field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
|
|
533
524
|
When a collision does occur, we will create a new type 'bucket' that will have a different index range where
|
|
@@ -535,33 +526,22 @@ the new record field types will be placed.
|
|
|
535
526
|
It is guaranteed that every field of every record will have a corresponding type.
|
|
536
527
|
**Clients should always take the included types into account when consuming records!**
|
|
537
528
|
|
|
538
|
-
|
|
539
529
|
**Parameters**
|
|
540
530
|
|
|
541
531
|
<div class="padding-left--md padding-bottom--md">
|
|
542
532
|
<strong>config</strong>: Object
|
|
543
533
|
<div class="padding-left--md">
|
|
544
534
|
|
|
545
|
-
|
|
546
|
-
|
|
547
535
|
</div>
|
|
548
536
|
|
|
549
|
-
|
|
550
|
-
|
|
551
537
|
</div>
|
|
552
|
-
|
|
553
538
|
<div class="padding-left--md padding-bottom--md">
|
|
554
539
|
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
555
540
|
<div class="padding-left--md">
|
|
556
541
|
|
|
557
|
-
|
|
558
|
-
|
|
559
542
|
</div>
|
|
560
543
|
|
|
561
|
-
|
|
562
|
-
|
|
563
544
|
</div>
|
|
564
|
-
|
|
565
545
|
<div class="padding-left--md padding-bottom--md">
|
|
566
546
|
<strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
567
547
|
<div class="padding-left--md">
|
|
@@ -570,12 +550,8 @@ The request-token of the query.
|
|
|
570
550
|
|
|
571
551
|
</div>
|
|
572
552
|
|
|
573
|
-
|
|
574
|
-
|
|
575
553
|
</div>
|
|
576
554
|
|
|
577
|
-
|
|
578
|
-
|
|
579
555
|
#### Returns
|
|
580
556
|
|
|
581
557
|
<div class="padding-left--md">
|
|
@@ -583,16 +559,25 @@ The query already finished.
|
|
|
583
559
|
|
|
584
560
|
</div>
|
|
585
561
|
|
|
562
|
+
<details>
|
|
563
|
+
<summary>
|
|
564
|
+
Code example
|
|
586
565
|
|
|
566
|
+
</summary>
|
|
587
567
|
|
|
568
|
+
```ts
|
|
569
|
+
import { queryExecutionClient } from "@dynatrace-sdk/client-query";
|
|
588
570
|
|
|
571
|
+
const data = await queryExecutionClient.queryCancel({
|
|
572
|
+
requestToken: "...",
|
|
573
|
+
});
|
|
574
|
+
```
|
|
589
575
|
|
|
590
|
-
</
|
|
591
|
-
|
|
592
|
-
|
|
576
|
+
</details>
|
|
593
577
|
|
|
594
578
|
</div>
|
|
595
579
|
|
|
580
|
+
</div>
|
|
596
581
|
|
|
597
582
|
### queryExecute
|
|
598
583
|
|
|
@@ -603,6 +588,8 @@ The query already finished.
|
|
|
603
588
|
|
|
604
589
|
Starts a Grail query.
|
|
605
590
|
|
|
591
|
+
For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
|
|
592
|
+
|
|
606
593
|
### Overview:
|
|
607
594
|
|
|
608
595
|
Executes a query and returns a list of records.
|
|
@@ -614,8 +601,9 @@ For details about the query language see the [Dynatrace Query Language documenta
|
|
|
614
601
|
The json response will contain the state of the started query. If the query succeeded, the result will be included. Otherwise the response will contain a request token to reference the query in future polling requests.
|
|
615
602
|
|
|
616
603
|
The result has two main sections:
|
|
617
|
-
|
|
618
|
-
|
|
604
|
+
|
|
605
|
+
- The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
|
|
606
|
+
- The 'types' section describes the corresponding data types that a record field has.
|
|
619
607
|
|
|
620
608
|
Every record has an implicit 'index' according to the position in the 'records' JSON array.
|
|
621
609
|
The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
|
|
@@ -629,7 +617,6 @@ startIndex <= i <= endIndex
|
|
|
629
617
|
|
|
630
618
|
Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
|
|
631
619
|
|
|
632
|
-
|
|
633
620
|
Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
|
|
634
621
|
field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
|
|
635
622
|
When a collision does occur, we will create a new type 'bucket' that will have a different index range where
|
|
@@ -637,33 +624,22 @@ the new record field types will be placed.
|
|
|
637
624
|
It is guaranteed that every field of every record will have a corresponding type.
|
|
638
625
|
**Clients should always take the included types into account when consuming records!**
|
|
639
626
|
|
|
640
|
-
|
|
641
627
|
**Parameters**
|
|
642
628
|
|
|
643
629
|
<div class="padding-left--md padding-bottom--md">
|
|
644
630
|
<strong>config</strong>: Object
|
|
645
631
|
<div class="padding-left--md">
|
|
646
632
|
|
|
647
|
-
|
|
648
|
-
|
|
649
633
|
</div>
|
|
650
634
|
|
|
651
|
-
|
|
652
|
-
|
|
653
635
|
</div>
|
|
654
|
-
|
|
655
636
|
<div class="padding-left--md padding-bottom--md">
|
|
656
637
|
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
657
638
|
<div class="padding-left--md">
|
|
658
639
|
|
|
659
|
-
|
|
660
|
-
|
|
661
640
|
</div>
|
|
662
641
|
|
|
663
|
-
|
|
664
|
-
|
|
665
642
|
</div>
|
|
666
|
-
|
|
667
643
|
<div class="padding-left--md padding-bottom--md">
|
|
668
644
|
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
669
645
|
<div class="padding-left--md">
|
|
@@ -672,22 +648,14 @@ The authorization context. Typically start with 'Bearer '.
|
|
|
672
648
|
|
|
673
649
|
</div>
|
|
674
650
|
|
|
675
|
-
|
|
676
|
-
|
|
677
651
|
</div>
|
|
678
|
-
|
|
679
652
|
<div class="padding-left--md padding-bottom--md">
|
|
680
653
|
<strong>config.body</strong>: <a href="#executerequest">ExecuteRequest</a>
|
|
681
654
|
<div class="padding-left--md">
|
|
682
655
|
|
|
683
|
-
|
|
684
|
-
|
|
685
656
|
</div>
|
|
686
657
|
|
|
687
|
-
|
|
688
|
-
|
|
689
658
|
</div>
|
|
690
|
-
|
|
691
659
|
<div class="padding-left--md padding-bottom--md">
|
|
692
660
|
<strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
693
661
|
<div class="padding-left--md">
|
|
@@ -696,12 +664,8 @@ If set additional data will be available in the metadata section.
|
|
|
696
664
|
|
|
697
665
|
</div>
|
|
698
666
|
|
|
699
|
-
|
|
700
|
-
|
|
701
667
|
</div>
|
|
702
668
|
|
|
703
|
-
|
|
704
|
-
|
|
705
669
|
#### Returns
|
|
706
670
|
|
|
707
671
|
<div class="padding-left--md">
|
|
@@ -709,16 +673,27 @@ The final status and results of the supplied query if it finished within a suppl
|
|
|
709
673
|
|
|
710
674
|
</div>
|
|
711
675
|
|
|
676
|
+
<details>
|
|
677
|
+
<summary>
|
|
678
|
+
Code example
|
|
712
679
|
|
|
680
|
+
</summary>
|
|
713
681
|
|
|
682
|
+
```ts
|
|
683
|
+
import { queryExecutionClient } from "@dynatrace-sdk/client-query";
|
|
714
684
|
|
|
685
|
+
const data = await queryExecutionClient.queryExecute({
|
|
686
|
+
enrich: "metric-metadata",
|
|
687
|
+
authorization: "...",
|
|
688
|
+
body: {} as ExecuteRequest,
|
|
689
|
+
});
|
|
690
|
+
```
|
|
715
691
|
|
|
716
|
-
</
|
|
717
|
-
|
|
718
|
-
|
|
692
|
+
</details>
|
|
719
693
|
|
|
720
694
|
</div>
|
|
721
695
|
|
|
696
|
+
</div>
|
|
722
697
|
|
|
723
698
|
### queryPoll
|
|
724
699
|
|
|
@@ -729,16 +704,20 @@ The final status and results of the supplied query if it finished within a suppl
|
|
|
729
704
|
|
|
730
705
|
Retrieves query status and final result from Grail.
|
|
731
706
|
|
|
707
|
+
For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
|
|
708
|
+
|
|
732
709
|
### Overview:
|
|
733
710
|
|
|
734
711
|
Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
|
|
735
712
|
|
|
736
713
|
### The response format:
|
|
714
|
+
|
|
737
715
|
The json response will contain the state of the query. If the query succeeded, the result will be included.
|
|
738
716
|
|
|
739
717
|
The result has two main sections:
|
|
740
|
-
|
|
741
|
-
|
|
718
|
+
|
|
719
|
+
- The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
|
|
720
|
+
- The 'types' section describes the corresponding data types that a record field has.
|
|
742
721
|
|
|
743
722
|
Every record has an implicit 'index' according to the position in the 'records' JSON array.
|
|
744
723
|
The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
|
|
@@ -752,7 +731,6 @@ startIndex <= i <= endIndex
|
|
|
752
731
|
|
|
753
732
|
Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
|
|
754
733
|
|
|
755
|
-
|
|
756
734
|
Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
|
|
757
735
|
field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
|
|
758
736
|
When a collision does occur, we will create a new type 'bucket' that will have a different index range where
|
|
@@ -760,33 +738,22 @@ the new record field types will be placed.
|
|
|
760
738
|
It is guaranteed that every field of every record will have a corresponding type.
|
|
761
739
|
**Clients should always take the included types into account when consuming records!**
|
|
762
740
|
|
|
763
|
-
|
|
764
741
|
**Parameters**
|
|
765
742
|
|
|
766
743
|
<div class="padding-left--md padding-bottom--md">
|
|
767
744
|
<strong>config</strong>: Object
|
|
768
745
|
<div class="padding-left--md">
|
|
769
746
|
|
|
770
|
-
|
|
771
|
-
|
|
772
747
|
</div>
|
|
773
748
|
|
|
774
|
-
|
|
775
|
-
|
|
776
749
|
</div>
|
|
777
|
-
|
|
778
750
|
<div class="padding-left--md padding-bottom--md">
|
|
779
751
|
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
780
752
|
<div class="padding-left--md">
|
|
781
753
|
|
|
782
|
-
|
|
783
|
-
|
|
784
754
|
</div>
|
|
785
755
|
|
|
786
|
-
|
|
787
|
-
|
|
788
756
|
</div>
|
|
789
|
-
|
|
790
757
|
<div class="padding-left--md padding-bottom--md">
|
|
791
758
|
<strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
792
759
|
<div class="padding-left--md">
|
|
@@ -795,10 +762,7 @@ If set additional data will be available in the metadata section.
|
|
|
795
762
|
|
|
796
763
|
</div>
|
|
797
764
|
|
|
798
|
-
|
|
799
|
-
|
|
800
765
|
</div>
|
|
801
|
-
|
|
802
766
|
<div class="padding-left--md padding-bottom--md">
|
|
803
767
|
<strong>config.requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
804
768
|
<div class="padding-left--md">
|
|
@@ -807,10 +771,7 @@ The time a client is willing to wait for the query result. In case the query fin
|
|
|
807
771
|
|
|
808
772
|
</div>
|
|
809
773
|
|
|
810
|
-
|
|
811
|
-
|
|
812
774
|
</div>
|
|
813
|
-
|
|
814
775
|
<div class="padding-left--md padding-bottom--md">
|
|
815
776
|
<strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
816
777
|
<div class="padding-left--md">
|
|
@@ -819,12 +780,8 @@ The request-token of the query.
|
|
|
819
780
|
|
|
820
781
|
</div>
|
|
821
782
|
|
|
822
|
-
|
|
823
|
-
|
|
824
783
|
</div>
|
|
825
784
|
|
|
826
|
-
|
|
827
|
-
|
|
828
785
|
#### Returns
|
|
829
786
|
|
|
830
787
|
<div class="padding-left--md">
|
|
@@ -832,40 +789,41 @@ The current status and results of the supplied query.
|
|
|
832
789
|
|
|
833
790
|
</div>
|
|
834
791
|
|
|
792
|
+
<details>
|
|
793
|
+
<summary>
|
|
794
|
+
Code example
|
|
835
795
|
|
|
796
|
+
</summary>
|
|
836
797
|
|
|
798
|
+
```ts
|
|
799
|
+
import { queryExecutionClient } from "@dynatrace-sdk/client-query";
|
|
837
800
|
|
|
801
|
+
const data = await queryExecutionClient.queryPoll({
|
|
802
|
+
requestToken: "...",
|
|
803
|
+
requestTimeoutMilliseconds: 60,
|
|
804
|
+
enrich: "metric-metadata",
|
|
805
|
+
});
|
|
806
|
+
```
|
|
838
807
|
|
|
839
|
-
</
|
|
840
|
-
|
|
841
|
-
|
|
808
|
+
</details>
|
|
842
809
|
|
|
843
810
|
</div>
|
|
844
811
|
|
|
845
|
-
|
|
846
|
-
|
|
812
|
+
</div>
|
|
847
813
|
|
|
848
814
|
## Types
|
|
849
815
|
|
|
850
816
|
### AutocompleteRequest
|
|
851
|
-
<div class="padding-left--md">
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
817
|
|
|
818
|
+
<div class="padding-left--md">
|
|
856
819
|
|
|
857
820
|
<div class="padding-left--md padding-bottom--md">
|
|
858
821
|
<strong>cursorPosition</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
859
822
|
<div class="padding-left--md">
|
|
860
823
|
|
|
861
|
-
|
|
862
|
-
|
|
863
824
|
</div>
|
|
864
825
|
|
|
865
|
-
|
|
866
|
-
|
|
867
826
|
</div>
|
|
868
|
-
|
|
869
827
|
<div class="padding-left--md padding-bottom--md">
|
|
870
828
|
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
871
829
|
<div class="padding-left--md">
|
|
@@ -874,10 +832,7 @@ The query locale. If none specified, then a language/country neutral locale is c
|
|
|
874
832
|
|
|
875
833
|
</div>
|
|
876
834
|
|
|
877
|
-
|
|
878
|
-
|
|
879
835
|
</div>
|
|
880
|
-
|
|
881
836
|
<div class="padding-left--md padding-bottom--md">
|
|
882
837
|
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
883
838
|
<div class="padding-left--md">
|
|
@@ -886,10 +841,7 @@ The full query string.
|
|
|
886
841
|
|
|
887
842
|
</div>
|
|
888
843
|
|
|
889
|
-
|
|
890
|
-
|
|
891
844
|
</div>
|
|
892
|
-
|
|
893
845
|
<div class="padding-left--md padding-bottom--md">
|
|
894
846
|
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
895
847
|
<div class="padding-left--md">
|
|
@@ -898,19 +850,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
|
|
|
898
850
|
|
|
899
851
|
</div>
|
|
900
852
|
|
|
901
|
-
|
|
902
|
-
|
|
903
853
|
</div>
|
|
904
854
|
|
|
905
|
-
|
|
906
855
|
</div>
|
|
907
856
|
|
|
908
|
-
|
|
909
|
-
|
|
910
857
|
### AutocompleteResponse
|
|
911
|
-
<div class="padding-left--md">
|
|
912
|
-
|
|
913
858
|
|
|
859
|
+
<div class="padding-left--md">
|
|
914
860
|
|
|
915
861
|
The response of the autocomplete call.
|
|
916
862
|
|
|
@@ -922,10 +868,7 @@ True if the suggestions are optional.
|
|
|
922
868
|
|
|
923
869
|
</div>
|
|
924
870
|
|
|
925
|
-
|
|
926
|
-
|
|
927
871
|
</div>
|
|
928
|
-
|
|
929
872
|
<div class="padding-left--md padding-bottom--md">
|
|
930
873
|
<strong>suggestedTtlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
931
874
|
<div class="padding-left--md">
|
|
@@ -934,10 +877,7 @@ Suggested duration in seconds, for how long the response may be cached and reuse
|
|
|
934
877
|
|
|
935
878
|
</div>
|
|
936
879
|
|
|
937
|
-
|
|
938
|
-
|
|
939
880
|
</div>
|
|
940
|
-
|
|
941
881
|
<div class="padding-left--md padding-bottom--md">
|
|
942
882
|
<strong>suggestions</strong>: Array<<a href="#autocompletesuggestion">AutocompleteSuggestion</a>>
|
|
943
883
|
<div class="padding-left--md">
|
|
@@ -946,19 +886,13 @@ The list of suggestions.
|
|
|
946
886
|
|
|
947
887
|
</div>
|
|
948
888
|
|
|
949
|
-
|
|
950
|
-
|
|
951
889
|
</div>
|
|
952
890
|
|
|
953
|
-
|
|
954
891
|
</div>
|
|
955
892
|
|
|
956
|
-
|
|
957
|
-
|
|
958
893
|
### AutocompleteSuggestion
|
|
959
|
-
<div class="padding-left--md">
|
|
960
|
-
|
|
961
894
|
|
|
895
|
+
<div class="padding-left--md">
|
|
962
896
|
|
|
963
897
|
Single suggestion for completion of the query.
|
|
964
898
|
|
|
@@ -970,10 +904,7 @@ Number of characters that the user user already typed for this suggestion.
|
|
|
970
904
|
|
|
971
905
|
</div>
|
|
972
906
|
|
|
973
|
-
|
|
974
|
-
|
|
975
907
|
</div>
|
|
976
|
-
|
|
977
908
|
<div class="padding-left--md padding-bottom--md">
|
|
978
909
|
<strong>parts</strong>: Array<<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>>
|
|
979
910
|
<div class="padding-left--md">
|
|
@@ -982,10 +913,7 @@ List of suggestion parts.
|
|
|
982
913
|
|
|
983
914
|
</div>
|
|
984
915
|
|
|
985
|
-
|
|
986
|
-
|
|
987
916
|
</div>
|
|
988
|
-
|
|
989
917
|
<div class="padding-left--md padding-bottom--md">
|
|
990
918
|
<strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
991
919
|
<div class="padding-left--md">
|
|
@@ -994,19 +922,13 @@ The suggested continuation of the query.
|
|
|
994
922
|
|
|
995
923
|
</div>
|
|
996
924
|
|
|
997
|
-
|
|
998
|
-
|
|
999
925
|
</div>
|
|
1000
926
|
|
|
1001
|
-
|
|
1002
927
|
</div>
|
|
1003
928
|
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
929
|
### AutocompleteSuggestionPart
|
|
1007
|
-
<div class="padding-left--md">
|
|
1008
|
-
|
|
1009
930
|
|
|
931
|
+
<div class="padding-left--md">
|
|
1010
932
|
|
|
1011
933
|
Part of the suggestion.
|
|
1012
934
|
|
|
@@ -1018,10 +940,7 @@ The type of the suggestion.
|
|
|
1018
940
|
|
|
1019
941
|
</div>
|
|
1020
942
|
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
943
|
</div>
|
|
1024
|
-
|
|
1025
944
|
<div class="padding-left--md padding-bottom--md">
|
|
1026
945
|
<strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1027
946
|
<div class="padding-left--md">
|
|
@@ -1030,10 +949,7 @@ The suggested continuation of the query.
|
|
|
1030
949
|
|
|
1031
950
|
</div>
|
|
1032
951
|
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
952
|
</div>
|
|
1036
|
-
|
|
1037
953
|
<div class="padding-left--md padding-bottom--md">
|
|
1038
954
|
<strong>synopsis</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1039
955
|
<div class="padding-left--md">
|
|
@@ -1042,31 +958,20 @@ The synopsis of the suggestion.
|
|
|
1042
958
|
|
|
1043
959
|
</div>
|
|
1044
960
|
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
961
|
</div>
|
|
1048
|
-
|
|
1049
962
|
<div class="padding-left--md padding-bottom--md">
|
|
1050
963
|
<strong>type</strong>: <a href="#tokentype">TokenType</a>
|
|
1051
964
|
<div class="padding-left--md">
|
|
1052
965
|
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
966
|
</div>
|
|
1056
967
|
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
968
|
</div>
|
|
1060
969
|
|
|
1061
|
-
|
|
1062
970
|
</div>
|
|
1063
971
|
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
972
|
### DQLAlternativeNode
|
|
1067
|
-
<div class="padding-left--md">
|
|
1068
|
-
|
|
1069
973
|
|
|
974
|
+
<div class="padding-left--md">
|
|
1070
975
|
|
|
1071
976
|
The DQL node that has alternatives.
|
|
1072
977
|
|
|
@@ -1078,10 +983,7 @@ The different alternatives.
|
|
|
1078
983
|
|
|
1079
984
|
</div>
|
|
1080
985
|
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
986
|
</div>
|
|
1084
|
-
|
|
1085
987
|
<div class="padding-left--md padding-bottom--md">
|
|
1086
988
|
<strong>isOptional</strong>: boolean
|
|
1087
989
|
<div class="padding-left--md">
|
|
@@ -1090,43 +992,27 @@ True if the node is optional.
|
|
|
1090
992
|
|
|
1091
993
|
</div>
|
|
1092
994
|
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
995
|
</div>
|
|
1096
|
-
|
|
1097
996
|
<div class="padding-left--md padding-bottom--md">
|
|
1098
997
|
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
1099
998
|
<div class="padding-left--md">
|
|
1100
999
|
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
1000
|
</div>
|
|
1104
1001
|
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
1002
|
</div>
|
|
1108
|
-
|
|
1109
1003
|
<div class="padding-left--md padding-bottom--md">
|
|
1110
1004
|
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1111
1005
|
<div class="padding-left--md">
|
|
1112
1006
|
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
1007
|
</div>
|
|
1116
1008
|
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
1009
|
</div>
|
|
1120
1010
|
|
|
1121
|
-
|
|
1122
1011
|
</div>
|
|
1123
1012
|
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
1013
|
### DQLContainerNode
|
|
1127
|
-
<div class="padding-left--md">
|
|
1128
|
-
|
|
1129
1014
|
|
|
1015
|
+
<div class="padding-left--md">
|
|
1130
1016
|
|
|
1131
1017
|
The DQL node that contains other nodes.
|
|
1132
1018
|
|
|
@@ -1138,10 +1024,7 @@ The list of children nodes.
|
|
|
1138
1024
|
|
|
1139
1025
|
</div>
|
|
1140
1026
|
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
1027
|
</div>
|
|
1144
|
-
|
|
1145
1028
|
<div class="padding-left--md padding-bottom--md">
|
|
1146
1029
|
<strong>isOptional</strong>: boolean
|
|
1147
1030
|
<div class="padding-left--md">
|
|
@@ -1150,34 +1033,21 @@ True if the node is optional.
|
|
|
1150
1033
|
|
|
1151
1034
|
</div>
|
|
1152
1035
|
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
1036
|
</div>
|
|
1156
|
-
|
|
1157
1037
|
<div class="padding-left--md padding-bottom--md">
|
|
1158
1038
|
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
1159
1039
|
<div class="padding-left--md">
|
|
1160
1040
|
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
1041
|
</div>
|
|
1164
1042
|
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
1043
|
</div>
|
|
1168
|
-
|
|
1169
1044
|
<div class="padding-left--md padding-bottom--md">
|
|
1170
1045
|
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1171
1046
|
<div class="padding-left--md">
|
|
1172
1047
|
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
1048
|
</div>
|
|
1176
1049
|
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
1050
|
</div>
|
|
1180
|
-
|
|
1181
1051
|
<div class="padding-left--md padding-bottom--md">
|
|
1182
1052
|
<strong>type</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1183
1053
|
<div class="padding-left--md">
|
|
@@ -1186,19 +1056,13 @@ The type of the node.
|
|
|
1186
1056
|
|
|
1187
1057
|
</div>
|
|
1188
1058
|
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
1059
|
</div>
|
|
1192
1060
|
|
|
1193
|
-
|
|
1194
1061
|
</div>
|
|
1195
1062
|
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
1063
|
### DQLNode
|
|
1199
|
-
<div class="padding-left--md">
|
|
1200
|
-
|
|
1201
1064
|
|
|
1065
|
+
<div class="padding-left--md">
|
|
1202
1066
|
|
|
1203
1067
|
General Node in the DQL query.
|
|
1204
1068
|
|
|
@@ -1210,43 +1074,27 @@ True if the node is optional.
|
|
|
1210
1074
|
|
|
1211
1075
|
</div>
|
|
1212
1076
|
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
1077
|
</div>
|
|
1216
|
-
|
|
1217
1078
|
<div class="padding-left--md padding-bottom--md">
|
|
1218
1079
|
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
1219
1080
|
<div class="padding-left--md">
|
|
1220
1081
|
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
1082
|
</div>
|
|
1224
1083
|
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
1084
|
</div>
|
|
1228
|
-
|
|
1229
1085
|
<div class="padding-left--md padding-bottom--md">
|
|
1230
1086
|
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1231
1087
|
<div class="padding-left--md">
|
|
1232
1088
|
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
1089
|
</div>
|
|
1236
1090
|
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
1091
|
</div>
|
|
1240
1092
|
|
|
1241
|
-
|
|
1242
1093
|
</div>
|
|
1243
1094
|
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
1095
|
### DQLTerminalNode
|
|
1247
|
-
<div class="padding-left--md">
|
|
1248
|
-
|
|
1249
1096
|
|
|
1097
|
+
<div class="padding-left--md">
|
|
1250
1098
|
|
|
1251
1099
|
Node that represents single token.
|
|
1252
1100
|
|
|
@@ -1258,10 +1106,7 @@ Canonical form.
|
|
|
1258
1106
|
|
|
1259
1107
|
</div>
|
|
1260
1108
|
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
1109
|
</div>
|
|
1264
|
-
|
|
1265
1110
|
<div class="padding-left--md padding-bottom--md">
|
|
1266
1111
|
<strong>isMandatoryOnUserOrder</strong>: boolean
|
|
1267
1112
|
<div class="padding-left--md">
|
|
@@ -1270,10 +1115,7 @@ For optional items only: whether this node becomes mandatory when user order is
|
|
|
1270
1115
|
|
|
1271
1116
|
</div>
|
|
1272
1117
|
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
1118
|
</div>
|
|
1276
|
-
|
|
1277
1119
|
<div class="padding-left--md padding-bottom--md">
|
|
1278
1120
|
<strong>isOptional</strong>: boolean
|
|
1279
1121
|
<div class="padding-left--md">
|
|
@@ -1282,55 +1124,34 @@ True if the node is optional.
|
|
|
1282
1124
|
|
|
1283
1125
|
</div>
|
|
1284
1126
|
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
1127
|
</div>
|
|
1288
|
-
|
|
1289
1128
|
<div class="padding-left--md padding-bottom--md">
|
|
1290
1129
|
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
1291
1130
|
<div class="padding-left--md">
|
|
1292
1131
|
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
1132
|
</div>
|
|
1296
1133
|
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
1134
|
</div>
|
|
1300
|
-
|
|
1301
1135
|
<div class="padding-left--md padding-bottom--md">
|
|
1302
1136
|
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1303
1137
|
<div class="padding-left--md">
|
|
1304
1138
|
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
1139
|
</div>
|
|
1308
1140
|
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
1141
|
</div>
|
|
1312
|
-
|
|
1313
1142
|
<div class="padding-left--md padding-bottom--md">
|
|
1314
1143
|
<strong>type</strong>: <a href="#tokentype">TokenType</a>
|
|
1315
1144
|
<div class="padding-left--md">
|
|
1316
1145
|
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
1146
|
</div>
|
|
1320
1147
|
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
1148
|
</div>
|
|
1324
1149
|
|
|
1325
|
-
|
|
1326
1150
|
</div>
|
|
1327
1151
|
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
1152
|
### ErrorEnvelope
|
|
1331
|
-
<div class="padding-left--md">
|
|
1332
|
-
|
|
1333
1153
|
|
|
1154
|
+
<div class="padding-left--md">
|
|
1334
1155
|
|
|
1335
1156
|
An 'envelope' error object that has the mandatory error object.
|
|
1336
1157
|
|
|
@@ -1338,23 +1159,15 @@ An 'envelope' error object that has the mandatory error object.
|
|
|
1338
1159
|
<strong>error</strong>: <a href="#errorresponse">ErrorResponse</a>
|
|
1339
1160
|
<div class="padding-left--md">
|
|
1340
1161
|
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
1162
|
</div>
|
|
1344
1163
|
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
1164
|
</div>
|
|
1348
1165
|
|
|
1349
|
-
|
|
1350
1166
|
</div>
|
|
1351
1167
|
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
1168
|
### ErrorResponse
|
|
1355
|
-
<div class="padding-left--md">
|
|
1356
|
-
|
|
1357
1169
|
|
|
1170
|
+
<div class="padding-left--md">
|
|
1358
1171
|
|
|
1359
1172
|
The response for error state
|
|
1360
1173
|
|
|
@@ -1366,22 +1179,14 @@ Error code, which normally matches the HTTP error code.
|
|
|
1366
1179
|
|
|
1367
1180
|
</div>
|
|
1368
1181
|
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
1182
|
</div>
|
|
1372
|
-
|
|
1373
1183
|
<div class="padding-left--md padding-bottom--md">
|
|
1374
1184
|
<strong>details</strong>: <a href="#errorresponsedetails">ErrorResponseDetails</a>
|
|
1375
1185
|
<div class="padding-left--md">
|
|
1376
1186
|
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
1187
|
</div>
|
|
1380
1188
|
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
1189
|
</div>
|
|
1384
|
-
|
|
1385
1190
|
<div class="padding-left--md padding-bottom--md">
|
|
1386
1191
|
<strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1387
1192
|
<div class="padding-left--md">
|
|
@@ -1390,19 +1195,13 @@ A short, clear error message without details
|
|
|
1390
1195
|
|
|
1391
1196
|
</div>
|
|
1392
1197
|
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
1198
|
</div>
|
|
1396
1199
|
|
|
1397
|
-
|
|
1398
1200
|
</div>
|
|
1399
1201
|
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
1202
|
### ErrorResponseDetails
|
|
1403
|
-
<div class="padding-left--md">
|
|
1404
|
-
|
|
1405
1203
|
|
|
1204
|
+
<div class="padding-left--md">
|
|
1406
1205
|
|
|
1407
1206
|
Detailed information about the error.
|
|
1408
1207
|
|
|
@@ -1414,10 +1213,7 @@ The arguments for the message format.
|
|
|
1414
1213
|
|
|
1415
1214
|
</div>
|
|
1416
1215
|
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
1216
|
</div>
|
|
1420
|
-
|
|
1421
1217
|
<div class="padding-left--md padding-bottom--md">
|
|
1422
1218
|
<strong>errorMessage</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1423
1219
|
<div class="padding-left--md">
|
|
@@ -1426,10 +1222,7 @@ Complete error message.
|
|
|
1426
1222
|
|
|
1427
1223
|
</div>
|
|
1428
1224
|
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
1225
|
</div>
|
|
1432
|
-
|
|
1433
1226
|
<div class="padding-left--md padding-bottom--md">
|
|
1434
1227
|
<strong>errorMessageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1435
1228
|
<div class="padding-left--md">
|
|
@@ -1438,10 +1231,7 @@ The message format of the error message, string.format based.
|
|
|
1438
1231
|
|
|
1439
1232
|
</div>
|
|
1440
1233
|
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
1234
|
</div>
|
|
1444
|
-
|
|
1445
1235
|
<div class="padding-left--md padding-bottom--md">
|
|
1446
1236
|
<strong>errorMessageFormatSpecifierTypes</strong>: Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
1447
1237
|
<div class="padding-left--md">
|
|
@@ -1450,10 +1240,7 @@ The corresponding DQL format specifier types for each format specifier used in t
|
|
|
1450
1240
|
|
|
1451
1241
|
</div>
|
|
1452
1242
|
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
1243
|
</div>
|
|
1456
|
-
|
|
1457
1244
|
<div class="padding-left--md padding-bottom--md">
|
|
1458
1245
|
<strong>errorType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1459
1246
|
<div class="padding-left--md">
|
|
@@ -1462,10 +1249,7 @@ The error type, e.g. COMMAND_NAME_MISSING
|
|
|
1462
1249
|
|
|
1463
1250
|
</div>
|
|
1464
1251
|
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
1252
|
</div>
|
|
1468
|
-
|
|
1469
1253
|
<div class="padding-left--md padding-bottom--md">
|
|
1470
1254
|
<strong>exceptionType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1471
1255
|
<div class="padding-left--md">
|
|
@@ -1474,10 +1258,7 @@ The exception type.
|
|
|
1474
1258
|
|
|
1475
1259
|
</div>
|
|
1476
1260
|
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
1261
|
</div>
|
|
1480
|
-
|
|
1481
1262
|
<div class="padding-left--md padding-bottom--md">
|
|
1482
1263
|
<strong>queryString</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1483
1264
|
<div class="padding-left--md">
|
|
@@ -1486,33 +1267,20 @@ Submitted query string.
|
|
|
1486
1267
|
|
|
1487
1268
|
</div>
|
|
1488
1269
|
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
1270
|
</div>
|
|
1492
|
-
|
|
1493
1271
|
<div class="padding-left--md padding-bottom--md">
|
|
1494
1272
|
<strong>syntaxErrorPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1495
1273
|
<div class="padding-left--md">
|
|
1496
1274
|
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
1275
|
</div>
|
|
1500
1276
|
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
1277
|
</div>
|
|
1504
1278
|
|
|
1505
|
-
|
|
1506
1279
|
</div>
|
|
1507
1280
|
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
1281
|
### ExecuteRequest
|
|
1511
|
-
<div class="padding-left--md">
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
1282
|
|
|
1283
|
+
<div class="padding-left--md">
|
|
1516
1284
|
|
|
1517
1285
|
<div class="padding-left--md padding-bottom--md">
|
|
1518
1286
|
<strong>defaultSamplingRatio</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
@@ -1522,10 +1290,7 @@ In case not specified in the DQL string, the sampling ratio defined here is appl
|
|
|
1522
1290
|
|
|
1523
1291
|
</div>
|
|
1524
1292
|
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
1293
|
</div>
|
|
1528
|
-
|
|
1529
1294
|
<div class="padding-left--md padding-bottom--md">
|
|
1530
1295
|
<strong>defaultScanLimitGbytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1531
1296
|
<div class="padding-left--md">
|
|
@@ -1534,34 +1299,25 @@ Limit in gigabytes for the amount data that will be scanned during read.
|
|
|
1534
1299
|
|
|
1535
1300
|
</div>
|
|
1536
1301
|
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
1302
|
</div>
|
|
1540
|
-
|
|
1541
1303
|
<div class="padding-left--md padding-bottom--md">
|
|
1542
1304
|
<strong>defaultTimeframeEnd</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1543
1305
|
<div class="padding-left--md">
|
|
1544
1306
|
|
|
1545
|
-
The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored.
|
|
1307
|
+
The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. _Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter._
|
|
1546
1308
|
|
|
1547
1309
|
</div>
|
|
1548
1310
|
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
1311
|
</div>
|
|
1552
|
-
|
|
1553
1312
|
<div class="padding-left--md padding-bottom--md">
|
|
1554
1313
|
<strong>defaultTimeframeStart</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1555
1314
|
<div class="padding-left--md">
|
|
1556
1315
|
|
|
1557
|
-
The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored.
|
|
1316
|
+
The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. _Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter._
|
|
1558
1317
|
|
|
1559
1318
|
</div>
|
|
1560
1319
|
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
1320
|
</div>
|
|
1564
|
-
|
|
1565
1321
|
<div class="padding-left--md padding-bottom--md">
|
|
1566
1322
|
<strong>enablePreview</strong>: boolean
|
|
1567
1323
|
<div class="padding-left--md">
|
|
@@ -1570,10 +1326,7 @@ Request preview results. If a preview is available within the requestTimeoutMill
|
|
|
1570
1326
|
|
|
1571
1327
|
</div>
|
|
1572
1328
|
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
1329
|
</div>
|
|
1576
|
-
|
|
1577
1330
|
<div class="padding-left--md padding-bottom--md">
|
|
1578
1331
|
<strong>fetchTimeoutSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1579
1332
|
<div class="padding-left--md">
|
|
@@ -1582,10 +1335,7 @@ The query will stop after reaching the fetch-timeout.
|
|
|
1582
1335
|
|
|
1583
1336
|
</div>
|
|
1584
1337
|
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
1338
|
</div>
|
|
1588
|
-
|
|
1589
1339
|
<div class="padding-left--md padding-bottom--md">
|
|
1590
1340
|
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1591
1341
|
<div class="padding-left--md">
|
|
@@ -1594,10 +1344,7 @@ The query locale. If none specified, then a language/country neutral locale is c
|
|
|
1594
1344
|
|
|
1595
1345
|
</div>
|
|
1596
1346
|
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
1347
|
</div>
|
|
1600
|
-
|
|
1601
1348
|
<div class="padding-left--md padding-bottom--md">
|
|
1602
1349
|
<strong>maxResultRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1603
1350
|
<div class="padding-left--md">
|
|
@@ -1606,10 +1353,7 @@ The maximum number of result records that this query will return.
|
|
|
1606
1353
|
|
|
1607
1354
|
</div>
|
|
1608
1355
|
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
1356
|
</div>
|
|
1612
|
-
|
|
1613
1357
|
<div class="padding-left--md padding-bottom--md">
|
|
1614
1358
|
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1615
1359
|
<div class="padding-left--md">
|
|
@@ -1618,10 +1362,7 @@ The full query string.
|
|
|
1618
1362
|
|
|
1619
1363
|
</div>
|
|
1620
1364
|
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
1365
|
</div>
|
|
1624
|
-
|
|
1625
1366
|
<div class="padding-left--md padding-bottom--md">
|
|
1626
1367
|
<strong>requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1627
1368
|
<div class="padding-left--md">
|
|
@@ -1630,10 +1371,7 @@ The time a client is willing to wait for the query result. In case the query fin
|
|
|
1630
1371
|
|
|
1631
1372
|
</div>
|
|
1632
1373
|
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
1374
|
</div>
|
|
1636
|
-
|
|
1637
1375
|
<div class="padding-left--md padding-bottom--md">
|
|
1638
1376
|
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1639
1377
|
<div class="padding-left--md">
|
|
@@ -1642,19 +1380,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
|
|
|
1642
1380
|
|
|
1643
1381
|
</div>
|
|
1644
1382
|
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
1383
|
</div>
|
|
1648
1384
|
|
|
1649
|
-
|
|
1650
1385
|
</div>
|
|
1651
1386
|
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
1387
|
### FieldType
|
|
1655
|
-
<div class="padding-left--md">
|
|
1656
|
-
|
|
1657
1388
|
|
|
1389
|
+
<div class="padding-left--md">
|
|
1658
1390
|
|
|
1659
1391
|
The possible type of a field in DQL.
|
|
1660
1392
|
|
|
@@ -1662,35 +1394,22 @@ The possible type of a field in DQL.
|
|
|
1662
1394
|
<strong>type</strong>: <a href="#fieldtypetype">FieldTypeType</a>
|
|
1663
1395
|
<div class="padding-left--md">
|
|
1664
1396
|
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
1397
|
</div>
|
|
1668
1398
|
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
1399
|
</div>
|
|
1672
|
-
|
|
1673
1400
|
<div class="padding-left--md padding-bottom--md">
|
|
1674
1401
|
<strong>types</strong>: Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>>
|
|
1675
1402
|
<div class="padding-left--md">
|
|
1676
1403
|
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
1404
|
</div>
|
|
1680
1405
|
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
1406
|
</div>
|
|
1684
1407
|
|
|
1685
|
-
|
|
1686
1408
|
</div>
|
|
1687
1409
|
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
1410
|
### GeoPoint
|
|
1691
|
-
<div class="padding-left--md">
|
|
1692
|
-
|
|
1693
1411
|
|
|
1412
|
+
<div class="padding-left--md">
|
|
1694
1413
|
|
|
1695
1414
|
DQL data type representing a geolocation point.
|
|
1696
1415
|
|
|
@@ -1702,31 +1421,22 @@ The coordinate that specifies the north–south position of a point on the surfa
|
|
|
1702
1421
|
|
|
1703
1422
|
</div>
|
|
1704
1423
|
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
1424
|
</div>
|
|
1708
|
-
|
|
1709
1425
|
<div class="padding-left--md padding-bottom--md">
|
|
1710
1426
|
<strong>longitude</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1711
1427
|
<div class="padding-left--md">
|
|
1712
1428
|
|
|
1713
|
-
The coordinate that specifies the
|
|
1429
|
+
The coordinate that specifies the east–west position of a point on the surface of the earth.
|
|
1714
1430
|
|
|
1715
1431
|
</div>
|
|
1716
1432
|
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
1433
|
</div>
|
|
1720
1434
|
|
|
1721
|
-
|
|
1722
1435
|
</div>
|
|
1723
1436
|
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
1437
|
### GrailMetadata
|
|
1727
|
-
<div class="padding-left--md">
|
|
1728
|
-
|
|
1729
1438
|
|
|
1439
|
+
<div class="padding-left--md">
|
|
1730
1440
|
|
|
1731
1441
|
Collects various bits of metadata information.
|
|
1732
1442
|
|
|
@@ -1734,14 +1444,9 @@ Collects various bits of metadata information.
|
|
|
1734
1444
|
<strong>analysisTimeframe</strong>: <a href="#timeframe">Timeframe</a>
|
|
1735
1445
|
<div class="padding-left--md">
|
|
1736
1446
|
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
1447
|
</div>
|
|
1740
1448
|
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
1449
|
</div>
|
|
1744
|
-
|
|
1745
1450
|
<div class="padding-left--md padding-bottom--md">
|
|
1746
1451
|
<strong>canonicalQuery</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1747
1452
|
<div class="padding-left--md">
|
|
@@ -1750,10 +1455,7 @@ The canonical form of the query. It has normalized spaces and canonical construc
|
|
|
1750
1455
|
|
|
1751
1456
|
</div>
|
|
1752
1457
|
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
1458
|
</div>
|
|
1756
|
-
|
|
1757
1459
|
<div class="padding-left--md padding-bottom--md">
|
|
1758
1460
|
<strong>dqlVersion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1759
1461
|
<div class="padding-left--md">
|
|
@@ -1762,10 +1464,7 @@ The version of DQL that was used to process the query request.
|
|
|
1762
1464
|
|
|
1763
1465
|
</div>
|
|
1764
1466
|
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
1467
|
</div>
|
|
1768
|
-
|
|
1769
1468
|
<div class="padding-left--md padding-bottom--md">
|
|
1770
1469
|
<strong>executionTimeMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1771
1470
|
<div class="padding-left--md">
|
|
@@ -1774,10 +1473,7 @@ The time it took to execute the query.
|
|
|
1774
1473
|
|
|
1775
1474
|
</div>
|
|
1776
1475
|
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
1476
|
</div>
|
|
1780
|
-
|
|
1781
1477
|
<div class="padding-left--md padding-bottom--md">
|
|
1782
1478
|
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1783
1479
|
<div class="padding-left--md">
|
|
@@ -1786,10 +1482,7 @@ Effective locale for the query.
|
|
|
1786
1482
|
|
|
1787
1483
|
</div>
|
|
1788
1484
|
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
1485
|
</div>
|
|
1792
|
-
|
|
1793
1486
|
<div class="padding-left--md padding-bottom--md">
|
|
1794
1487
|
<strong>notifications</strong>: Array<<a href="#metadatanotification">MetadataNotification</a>>
|
|
1795
1488
|
<div class="padding-left--md">
|
|
@@ -1798,10 +1491,7 @@ Collected messages during the execution of the query.
|
|
|
1798
1491
|
|
|
1799
1492
|
</div>
|
|
1800
1493
|
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
1494
|
</div>
|
|
1804
|
-
|
|
1805
1495
|
<div class="padding-left--md padding-bottom--md">
|
|
1806
1496
|
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1807
1497
|
<div class="padding-left--md">
|
|
@@ -1810,10 +1500,7 @@ The submitted query.
|
|
|
1810
1500
|
|
|
1811
1501
|
</div>
|
|
1812
1502
|
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
1503
|
</div>
|
|
1816
|
-
|
|
1817
1504
|
<div class="padding-left--md padding-bottom--md">
|
|
1818
1505
|
<strong>queryId</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1819
1506
|
<div class="padding-left--md">
|
|
@@ -1822,10 +1509,16 @@ The id of the query
|
|
|
1822
1509
|
|
|
1823
1510
|
</div>
|
|
1824
1511
|
|
|
1512
|
+
</div>
|
|
1513
|
+
<div class="padding-left--md padding-bottom--md">
|
|
1514
|
+
<strong>sampled</strong>: boolean
|
|
1515
|
+
<div class="padding-left--md">
|
|
1825
1516
|
|
|
1517
|
+
True if sampling was used for at least one segment.
|
|
1826
1518
|
|
|
1827
1519
|
</div>
|
|
1828
1520
|
|
|
1521
|
+
</div>
|
|
1829
1522
|
<div class="padding-left--md padding-bottom--md">
|
|
1830
1523
|
<strong>scannedBytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1831
1524
|
<div class="padding-left--md">
|
|
@@ -1834,10 +1527,7 @@ Number of scanned bytes during the query execution.
|
|
|
1834
1527
|
|
|
1835
1528
|
</div>
|
|
1836
1529
|
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
1530
|
</div>
|
|
1840
|
-
|
|
1841
1531
|
<div class="padding-left--md padding-bottom--md">
|
|
1842
1532
|
<strong>scannedRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1843
1533
|
<div class="padding-left--md">
|
|
@@ -1846,10 +1536,7 @@ Number of scanned records during the query execution.
|
|
|
1846
1536
|
|
|
1847
1537
|
</div>
|
|
1848
1538
|
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
1539
|
</div>
|
|
1852
|
-
|
|
1853
1540
|
<div class="padding-left--md padding-bottom--md">
|
|
1854
1541
|
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1855
1542
|
<div class="padding-left--md">
|
|
@@ -1858,19 +1545,13 @@ Effective timezone for the query.
|
|
|
1858
1545
|
|
|
1859
1546
|
</div>
|
|
1860
1547
|
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
1548
|
</div>
|
|
1864
1549
|
|
|
1865
|
-
|
|
1866
1550
|
</div>
|
|
1867
1551
|
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
1552
|
### Metadata
|
|
1871
|
-
<div class="padding-left--md">
|
|
1872
|
-
|
|
1873
1553
|
|
|
1554
|
+
<div class="padding-left--md">
|
|
1874
1555
|
|
|
1875
1556
|
Collects various bits of metadata information.
|
|
1876
1557
|
|
|
@@ -1878,35 +1559,22 @@ Collects various bits of metadata information.
|
|
|
1878
1559
|
<strong>grail</strong>: <a href="#grailmetadata">GrailMetadata</a>
|
|
1879
1560
|
<div class="padding-left--md">
|
|
1880
1561
|
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
1562
|
</div>
|
|
1884
1563
|
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
1564
|
</div>
|
|
1888
|
-
|
|
1889
1565
|
<div class="padding-left--md padding-bottom--md">
|
|
1890
1566
|
<strong>metrics</strong>: Array<<a href="#metricmetadata">MetricMetadata</a>>
|
|
1891
1567
|
<div class="padding-left--md">
|
|
1892
1568
|
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
1569
|
</div>
|
|
1896
1570
|
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
1571
|
</div>
|
|
1900
1572
|
|
|
1901
|
-
|
|
1902
1573
|
</div>
|
|
1903
1574
|
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
1575
|
### MetadataNotification
|
|
1907
|
-
<div class="padding-left--md">
|
|
1908
|
-
|
|
1909
1576
|
|
|
1577
|
+
<div class="padding-left--md">
|
|
1910
1578
|
|
|
1911
1579
|
The message that provides additional information about the execution of the query.
|
|
1912
1580
|
|
|
@@ -1918,10 +1586,7 @@ The arguments for the message format.
|
|
|
1918
1586
|
|
|
1919
1587
|
</div>
|
|
1920
1588
|
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
1589
|
</div>
|
|
1924
|
-
|
|
1925
1590
|
<div class="padding-left--md padding-bottom--md">
|
|
1926
1591
|
<strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1927
1592
|
<div class="padding-left--md">
|
|
@@ -1930,10 +1595,7 @@ The complete message of the notification.
|
|
|
1930
1595
|
|
|
1931
1596
|
</div>
|
|
1932
1597
|
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
1598
|
</div>
|
|
1936
|
-
|
|
1937
1599
|
<div class="padding-left--md padding-bottom--md">
|
|
1938
1600
|
<strong>messageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1939
1601
|
<div class="padding-left--md">
|
|
@@ -1942,10 +1604,7 @@ The message format of the notification, string.format based
|
|
|
1942
1604
|
|
|
1943
1605
|
</div>
|
|
1944
1606
|
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
1607
|
</div>
|
|
1948
|
-
|
|
1949
1608
|
<div class="padding-left--md padding-bottom--md">
|
|
1950
1609
|
<strong>messageFormatSpecifierTypes</strong>: Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
1951
1610
|
<div class="padding-left--md">
|
|
@@ -1954,10 +1613,7 @@ The corresponding DQL format specifier types for each format specifier used in t
|
|
|
1954
1613
|
|
|
1955
1614
|
</div>
|
|
1956
1615
|
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
1616
|
</div>
|
|
1960
|
-
|
|
1961
1617
|
<div class="padding-left--md padding-bottom--md">
|
|
1962
1618
|
<strong>notificationType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1963
1619
|
<div class="padding-left--md">
|
|
@@ -1966,10 +1622,7 @@ The notification type, e.g. LIMIT_ADDED.
|
|
|
1966
1622
|
|
|
1967
1623
|
</div>
|
|
1968
1624
|
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
1625
|
</div>
|
|
1972
|
-
|
|
1973
1626
|
<div class="padding-left--md padding-bottom--md">
|
|
1974
1627
|
<strong>severity</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1975
1628
|
<div class="padding-left--md">
|
|
@@ -1978,31 +1631,20 @@ The severity of the notification, currently: INFO, WARN, ERROR.
|
|
|
1978
1631
|
|
|
1979
1632
|
</div>
|
|
1980
1633
|
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
1634
|
</div>
|
|
1984
|
-
|
|
1985
1635
|
<div class="padding-left--md padding-bottom--md">
|
|
1986
1636
|
<strong>syntaxPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1987
1637
|
<div class="padding-left--md">
|
|
1988
1638
|
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
1639
|
</div>
|
|
1992
1640
|
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
1641
|
</div>
|
|
1996
1642
|
|
|
1997
|
-
|
|
1998
1643
|
</div>
|
|
1999
1644
|
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
1645
|
### MetricMetadata
|
|
2003
|
-
<div class="padding-left--md">
|
|
2004
|
-
|
|
2005
1646
|
|
|
1647
|
+
<div class="padding-left--md">
|
|
2006
1648
|
|
|
2007
1649
|
An object that defines additional metric metadata.
|
|
2008
1650
|
|
|
@@ -2014,10 +1656,7 @@ The description of the metadata.
|
|
|
2014
1656
|
|
|
2015
1657
|
</div>
|
|
2016
1658
|
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
1659
|
</div>
|
|
2020
|
-
|
|
2021
1660
|
<div class="padding-left--md padding-bottom--md">
|
|
2022
1661
|
<strong>displayName</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2023
1662
|
<div class="padding-left--md">
|
|
@@ -2026,10 +1665,7 @@ The display name of the metadata.
|
|
|
2026
1665
|
|
|
2027
1666
|
</div>
|
|
2028
1667
|
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
1668
|
</div>
|
|
2032
|
-
|
|
2033
1669
|
<div class="padding-left--md padding-bottom--md">
|
|
2034
1670
|
<strong>metric.key</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2035
1671
|
<div class="padding-left--md">
|
|
@@ -2038,10 +1674,7 @@ The metric key.
|
|
|
2038
1674
|
|
|
2039
1675
|
</div>
|
|
2040
1676
|
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
1677
|
</div>
|
|
2044
|
-
|
|
2045
1678
|
<div class="padding-left--md padding-bottom--md">
|
|
2046
1679
|
<strong>unit</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2047
1680
|
<div class="padding-left--md">
|
|
@@ -2050,21 +1683,13 @@ The unit used.
|
|
|
2050
1683
|
|
|
2051
1684
|
</div>
|
|
2052
1685
|
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
1686
|
</div>
|
|
2056
1687
|
|
|
2057
|
-
|
|
2058
1688
|
</div>
|
|
2059
1689
|
|
|
2060
|
-
|
|
2061
|
-
|
|
2062
1690
|
### ParseRequest
|
|
2063
|
-
<div class="padding-left--md">
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
1691
|
|
|
1692
|
+
<div class="padding-left--md">
|
|
2068
1693
|
|
|
2069
1694
|
<div class="padding-left--md padding-bottom--md">
|
|
2070
1695
|
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
@@ -2074,10 +1699,7 @@ The query locale. If none specified, then a language/country neutral locale is c
|
|
|
2074
1699
|
|
|
2075
1700
|
</div>
|
|
2076
1701
|
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
1702
|
</div>
|
|
2080
|
-
|
|
2081
1703
|
<div class="padding-left--md padding-bottom--md">
|
|
2082
1704
|
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2083
1705
|
<div class="padding-left--md">
|
|
@@ -2086,10 +1708,7 @@ The full query string.
|
|
|
2086
1708
|
|
|
2087
1709
|
</div>
|
|
2088
1710
|
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
1711
|
</div>
|
|
2092
|
-
|
|
2093
1712
|
<div class="padding-left--md padding-bottom--md">
|
|
2094
1713
|
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2095
1714
|
<div class="padding-left--md">
|
|
@@ -2098,19 +1717,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
|
|
|
2098
1717
|
|
|
2099
1718
|
</div>
|
|
2100
1719
|
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
1720
|
</div>
|
|
2104
1721
|
|
|
2105
|
-
|
|
2106
1722
|
</div>
|
|
2107
1723
|
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
1724
|
### PositionInfo
|
|
2111
|
-
<div class="padding-left--md">
|
|
2112
|
-
|
|
2113
1725
|
|
|
1726
|
+
<div class="padding-left--md">
|
|
2114
1727
|
|
|
2115
1728
|
The exact position in the query string.
|
|
2116
1729
|
|
|
@@ -2122,10 +1735,7 @@ Query position column zero based index.
|
|
|
2122
1735
|
|
|
2123
1736
|
</div>
|
|
2124
1737
|
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
1738
|
</div>
|
|
2128
|
-
|
|
2129
1739
|
<div class="padding-left--md padding-bottom--md">
|
|
2130
1740
|
<strong>index</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
2131
1741
|
<div class="padding-left--md">
|
|
@@ -2134,10 +1744,7 @@ Query position index.
|
|
|
2134
1744
|
|
|
2135
1745
|
</div>
|
|
2136
1746
|
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
1747
|
</div>
|
|
2140
|
-
|
|
2141
1748
|
<div class="padding-left--md padding-bottom--md">
|
|
2142
1749
|
<strong>line</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
2143
1750
|
<div class="padding-left--md">
|
|
@@ -2146,19 +1753,13 @@ Query position line zero based index.
|
|
|
2146
1753
|
|
|
2147
1754
|
</div>
|
|
2148
1755
|
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
1756
|
</div>
|
|
2152
1757
|
|
|
2153
|
-
|
|
2154
1758
|
</div>
|
|
2155
1759
|
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
1760
|
### QueryPollResponse
|
|
2159
|
-
<div class="padding-left--md">
|
|
2160
|
-
|
|
2161
1761
|
|
|
1762
|
+
<div class="padding-left--md">
|
|
2162
1763
|
|
|
2163
1764
|
The response of GET query:execute call.
|
|
2164
1765
|
|
|
@@ -2170,34 +1771,21 @@ The progress of the query from 0 to 100.
|
|
|
2170
1771
|
|
|
2171
1772
|
</div>
|
|
2172
1773
|
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
1774
|
</div>
|
|
2176
|
-
|
|
2177
1775
|
<div class="padding-left--md padding-bottom--md">
|
|
2178
1776
|
<strong>result</strong>: <a href="#queryresult">QueryResult</a>
|
|
2179
1777
|
<div class="padding-left--md">
|
|
2180
1778
|
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
1779
|
</div>
|
|
2184
1780
|
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
1781
|
</div>
|
|
2188
|
-
|
|
2189
1782
|
<div class="padding-left--md padding-bottom--md">
|
|
2190
1783
|
<strong>state</strong>: <a href="#querystate">QueryState</a>
|
|
2191
1784
|
<div class="padding-left--md">
|
|
2192
1785
|
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
1786
|
</div>
|
|
2196
1787
|
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
1788
|
</div>
|
|
2200
|
-
|
|
2201
1789
|
<div class="padding-left--md padding-bottom--md">
|
|
2202
1790
|
<strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
2203
1791
|
<div class="padding-left--md">
|
|
@@ -2206,19 +1794,13 @@ Time to live in seconds.
|
|
|
2206
1794
|
|
|
2207
1795
|
</div>
|
|
2208
1796
|
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
1797
|
</div>
|
|
2212
1798
|
|
|
2213
|
-
|
|
2214
1799
|
</div>
|
|
2215
1800
|
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
1801
|
### QueryResult
|
|
2219
|
-
<div class="padding-left--md">
|
|
2220
|
-
|
|
2221
1802
|
|
|
1803
|
+
<div class="padding-left--md">
|
|
2222
1804
|
|
|
2223
1805
|
The result of the DQL query.
|
|
2224
1806
|
|
|
@@ -2226,14 +1808,9 @@ The result of the DQL query.
|
|
|
2226
1808
|
<strong>metadata</strong>: <a href="#metadata">Metadata</a>
|
|
2227
1809
|
<div class="padding-left--md">
|
|
2228
1810
|
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
1811
|
</div>
|
|
2232
1812
|
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
1813
|
</div>
|
|
2236
|
-
|
|
2237
1814
|
<div class="padding-left--md padding-bottom--md">
|
|
2238
1815
|
<strong>records</strong>: Array<null | <a href="#resultrecord">ResultRecord</a>>
|
|
2239
1816
|
<div class="padding-left--md">
|
|
@@ -2242,10 +1819,7 @@ List of records containing the result fields data.
|
|
|
2242
1819
|
|
|
2243
1820
|
</div>
|
|
2244
1821
|
|
|
2245
|
-
|
|
2246
|
-
|
|
2247
1822
|
</div>
|
|
2248
|
-
|
|
2249
1823
|
<div class="padding-left--md padding-bottom--md">
|
|
2250
1824
|
<strong>types</strong>: Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>>
|
|
2251
1825
|
<div class="padding-left--md">
|
|
@@ -2254,19 +1828,13 @@ The data types for the result records.
|
|
|
2254
1828
|
|
|
2255
1829
|
</div>
|
|
2256
1830
|
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
1831
|
</div>
|
|
2260
1832
|
|
|
2261
|
-
|
|
2262
1833
|
</div>
|
|
2263
1834
|
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
1835
|
### QueryStartResponse
|
|
2267
|
-
<div class="padding-left--md">
|
|
2268
|
-
|
|
2269
1836
|
|
|
1837
|
+
<div class="padding-left--md">
|
|
2270
1838
|
|
|
2271
1839
|
The response when starting a query.
|
|
2272
1840
|
|
|
@@ -2278,10 +1846,7 @@ The progress of the query from 0 to 100.
|
|
|
2278
1846
|
|
|
2279
1847
|
</div>
|
|
2280
1848
|
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
1849
|
</div>
|
|
2284
|
-
|
|
2285
1850
|
<div class="padding-left--md padding-bottom--md">
|
|
2286
1851
|
<strong>requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2287
1852
|
<div class="padding-left--md">
|
|
@@ -2290,34 +1855,21 @@ The token returned by the POST query:execute call.
|
|
|
2290
1855
|
|
|
2291
1856
|
</div>
|
|
2292
1857
|
|
|
2293
|
-
|
|
2294
|
-
|
|
2295
1858
|
</div>
|
|
2296
|
-
|
|
2297
1859
|
<div class="padding-left--md padding-bottom--md">
|
|
2298
1860
|
<strong>result</strong>: <a href="#queryresult">QueryResult</a>
|
|
2299
1861
|
<div class="padding-left--md">
|
|
2300
1862
|
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
1863
|
</div>
|
|
2304
1864
|
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
1865
|
</div>
|
|
2308
|
-
|
|
2309
1866
|
<div class="padding-left--md padding-bottom--md">
|
|
2310
1867
|
<strong>state</strong>: <a href="#querystate">QueryState</a>
|
|
2311
1868
|
<div class="padding-left--md">
|
|
2312
1869
|
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
1870
|
</div>
|
|
2316
1871
|
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
1872
|
</div>
|
|
2320
|
-
|
|
2321
1873
|
<div class="padding-left--md padding-bottom--md">
|
|
2322
1874
|
<strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
2323
1875
|
<div class="padding-left--md">
|
|
@@ -2326,19 +1878,13 @@ Time to live in seconds.
|
|
|
2326
1878
|
|
|
2327
1879
|
</div>
|
|
2328
1880
|
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
1881
|
</div>
|
|
2332
1882
|
|
|
2333
|
-
|
|
2334
1883
|
</div>
|
|
2335
1884
|
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
1885
|
### RangedFieldTypes
|
|
2339
|
-
<div class="padding-left--md">
|
|
2340
|
-
|
|
2341
1886
|
|
|
1887
|
+
<div class="padding-left--md">
|
|
2342
1888
|
|
|
2343
1889
|
The field type in range.
|
|
2344
1890
|
|
|
@@ -2350,57 +1896,36 @@ The range of elements at use this type in arrays (null for records).
|
|
|
2350
1896
|
|
|
2351
1897
|
</div>
|
|
2352
1898
|
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
1899
|
</div>
|
|
2356
|
-
|
|
2357
1900
|
<div class="padding-left--md padding-bottom--md">
|
|
2358
1901
|
<strong>mappings</strong>: <a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a>
|
|
2359
1902
|
<div class="padding-left--md">
|
|
2360
1903
|
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
1904
|
</div>
|
|
2364
1905
|
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
1906
|
</div>
|
|
2368
1907
|
|
|
2369
|
-
|
|
2370
1908
|
</div>
|
|
2371
1909
|
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
1910
|
### RangedFieldTypesMappings
|
|
2375
|
-
<div class="padding-left--md">
|
|
2376
|
-
|
|
2377
1911
|
|
|
1912
|
+
<div class="padding-left--md">
|
|
2378
1913
|
|
|
2379
1914
|
The mapping between the field name and data type.
|
|
2380
1915
|
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
1916
|
</div>
|
|
2384
1917
|
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
1918
|
### ResultRecord
|
|
2388
|
-
<div class="padding-left--md">
|
|
2389
|
-
|
|
2390
1919
|
|
|
1920
|
+
<div class="padding-left--md">
|
|
2391
1921
|
|
|
2392
1922
|
Single record that contains the result fields.
|
|
2393
1923
|
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
1924
|
</div>
|
|
2397
1925
|
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
1926
|
### Timeframe
|
|
2401
|
-
<div class="padding-left--md">
|
|
2402
|
-
|
|
2403
1927
|
|
|
1928
|
+
<div class="padding-left--md">
|
|
2404
1929
|
|
|
2405
1930
|
DQL data type timeframe.
|
|
2406
1931
|
|
|
@@ -2412,10 +1937,7 @@ The end time of the timeframe.
|
|
|
2412
1937
|
|
|
2413
1938
|
</div>
|
|
2414
1939
|
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
1940
|
</div>
|
|
2418
|
-
|
|
2419
1941
|
<div class="padding-left--md padding-bottom--md">
|
|
2420
1942
|
<strong>start</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>
|
|
2421
1943
|
<div class="padding-left--md">
|
|
@@ -2424,19 +1946,13 @@ The start time of the timeframe.
|
|
|
2424
1946
|
|
|
2425
1947
|
</div>
|
|
2426
1948
|
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
1949
|
</div>
|
|
2430
1950
|
|
|
2431
|
-
|
|
2432
1951
|
</div>
|
|
2433
1952
|
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
1953
|
### TokenPosition
|
|
2437
|
-
<div class="padding-left--md">
|
|
2438
|
-
|
|
2439
1954
|
|
|
1955
|
+
<div class="padding-left--md">
|
|
2440
1956
|
|
|
2441
1957
|
The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
|
|
2442
1958
|
|
|
@@ -2444,37 +1960,22 @@ The position of a token in a query string used for errors and notification to ma
|
|
|
2444
1960
|
<strong>end</strong>: <a href="#positioninfo">PositionInfo</a>
|
|
2445
1961
|
<div class="padding-left--md">
|
|
2446
1962
|
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
1963
|
</div>
|
|
2450
1964
|
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
1965
|
</div>
|
|
2454
|
-
|
|
2455
1966
|
<div class="padding-left--md padding-bottom--md">
|
|
2456
1967
|
<strong>start</strong>: <a href="#positioninfo">PositionInfo</a>
|
|
2457
1968
|
<div class="padding-left--md">
|
|
2458
1969
|
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
1970
|
</div>
|
|
2462
1971
|
|
|
2463
|
-
|
|
2464
|
-
|
|
2465
1972
|
</div>
|
|
2466
1973
|
|
|
2467
|
-
|
|
2468
1974
|
</div>
|
|
2469
1975
|
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
1976
|
### VerifyRequest
|
|
2473
|
-
<div class="padding-left--md">
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
1977
|
|
|
1978
|
+
<div class="padding-left--md">
|
|
2478
1979
|
|
|
2479
1980
|
<div class="padding-left--md padding-bottom--md">
|
|
2480
1981
|
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
@@ -2484,10 +1985,7 @@ The query locale. If none specified, then a language/country neutral locale is c
|
|
|
2484
1985
|
|
|
2485
1986
|
</div>
|
|
2486
1987
|
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
1988
|
</div>
|
|
2490
|
-
|
|
2491
1989
|
<div class="padding-left--md padding-bottom--md">
|
|
2492
1990
|
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2493
1991
|
<div class="padding-left--md">
|
|
@@ -2496,10 +1994,7 @@ The full query string.
|
|
|
2496
1994
|
|
|
2497
1995
|
</div>
|
|
2498
1996
|
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
1997
|
</div>
|
|
2502
|
-
|
|
2503
1998
|
<div class="padding-left--md padding-bottom--md">
|
|
2504
1999
|
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2505
2000
|
<div class="padding-left--md">
|
|
@@ -2508,19 +2003,13 @@ The query timezone. If none is specified, UTC is used as fallback. The list of v
|
|
|
2508
2003
|
|
|
2509
2004
|
</div>
|
|
2510
2005
|
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
2006
|
</div>
|
|
2514
2007
|
|
|
2515
|
-
|
|
2516
2008
|
</div>
|
|
2517
2009
|
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
2010
|
### VerifyResponse
|
|
2521
|
-
<div class="padding-left--md">
|
|
2522
|
-
|
|
2523
2011
|
|
|
2012
|
+
<div class="padding-left--md">
|
|
2524
2013
|
|
|
2525
2014
|
Verify response.
|
|
2526
2015
|
|
|
@@ -2532,10 +2021,7 @@ The notifications related to the supplied DQL query string.
|
|
|
2532
2021
|
|
|
2533
2022
|
</div>
|
|
2534
2023
|
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
2024
|
</div>
|
|
2538
|
-
|
|
2539
2025
|
<div class="padding-left--md padding-bottom--md">
|
|
2540
2026
|
<strong>valid</strong>: boolean
|
|
2541
2027
|
<div class="padding-left--md">
|
|
@@ -2544,19 +2030,12 @@ True if the supplied DQL query string is valid.
|
|
|
2544
2030
|
|
|
2545
2031
|
</div>
|
|
2546
2032
|
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
2033
|
</div>
|
|
2550
2034
|
|
|
2551
|
-
|
|
2552
2035
|
</div>
|
|
2553
2036
|
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
2037
|
## Enums
|
|
2558
2038
|
|
|
2559
|
-
|
|
2560
2039
|
### DQLNodeNodeType
|
|
2561
2040
|
|
|
2562
2041
|
<div class="padding-left--md">
|
|
@@ -2571,18 +2050,12 @@ The type of the node.
|
|
|
2571
2050
|
|
|
2572
2051
|
</div>
|
|
2573
2052
|
|
|
2574
|
-
|
|
2575
2053
|
</div>
|
|
2576
2054
|
|
|
2577
|
-
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
2055
|
### FieldTypeType
|
|
2581
2056
|
|
|
2582
2057
|
<div class="padding-left--md">
|
|
2583
2058
|
|
|
2584
|
-
|
|
2585
|
-
|
|
2586
2059
|
#### Enum keys
|
|
2587
2060
|
|
|
2588
2061
|
<div class="padding-left--md">
|
|
@@ -2591,12 +2064,8 @@ The type of the node.
|
|
|
2591
2064
|
|
|
2592
2065
|
</div>
|
|
2593
2066
|
|
|
2594
|
-
|
|
2595
2067
|
</div>
|
|
2596
2068
|
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
2069
|
### QueryState
|
|
2601
2070
|
|
|
2602
2071
|
<div class="padding-left--md">
|
|
@@ -2611,12 +2080,8 @@ Possible state of the query.
|
|
|
2611
2080
|
|
|
2612
2081
|
</div>
|
|
2613
2082
|
|
|
2614
|
-
|
|
2615
2083
|
</div>
|
|
2616
2084
|
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
2085
|
### TokenType
|
|
2621
2086
|
|
|
2622
2087
|
<div class="padding-left--md">
|
|
@@ -2631,9 +2096,4 @@ The type of the autocomplete token.
|
|
|
2631
2096
|
|
|
2632
2097
|
</div>
|
|
2633
2098
|
|
|
2634
|
-
|
|
2635
2099
|
</div>
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|