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