@dynatrace-sdk/client-query 1.2.2 → 1.4.0
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 +18 -0
- package/README.md +1 -1
- package/cjs/index.js +18 -8
- package/docs/DOCS.md +256 -1352
- package/dynatrace-metadata.json +1 -1
- package/esm/index.js +18 -8
- package/package.json +1 -1
- package/types/packages/client/query/src/lib/models/execute-request.d.ts +4 -0
- package/types/packages/client/query/src/lib/models/execute-request.transformation.d.ts +1 -0
- package/types/packages/client/query/src/lib/models/metric-metadata.d.ts +4 -0
- package/types/packages/client/query/src/lib/models/metric-metadata.transformation.d.ts +1 -0
package/docs/DOCS.md
CHANGED
|
@@ -17,7 +17,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
|
|
|
17
17
|
</a>
|
|
18
18
|
</div>
|
|
19
19
|
<div class="col" style={{textAlign: 'right'}}>
|
|
20
|
-
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.
|
|
20
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.4.0">v1.4.0</a>
|
|
21
21
|
</div>
|
|
22
22
|
</div>
|
|
23
23
|
|
|
@@ -76,46 +76,19 @@ Fields in `parts`
|
|
|
76
76
|
The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
|
|
77
77
|
a link to docs, etc.
|
|
78
78
|
|
|
79
|
-
**Parameters**
|
|
80
|
-
|
|
81
|
-
<div class="padding-left--md padding-bottom--md">
|
|
82
|
-
<strong>config</strong>: Object
|
|
83
|
-
<div class="padding-left--md">
|
|
84
|
-
|
|
85
|
-
</div>
|
|
86
|
-
|
|
87
|
-
</div>
|
|
88
|
-
<div class="padding-left--md padding-bottom--md">
|
|
89
|
-
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
90
|
-
<div class="padding-left--md">
|
|
91
|
-
|
|
92
|
-
</div>
|
|
93
|
-
|
|
94
|
-
</div>
|
|
95
|
-
<div class="padding-left--md padding-bottom--md">
|
|
96
|
-
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
97
|
-
<div class="padding-left--md">
|
|
98
|
-
|
|
99
|
-
The authorization context. Typically start with 'Bearer '.
|
|
100
|
-
|
|
101
|
-
</div>
|
|
102
|
-
|
|
103
79
|
</div>
|
|
104
|
-
<div class="padding-left--md padding-bottom--md">
|
|
105
|
-
<strong>config.body</strong>: <a href="#autocompleterequest">AutocompleteRequest</a>
|
|
106
|
-
<div class="padding-left--md">
|
|
107
80
|
|
|
108
|
-
|
|
81
|
+
#### Parameters
|
|
109
82
|
|
|
110
|
-
|
|
83
|
+
| Name | Type | Description |
|
|
84
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
85
|
+
| config.authorization | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The authorization context. Typically start with 'Bearer '. |
|
|
86
|
+
| config.body<sup>\*required</sup> | <a href="#autocompleterequest">AutocompleteRequest</a> | |
|
|
111
87
|
|
|
112
88
|
#### Returns
|
|
113
89
|
|
|
114
|
-
<div class="padding-left--md">
|
|
115
90
|
A list of structured autocomplete suggestions.
|
|
116
91
|
|
|
117
|
-
</div>
|
|
118
|
-
|
|
119
92
|
<details>
|
|
120
93
|
<summary>
|
|
121
94
|
Code example
|
|
@@ -135,8 +108,6 @@ const data = await queryAssistanceClient.queryAutocomplete({
|
|
|
135
108
|
|
|
136
109
|
</div>
|
|
137
110
|
|
|
138
|
-
</div>
|
|
139
|
-
|
|
140
111
|
### queryParse
|
|
141
112
|
|
|
142
113
|
<div class="padding-bottom--md">
|
|
@@ -173,7 +144,7 @@ and `column` (both 1-based; for readability).
|
|
|
173
144
|
- If `tokenPosition` is present, it always contains start and end with all fields
|
|
174
145
|
- If `tokenPosition` is not present, there might still be nested nodes that do contain a position
|
|
175
146
|
- If `start == end`, the position refers to a single character
|
|
176
|
-
- If `start
|
|
147
|
+
- If `start > end`, we know for sure that something was inserted.
|
|
177
148
|
|
|
178
149
|
We can always check whether the canonical representation of a node matches the text in the tokenPosition to see whether
|
|
179
150
|
something was inserted, removed, or changed.
|
|
@@ -198,11 +169,11 @@ each node is of one of following types and may contain more fields:
|
|
|
198
169
|
|
|
199
170
|
can be identified by checking whether `canonicalString` is present
|
|
200
171
|
|
|
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
|
|
172
|
+
| Field | Mandatory | Description |
|
|
173
|
+
| ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
174
|
+
| type | yes | the type of the terminal node - do not confuse with the type of container nodes |
|
|
175
|
+
| canonicalString | yes | the canonical string representation. Concatenating the canonicalString of all nested terminal nodes provides the canonical form of the query. |
|
|
176
|
+
| 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 |
|
|
206
177
|
|
|
207
178
|
##### Current types of terminal nodes (list might grow):
|
|
208
179
|
|
|
@@ -338,45 +309,18 @@ _Examples_:
|
|
|
338
309
|
for `FILTER condition:a == 1`. This `condition:` was neither written by the user nor is it canonical; but it might be
|
|
339
310
|
used to help the user understand what this parameter means.
|
|
340
311
|
|
|
341
|
-
**Parameters**
|
|
342
|
-
|
|
343
|
-
<div class="padding-left--md padding-bottom--md">
|
|
344
|
-
<strong>config</strong>: Object
|
|
345
|
-
<div class="padding-left--md">
|
|
346
|
-
|
|
347
|
-
</div>
|
|
348
|
-
|
|
349
|
-
</div>
|
|
350
|
-
<div class="padding-left--md padding-bottom--md">
|
|
351
|
-
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
352
|
-
<div class="padding-left--md">
|
|
353
|
-
|
|
354
312
|
</div>
|
|
355
313
|
|
|
356
|
-
|
|
357
|
-
<div class="padding-left--md padding-bottom--md">
|
|
358
|
-
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
359
|
-
<div class="padding-left--md">
|
|
360
|
-
|
|
361
|
-
The authorization context. Typically start with 'Bearer '.
|
|
362
|
-
|
|
363
|
-
</div>
|
|
364
|
-
|
|
365
|
-
</div>
|
|
366
|
-
<div class="padding-left--md padding-bottom--md">
|
|
367
|
-
<strong>config.body</strong>: <a href="#parserequest">ParseRequest</a>
|
|
368
|
-
<div class="padding-left--md">
|
|
314
|
+
#### Parameters
|
|
369
315
|
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
</
|
|
316
|
+
| Name | Type | Description |
|
|
317
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
318
|
+
| config.authorization | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The authorization context. Typically start with 'Bearer '. |
|
|
319
|
+
| config.body<sup>\*required</sup> | <a href="#parserequest">ParseRequest</a> | |
|
|
373
320
|
|
|
374
321
|
#### Returns
|
|
375
322
|
|
|
376
|
-
|
|
377
|
-
A node containing more nodes, a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.
|
|
378
|
-
|
|
379
|
-
</div>
|
|
323
|
+
A node containing more nodes, a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.
|
|
380
324
|
|
|
381
325
|
<details>
|
|
382
326
|
<summary>
|
|
@@ -397,8 +341,6 @@ const data = await queryAssistanceClient.queryParse({
|
|
|
397
341
|
|
|
398
342
|
</div>
|
|
399
343
|
|
|
400
|
-
</div>
|
|
401
|
-
|
|
402
344
|
### queryVerify
|
|
403
345
|
|
|
404
346
|
<div class="padding-bottom--md">
|
|
@@ -415,46 +357,19 @@ For information about the required permissions see the [Bucket and table permiss
|
|
|
415
357
|
Verifies the supplied query string and other query parameters for lack of any errors, but without actually
|
|
416
358
|
submitting the query for execution.
|
|
417
359
|
|
|
418
|
-
**Parameters**
|
|
419
|
-
|
|
420
|
-
<div class="padding-left--md padding-bottom--md">
|
|
421
|
-
<strong>config</strong>: Object
|
|
422
|
-
<div class="padding-left--md">
|
|
423
|
-
|
|
424
|
-
</div>
|
|
425
|
-
|
|
426
|
-
</div>
|
|
427
|
-
<div class="padding-left--md padding-bottom--md">
|
|
428
|
-
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
429
|
-
<div class="padding-left--md">
|
|
430
|
-
|
|
431
|
-
</div>
|
|
432
|
-
|
|
433
|
-
</div>
|
|
434
|
-
<div class="padding-left--md padding-bottom--md">
|
|
435
|
-
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
436
|
-
<div class="padding-left--md">
|
|
437
|
-
|
|
438
|
-
The authorization context. Typically start with 'Bearer '.
|
|
439
|
-
|
|
440
|
-
</div>
|
|
441
|
-
|
|
442
360
|
</div>
|
|
443
|
-
<div class="padding-left--md padding-bottom--md">
|
|
444
|
-
<strong>config.body</strong>: <a href="#verifyrequest">VerifyRequest</a>
|
|
445
|
-
<div class="padding-left--md">
|
|
446
361
|
|
|
447
|
-
|
|
362
|
+
#### Parameters
|
|
448
363
|
|
|
449
|
-
|
|
364
|
+
| Name | Type | Description |
|
|
365
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
366
|
+
| config.authorization | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The authorization context. Typically start with 'Bearer '. |
|
|
367
|
+
| config.body<sup>\*required</sup> | <a href="#verifyrequest">VerifyRequest</a> | |
|
|
450
368
|
|
|
451
369
|
#### Returns
|
|
452
370
|
|
|
453
|
-
<div class="padding-left--md">
|
|
454
371
|
Supplied query and parameters were verified.
|
|
455
372
|
|
|
456
|
-
</div>
|
|
457
|
-
|
|
458
373
|
<details>
|
|
459
374
|
<summary>
|
|
460
375
|
Code example
|
|
@@ -474,8 +389,6 @@ const data = await queryAssistanceClient.queryVerify({
|
|
|
474
389
|
|
|
475
390
|
</div>
|
|
476
391
|
|
|
477
|
-
</div>
|
|
478
|
-
|
|
479
392
|
## queryExecutionClient
|
|
480
393
|
|
|
481
394
|
```js
|
|
@@ -485,7 +398,7 @@ import { queryExecutionClient } from "@dynatrace-sdk/client-query";
|
|
|
485
398
|
### queryCancel
|
|
486
399
|
|
|
487
400
|
<div class="padding-bottom--md">
|
|
488
|
-
<strong>queryExecutionClient.queryCancel(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a><void
|
|
401
|
+
<strong>queryExecutionClient.queryCancel(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a><void | <a href="#querypollresponse">QueryPollResponse</a>></strong>
|
|
489
402
|
|
|
490
403
|
<div class="padding-left--md">
|
|
491
404
|
|
|
@@ -514,7 +427,7 @@ records will find their field types in which bucket. The index range has two val
|
|
|
514
427
|
A field part of a record with index 'i' will find its corresponding field type by first locating the bucket that satisfies:
|
|
515
428
|
|
|
516
429
|
```text
|
|
517
|
-
startIndex
|
|
430
|
+
startIndex <= i <= endIndex
|
|
518
431
|
```
|
|
519
432
|
|
|
520
433
|
Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
|
|
@@ -526,39 +439,18 @@ the new record field types will be placed.
|
|
|
526
439
|
It is guaranteed that every field of every record will have a corresponding type.
|
|
527
440
|
**Clients should always take the included types into account when consuming records!**
|
|
528
441
|
|
|
529
|
-
**Parameters**
|
|
530
|
-
|
|
531
|
-
<div class="padding-left--md padding-bottom--md">
|
|
532
|
-
<strong>config</strong>: Object
|
|
533
|
-
<div class="padding-left--md">
|
|
534
|
-
|
|
535
|
-
</div>
|
|
536
|
-
|
|
537
|
-
</div>
|
|
538
|
-
<div class="padding-left--md padding-bottom--md">
|
|
539
|
-
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
540
|
-
<div class="padding-left--md">
|
|
541
|
-
|
|
542
442
|
</div>
|
|
543
443
|
|
|
544
|
-
|
|
545
|
-
<div class="padding-left--md padding-bottom--md">
|
|
546
|
-
<strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
547
|
-
<div class="padding-left--md">
|
|
548
|
-
|
|
549
|
-
The request-token of the query.
|
|
550
|
-
|
|
551
|
-
</div>
|
|
444
|
+
#### Parameters
|
|
552
445
|
|
|
553
|
-
|
|
446
|
+
| Name | Type | Description |
|
|
447
|
+
| ---------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------- |
|
|
448
|
+
| config.requestToken<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The request-token of the query. |
|
|
554
449
|
|
|
555
450
|
#### Returns
|
|
556
451
|
|
|
557
|
-
<div class="padding-left--md">
|
|
558
452
|
The query already finished.
|
|
559
453
|
|
|
560
|
-
</div>
|
|
561
|
-
|
|
562
454
|
<details>
|
|
563
455
|
<summary>
|
|
564
456
|
Code example
|
|
@@ -577,8 +469,6 @@ const data = await queryExecutionClient.queryCancel({
|
|
|
577
469
|
|
|
578
470
|
</div>
|
|
579
471
|
|
|
580
|
-
</div>
|
|
581
|
-
|
|
582
472
|
### queryExecute
|
|
583
473
|
|
|
584
474
|
<div class="padding-bottom--md">
|
|
@@ -612,7 +502,7 @@ records will find their field types in which bucket. The index range has two val
|
|
|
612
502
|
A field part of a record with index 'i' will find its corresponding field type by first locating the bucket that satisfies:
|
|
613
503
|
|
|
614
504
|
```text
|
|
615
|
-
startIndex
|
|
505
|
+
startIndex <= i <= endIndex
|
|
616
506
|
```
|
|
617
507
|
|
|
618
508
|
Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
|
|
@@ -624,55 +514,20 @@ the new record field types will be placed.
|
|
|
624
514
|
It is guaranteed that every field of every record will have a corresponding type.
|
|
625
515
|
**Clients should always take the included types into account when consuming records!**
|
|
626
516
|
|
|
627
|
-
**Parameters**
|
|
628
|
-
|
|
629
|
-
<div class="padding-left--md padding-bottom--md">
|
|
630
|
-
<strong>config</strong>: Object
|
|
631
|
-
<div class="padding-left--md">
|
|
632
|
-
|
|
633
|
-
</div>
|
|
634
|
-
|
|
635
517
|
</div>
|
|
636
|
-
<div class="padding-left--md padding-bottom--md">
|
|
637
|
-
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
638
|
-
<div class="padding-left--md">
|
|
639
|
-
|
|
640
|
-
</div>
|
|
641
|
-
|
|
642
|
-
</div>
|
|
643
|
-
<div class="padding-left--md padding-bottom--md">
|
|
644
|
-
<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
645
|
-
<div class="padding-left--md">
|
|
646
|
-
|
|
647
|
-
The authorization context. Typically start with 'Bearer '.
|
|
648
|
-
|
|
649
|
-
</div>
|
|
650
|
-
|
|
651
|
-
</div>
|
|
652
|
-
<div class="padding-left--md padding-bottom--md">
|
|
653
|
-
<strong>config.body</strong>: <a href="#executerequest">ExecuteRequest</a>
|
|
654
|
-
<div class="padding-left--md">
|
|
655
|
-
|
|
656
|
-
</div>
|
|
657
|
-
|
|
658
|
-
</div>
|
|
659
|
-
<div class="padding-left--md padding-bottom--md">
|
|
660
|
-
<strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
661
|
-
<div class="padding-left--md">
|
|
662
|
-
|
|
663
|
-
If set additional data will be available in the metadata section.
|
|
664
518
|
|
|
665
|
-
|
|
519
|
+
#### Parameters
|
|
666
520
|
|
|
667
|
-
|
|
521
|
+
| Name | Type | Description |
|
|
522
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
523
|
+
| config.authorization | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The authorization context. Typically start with 'Bearer '. |
|
|
524
|
+
| config.body<sup>\*required</sup> | <a href="#executerequest">ExecuteRequest</a> | |
|
|
525
|
+
| config.enrich | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | If set additional data will be available in the metadata section. |
|
|
668
526
|
|
|
669
527
|
#### Returns
|
|
670
528
|
|
|
671
|
-
<div class="padding-left--md">
|
|
672
529
|
The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. | The status of the query to start.
|
|
673
530
|
|
|
674
|
-
</div>
|
|
675
|
-
|
|
676
531
|
<details>
|
|
677
532
|
<summary>
|
|
678
533
|
Code example
|
|
@@ -693,8 +548,6 @@ const data = await queryExecutionClient.queryExecute({
|
|
|
693
548
|
|
|
694
549
|
</div>
|
|
695
550
|
|
|
696
|
-
</div>
|
|
697
|
-
|
|
698
551
|
### queryPoll
|
|
699
552
|
|
|
700
553
|
<div class="padding-bottom--md">
|
|
@@ -726,7 +579,7 @@ records will find their field types in which bucket. The index range has two val
|
|
|
726
579
|
A field part of a record with index 'i' will find its corresponding field type by first locating the bucket that satisfies:
|
|
727
580
|
|
|
728
581
|
```text
|
|
729
|
-
startIndex
|
|
582
|
+
startIndex <= i <= endIndex
|
|
730
583
|
```
|
|
731
584
|
|
|
732
585
|
Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
|
|
@@ -738,57 +591,20 @@ the new record field types will be placed.
|
|
|
738
591
|
It is guaranteed that every field of every record will have a corresponding type.
|
|
739
592
|
**Clients should always take the included types into account when consuming records!**
|
|
740
593
|
|
|
741
|
-
**Parameters**
|
|
742
|
-
|
|
743
|
-
<div class="padding-left--md padding-bottom--md">
|
|
744
|
-
<strong>config</strong>: Object
|
|
745
|
-
<div class="padding-left--md">
|
|
746
|
-
|
|
747
|
-
</div>
|
|
748
|
-
|
|
749
|
-
</div>
|
|
750
|
-
<div class="padding-left--md padding-bottom--md">
|
|
751
|
-
<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
|
|
752
|
-
<div class="padding-left--md">
|
|
753
|
-
|
|
754
|
-
</div>
|
|
755
|
-
|
|
756
|
-
</div>
|
|
757
|
-
<div class="padding-left--md padding-bottom--md">
|
|
758
|
-
<strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
759
|
-
<div class="padding-left--md">
|
|
760
|
-
|
|
761
|
-
If set additional data will be available in the metadata section.
|
|
762
|
-
|
|
763
|
-
</div>
|
|
764
|
-
|
|
765
|
-
</div>
|
|
766
|
-
<div class="padding-left--md padding-bottom--md">
|
|
767
|
-
<strong>config.requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
768
|
-
<div class="padding-left--md">
|
|
769
|
-
|
|
770
|
-
The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the query status is returned.
|
|
771
|
-
|
|
772
|
-
</div>
|
|
773
|
-
|
|
774
594
|
</div>
|
|
775
|
-
<div class="padding-left--md padding-bottom--md">
|
|
776
|
-
<strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
777
|
-
<div class="padding-left--md">
|
|
778
595
|
|
|
779
|
-
|
|
596
|
+
#### Parameters
|
|
780
597
|
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
</
|
|
598
|
+
| Name | Type | Description |
|
|
599
|
+
| ---------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
600
|
+
| config.enrich | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | If set additional data will be available in the metadata section. |
|
|
601
|
+
| config.requestTimeoutMilliseconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the query status is returned. |
|
|
602
|
+
| config.requestToken<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The request-token of the query. |
|
|
784
603
|
|
|
785
604
|
#### Returns
|
|
786
605
|
|
|
787
|
-
<div class="padding-left--md">
|
|
788
606
|
The current status and results of the supplied query.
|
|
789
607
|
|
|
790
|
-
</div>
|
|
791
|
-
|
|
792
608
|
<details>
|
|
793
609
|
<summary>
|
|
794
610
|
Code example
|
|
@@ -809,1230 +625,318 @@ const data = await queryExecutionClient.queryPoll({
|
|
|
809
625
|
|
|
810
626
|
</div>
|
|
811
627
|
|
|
812
|
-
</div>
|
|
813
|
-
|
|
814
628
|
## Types
|
|
815
629
|
|
|
816
630
|
### AutocompleteRequest
|
|
817
631
|
|
|
818
|
-
|
|
632
|
+
| Name | Type | Description |
|
|
633
|
+
| -------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
634
|
+
| cursorPosition | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | |
|
|
635
|
+
| locale | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
|
|
636
|
+
| query<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The full query string. |
|
|
637
|
+
| timezone | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
|
|
819
638
|
|
|
820
|
-
|
|
821
|
-
<strong>cursorPosition</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
822
|
-
<div class="padding-left--md">
|
|
639
|
+
### AutocompleteResponse
|
|
823
640
|
|
|
824
|
-
|
|
641
|
+
The response of the autocomplete call.
|
|
825
642
|
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
<
|
|
829
|
-
<
|
|
643
|
+
| Name | Type | Description |
|
|
644
|
+
| -------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
645
|
+
| optional<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | True if the suggestions are optional. |
|
|
646
|
+
| suggestedTtlSeconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Suggested duration in seconds, for how long the response may be cached and reused by the client. It is derived from the volatility of the suggestions on the server (if the suggestions are static, how long the server will cache the volatile suggestions, ...). If not provided, then the result may be cached for long time. Value below 1 means that the result should not be cached. |
|
|
647
|
+
| suggestions<sup>\*required</sup> | Array<<a href="#autocompletesuggestion">AutocompleteSuggestion</a>> | The list of suggestions. |
|
|
830
648
|
|
|
831
|
-
|
|
649
|
+
### AutocompleteSuggestion
|
|
832
650
|
|
|
833
|
-
|
|
651
|
+
Single suggestion for completion of the query.
|
|
834
652
|
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
<
|
|
838
|
-
<
|
|
653
|
+
| Name | Type | Description |
|
|
654
|
+
| ------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
655
|
+
| alreadyTypedCharacters<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of characters that the user user already typed for this suggestion. |
|
|
656
|
+
| parts<sup>\*required</sup> | Array<<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>> | List of suggestion parts. |
|
|
657
|
+
| suggestion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The suggested continuation of the query. |
|
|
839
658
|
|
|
840
|
-
|
|
659
|
+
### AutocompleteSuggestionPart
|
|
841
660
|
|
|
842
|
-
|
|
661
|
+
Part of the suggestion.
|
|
843
662
|
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
<
|
|
663
|
+
| Name | Type | Description |
|
|
664
|
+
| ------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------- |
|
|
665
|
+
| info | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The type of the suggestion. |
|
|
666
|
+
| suggestion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The suggested continuation of the query. |
|
|
667
|
+
| synopsis | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The synopsis of the suggestion. |
|
|
668
|
+
| type<sup>\*required</sup> | <a href="#tokentype">TokenType</a> | |
|
|
848
669
|
|
|
849
|
-
|
|
670
|
+
### DQLAlternativeNode
|
|
850
671
|
|
|
851
|
-
|
|
672
|
+
The DQL node that has alternatives.
|
|
852
673
|
|
|
853
|
-
|
|
674
|
+
| Name | Type | Description |
|
|
675
|
+
| ------------------------------- | ------------------------------------------------------------------------------- | ----------------------------- |
|
|
676
|
+
| alternatives | object | The different alternatives. |
|
|
677
|
+
| isOptional<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | True if the node is optional. |
|
|
678
|
+
| nodeType<sup>\*required</sup> | <a href="#dqlnodenodetype">DQLNodeNodeType</a> | |
|
|
679
|
+
| tokenPosition | <a href="#tokenposition">TokenPosition</a> | |
|
|
854
680
|
|
|
855
|
-
|
|
681
|
+
### DQLContainerNode
|
|
856
682
|
|
|
857
|
-
|
|
683
|
+
The DQL node that contains other nodes.
|
|
858
684
|
|
|
859
|
-
|
|
685
|
+
| Name | Type | Description |
|
|
686
|
+
| ------------------------------- | ------------------------------------------------------------------------------- | ----------------------------- |
|
|
687
|
+
| children | Array<<a href="#dqlnode">DQLNode</a>> | The list of children nodes. |
|
|
688
|
+
| isOptional<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | True if the node is optional. |
|
|
689
|
+
| nodeType<sup>\*required</sup> | <a href="#dqlnodenodetype">DQLNodeNodeType</a> | |
|
|
690
|
+
| tokenPosition | <a href="#tokenposition">TokenPosition</a> | |
|
|
691
|
+
| type | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The type of the node. |
|
|
860
692
|
|
|
861
|
-
|
|
693
|
+
### DQLNode
|
|
862
694
|
|
|
863
|
-
|
|
864
|
-
<strong>optional</strong>: boolean
|
|
865
|
-
<div class="padding-left--md">
|
|
695
|
+
General Node in the DQL query.
|
|
866
696
|
|
|
867
|
-
|
|
697
|
+
| Name | Type | Description |
|
|
698
|
+
| ------------------------------- | ------------------------------------------------------------------------------- | ----------------------------- |
|
|
699
|
+
| isOptional<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | True if the node is optional. |
|
|
700
|
+
| nodeType<sup>\*required</sup> | <a href="#dqlnodenodetype">DQLNodeNodeType</a> | |
|
|
701
|
+
| tokenPosition | <a href="#tokenposition">TokenPosition</a> | |
|
|
868
702
|
|
|
869
|
-
|
|
703
|
+
### DQLTerminalNode
|
|
870
704
|
|
|
871
|
-
|
|
872
|
-
<div class="padding-left--md padding-bottom--md">
|
|
873
|
-
<strong>suggestedTtlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
874
|
-
<div class="padding-left--md">
|
|
705
|
+
Node that represents single token.
|
|
875
706
|
|
|
876
|
-
|
|
707
|
+
| Name | Type | Description |
|
|
708
|
+
| ------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
709
|
+
| canonicalString | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Canonical form. |
|
|
710
|
+
| isMandatoryOnUserOrder | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces' |
|
|
711
|
+
| isOptional<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | True if the node is optional. |
|
|
712
|
+
| nodeType<sup>\*required</sup> | <a href="#dqlnodenodetype">DQLNodeNodeType</a> | |
|
|
713
|
+
| tokenPosition | <a href="#tokenposition">TokenPosition</a> | |
|
|
714
|
+
| type | <a href="#tokentype">TokenType</a> | |
|
|
877
715
|
|
|
878
|
-
|
|
716
|
+
### ErrorEnvelope
|
|
879
717
|
|
|
880
|
-
|
|
881
|
-
<div class="padding-left--md padding-bottom--md">
|
|
882
|
-
<strong>suggestions</strong>: Array<<a href="#autocompletesuggestion">AutocompleteSuggestion</a>>
|
|
883
|
-
<div class="padding-left--md">
|
|
718
|
+
An 'envelope' error object that has the mandatory error object.
|
|
884
719
|
|
|
885
|
-
|
|
720
|
+
| Name | Type |
|
|
721
|
+
| -------------------------- | ------------------------------------------ |
|
|
722
|
+
| error<sup>\*required</sup> | <a href="#errorresponse">ErrorResponse</a> |
|
|
886
723
|
|
|
887
|
-
|
|
724
|
+
### ErrorResponse
|
|
888
725
|
|
|
889
|
-
|
|
726
|
+
The response for error state
|
|
890
727
|
|
|
891
|
-
|
|
728
|
+
| Name | Type | Description |
|
|
729
|
+
| ---------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------- |
|
|
730
|
+
| code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Error code, which normally matches the HTTP error code. |
|
|
731
|
+
| details<sup>\*required</sup> | <a href="#errorresponsedetails">ErrorResponseDetails</a> | |
|
|
732
|
+
| message<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short, clear error message without details |
|
|
892
733
|
|
|
893
|
-
###
|
|
734
|
+
### ErrorResponseDetails
|
|
894
735
|
|
|
895
|
-
|
|
736
|
+
Detailed information about the error.
|
|
896
737
|
|
|
897
|
-
|
|
738
|
+
| Name | Type | Description |
|
|
739
|
+
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
740
|
+
| arguments<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The arguments for the message format. |
|
|
741
|
+
| errorMessage<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Complete error message. |
|
|
742
|
+
| errorMessageFormat<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The message format of the error message, string.format based. |
|
|
743
|
+
| errorMessageFormatSpecifierTypes<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The corresponding DQL format specifier types for each format specifier used in the error message format. |
|
|
744
|
+
| errorType<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The error type, e.g. COMMAND_NAME_MISSING |
|
|
745
|
+
| exceptionType<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The exception type. |
|
|
746
|
+
| queryString<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Submitted query string. |
|
|
747
|
+
| syntaxErrorPosition | <a href="#tokenposition">TokenPosition</a> | |
|
|
898
748
|
|
|
899
|
-
|
|
900
|
-
<strong>alreadyTypedCharacters</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
901
|
-
<div class="padding-left--md">
|
|
749
|
+
### ExecuteRequest
|
|
902
750
|
|
|
903
|
-
|
|
751
|
+
| Name | Type | Description |
|
|
752
|
+
| -------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
753
|
+
| defaultSamplingRatio | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries. |
|
|
754
|
+
| defaultScanLimitGbytes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Limit in gigabytes for the amount data that will be scanned during read. |
|
|
755
|
+
| defaultTimeframeEnd | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
|
|
756
|
+
| defaultTimeframeStart | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
|
|
757
|
+
| enablePreview | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response. |
|
|
758
|
+
| fetchTimeoutSeconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The query will stop after reaching the fetch-timeout. |
|
|
759
|
+
| locale | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
|
|
760
|
+
| maxResultBytes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The maximum number of result bytes that this query will return. |
|
|
761
|
+
| maxResultRecords | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The maximum number of result records that this query will return. |
|
|
762
|
+
| query<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The full query string. |
|
|
763
|
+
| requestTimeoutMilliseconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result. |
|
|
764
|
+
| timezone | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
|
|
904
765
|
|
|
905
|
-
|
|
766
|
+
### FieldType
|
|
906
767
|
|
|
907
|
-
|
|
908
|
-
<div class="padding-left--md padding-bottom--md">
|
|
909
|
-
<strong>parts</strong>: Array<<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>>
|
|
910
|
-
<div class="padding-left--md">
|
|
768
|
+
The possible type of a field in DQL.
|
|
911
769
|
|
|
912
|
-
|
|
770
|
+
| Name | Type |
|
|
771
|
+
| ------------------------- | ------------------------------------------------------------- |
|
|
772
|
+
| type<sup>\*required</sup> | <a href="#fieldtypetype">FieldTypeType</a> |
|
|
773
|
+
| types | Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>> |
|
|
913
774
|
|
|
914
|
-
|
|
775
|
+
### GeoPoint
|
|
915
776
|
|
|
916
|
-
|
|
917
|
-
<div class="padding-left--md padding-bottom--md">
|
|
918
|
-
<strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
919
|
-
<div class="padding-left--md">
|
|
777
|
+
DQL data type representing a geolocation point.
|
|
920
778
|
|
|
921
|
-
|
|
779
|
+
| Name | Type | Description |
|
|
780
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
781
|
+
| latitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The coordinate that specifies the north–south position of a point on the surface of the earth. |
|
|
782
|
+
| longitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The coordinate that specifies the east–west position of a point on the surface of the earth. |
|
|
922
783
|
|
|
923
|
-
|
|
784
|
+
### GrailMetadata
|
|
924
785
|
|
|
925
|
-
|
|
786
|
+
Collects various bits of metadata information.
|
|
926
787
|
|
|
927
|
-
|
|
788
|
+
| Name | Type | Description |
|
|
789
|
+
| ------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
790
|
+
| analysisTimeframe | <a href="#timeframe">Timeframe</a> | |
|
|
791
|
+
| canonicalQuery | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The canonical form of the query. It has normalized spaces and canonical constructs. |
|
|
792
|
+
| dqlVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of DQL that was used to process the query request. |
|
|
793
|
+
| executionTimeMilliseconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The time it took to execute the query. |
|
|
794
|
+
| locale | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Effective locale for the query. |
|
|
795
|
+
| notifications | Array<<a href="#metadatanotification">MetadataNotification</a>> | Collected messages during the execution of the query. |
|
|
796
|
+
| query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The submitted query. |
|
|
797
|
+
| queryId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The id of the query |
|
|
798
|
+
| sampled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | True if sampling was used for at least one segment. |
|
|
799
|
+
| scannedBytes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of scanned bytes during the query execution. |
|
|
800
|
+
| scannedRecords | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of scanned records during the query execution. |
|
|
801
|
+
| timezone | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Effective timezone for the query. |
|
|
928
802
|
|
|
929
|
-
###
|
|
803
|
+
### Metadata
|
|
930
804
|
|
|
931
|
-
|
|
805
|
+
Collects various bits of metadata information.
|
|
932
806
|
|
|
933
|
-
|
|
807
|
+
| Name | Type |
|
|
808
|
+
| ------- | --------------------------------------------------------- |
|
|
809
|
+
| grail | <a href="#grailmetadata">GrailMetadata</a> |
|
|
810
|
+
| metrics | Array<<a href="#metricmetadata">MetricMetadata</a>> |
|
|
934
811
|
|
|
935
|
-
|
|
936
|
-
<strong>info</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
937
|
-
<div class="padding-left--md">
|
|
812
|
+
### MetadataNotification
|
|
938
813
|
|
|
939
|
-
The
|
|
814
|
+
The message that provides additional information about the execution of the query.
|
|
940
815
|
|
|
941
|
-
|
|
816
|
+
| Name | Type | Description |
|
|
817
|
+
| --------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
818
|
+
| arguments | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The arguments for the message format. |
|
|
819
|
+
| message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The complete message of the notification. |
|
|
820
|
+
| messageFormat | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The message format of the notification, string.format based |
|
|
821
|
+
| messageFormatSpecifierTypes | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The corresponding DQL format specifier types for each format specifier used in the error message format. |
|
|
822
|
+
| notificationType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The notification type, e.g. LIMIT_ADDED. |
|
|
823
|
+
| severity | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The severity of the notification, currently: INFO, WARN, ERROR. |
|
|
824
|
+
| syntaxPosition | <a href="#tokenposition">TokenPosition</a> | |
|
|
942
825
|
|
|
943
|
-
|
|
944
|
-
<div class="padding-left--md padding-bottom--md">
|
|
945
|
-
<strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
946
|
-
<div class="padding-left--md">
|
|
826
|
+
### MetricMetadata
|
|
947
827
|
|
|
948
|
-
|
|
828
|
+
An object that defines additional metric metadata.
|
|
949
829
|
|
|
950
|
-
|
|
830
|
+
| Name | Type | Description |
|
|
831
|
+
| ----------- | ----------------------------------------------------------------------------- | --------------------------------------------------- |
|
|
832
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The description of the metadata. |
|
|
833
|
+
| displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the metadata. |
|
|
834
|
+
| fieldName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the associated field used in the query. |
|
|
835
|
+
| metric.key | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The metric key. |
|
|
836
|
+
| unit | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unit used. |
|
|
951
837
|
|
|
952
|
-
|
|
953
|
-
<div class="padding-left--md padding-bottom--md">
|
|
954
|
-
<strong>synopsis</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
955
|
-
<div class="padding-left--md">
|
|
838
|
+
### ParseRequest
|
|
956
839
|
|
|
957
|
-
|
|
840
|
+
| Name | Type | Description |
|
|
841
|
+
| -------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
842
|
+
| locale | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
|
|
843
|
+
| query<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The full query string. |
|
|
844
|
+
| timezone | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
|
|
958
845
|
|
|
959
|
-
|
|
846
|
+
### PositionInfo
|
|
960
847
|
|
|
961
|
-
|
|
962
|
-
<div class="padding-left--md padding-bottom--md">
|
|
963
|
-
<strong>type</strong>: <a href="#tokentype">TokenType</a>
|
|
964
|
-
<div class="padding-left--md">
|
|
848
|
+
The exact position in the query string.
|
|
965
849
|
|
|
966
|
-
|
|
850
|
+
| Name | Type | Description |
|
|
851
|
+
| --------------------------- | ----------------------------------------------------------------------------- | --------------------------------------- |
|
|
852
|
+
| column<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Query position column zero based index. |
|
|
853
|
+
| index<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Query position index. |
|
|
854
|
+
| line<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Query position line zero based index. |
|
|
967
855
|
|
|
968
|
-
|
|
856
|
+
### QueryPollResponse
|
|
969
857
|
|
|
970
|
-
|
|
858
|
+
The response of GET query:execute call.
|
|
971
859
|
|
|
972
|
-
|
|
860
|
+
| Name | Type | Description |
|
|
861
|
+
| -------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------- |
|
|
862
|
+
| progress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The progress of the query from 0 to 100. |
|
|
863
|
+
| result | <a href="#queryresult">QueryResult</a> | |
|
|
864
|
+
| state<sup>\*required</sup> | <a href="#querystate">QueryState</a> | |
|
|
865
|
+
| ttlSeconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Time to live in seconds. |
|
|
973
866
|
|
|
974
|
-
|
|
867
|
+
### QueryResult
|
|
975
868
|
|
|
976
|
-
The
|
|
869
|
+
The result of the DQL query.
|
|
977
870
|
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
<
|
|
871
|
+
| Name | Type | Description |
|
|
872
|
+
| ----------------------------- | ----------------------------------------------------------------- | -------------------------------------------------- |
|
|
873
|
+
| metadata<sup>\*required</sup> | <a href="#metadata">Metadata</a> | |
|
|
874
|
+
| records<sup>\*required</sup> | Array<null | <a href="#resultrecord">ResultRecord</a>> | List of records containing the result fields data. |
|
|
875
|
+
| types<sup>\*required</sup> | Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>> | The data types for the result records. |
|
|
981
876
|
|
|
982
|
-
|
|
877
|
+
### QueryStartResponse
|
|
983
878
|
|
|
984
|
-
|
|
879
|
+
The response when starting a query.
|
|
985
880
|
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
<
|
|
989
|
-
<
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
</div>
|
|
994
|
-
|
|
995
|
-
</div>
|
|
996
|
-
<div class="padding-left--md padding-bottom--md">
|
|
997
|
-
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
998
|
-
<div class="padding-left--md">
|
|
999
|
-
|
|
1000
|
-
</div>
|
|
1001
|
-
|
|
1002
|
-
</div>
|
|
1003
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1004
|
-
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1005
|
-
<div class="padding-left--md">
|
|
1006
|
-
|
|
1007
|
-
</div>
|
|
1008
|
-
|
|
1009
|
-
</div>
|
|
1010
|
-
|
|
1011
|
-
</div>
|
|
1012
|
-
|
|
1013
|
-
### DQLContainerNode
|
|
1014
|
-
|
|
1015
|
-
<div class="padding-left--md">
|
|
1016
|
-
|
|
1017
|
-
The DQL node that contains other nodes.
|
|
1018
|
-
|
|
1019
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1020
|
-
<strong>children</strong>: Array<<a href="#dqlnode">DQLNode</a>>
|
|
1021
|
-
<div class="padding-left--md">
|
|
1022
|
-
|
|
1023
|
-
The list of children nodes.
|
|
1024
|
-
|
|
1025
|
-
</div>
|
|
1026
|
-
|
|
1027
|
-
</div>
|
|
1028
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1029
|
-
<strong>isOptional</strong>: boolean
|
|
1030
|
-
<div class="padding-left--md">
|
|
1031
|
-
|
|
1032
|
-
True if the node is optional.
|
|
1033
|
-
|
|
1034
|
-
</div>
|
|
1035
|
-
|
|
1036
|
-
</div>
|
|
1037
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1038
|
-
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
1039
|
-
<div class="padding-left--md">
|
|
1040
|
-
|
|
1041
|
-
</div>
|
|
1042
|
-
|
|
1043
|
-
</div>
|
|
1044
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1045
|
-
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1046
|
-
<div class="padding-left--md">
|
|
1047
|
-
|
|
1048
|
-
</div>
|
|
1049
|
-
|
|
1050
|
-
</div>
|
|
1051
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1052
|
-
<strong>type</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1053
|
-
<div class="padding-left--md">
|
|
1054
|
-
|
|
1055
|
-
The type of the node.
|
|
1056
|
-
|
|
1057
|
-
</div>
|
|
1058
|
-
|
|
1059
|
-
</div>
|
|
1060
|
-
|
|
1061
|
-
</div>
|
|
1062
|
-
|
|
1063
|
-
### DQLNode
|
|
1064
|
-
|
|
1065
|
-
<div class="padding-left--md">
|
|
1066
|
-
|
|
1067
|
-
General Node in the DQL query.
|
|
1068
|
-
|
|
1069
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1070
|
-
<strong>isOptional</strong>: boolean
|
|
1071
|
-
<div class="padding-left--md">
|
|
1072
|
-
|
|
1073
|
-
True if the node is optional.
|
|
1074
|
-
|
|
1075
|
-
</div>
|
|
1076
|
-
|
|
1077
|
-
</div>
|
|
1078
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1079
|
-
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
1080
|
-
<div class="padding-left--md">
|
|
1081
|
-
|
|
1082
|
-
</div>
|
|
1083
|
-
|
|
1084
|
-
</div>
|
|
1085
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1086
|
-
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1087
|
-
<div class="padding-left--md">
|
|
1088
|
-
|
|
1089
|
-
</div>
|
|
1090
|
-
|
|
1091
|
-
</div>
|
|
1092
|
-
|
|
1093
|
-
</div>
|
|
1094
|
-
|
|
1095
|
-
### DQLTerminalNode
|
|
1096
|
-
|
|
1097
|
-
<div class="padding-left--md">
|
|
1098
|
-
|
|
1099
|
-
Node that represents single token.
|
|
1100
|
-
|
|
1101
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1102
|
-
<strong>canonicalString</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1103
|
-
<div class="padding-left--md">
|
|
1104
|
-
|
|
1105
|
-
Canonical form.
|
|
1106
|
-
|
|
1107
|
-
</div>
|
|
1108
|
-
|
|
1109
|
-
</div>
|
|
1110
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1111
|
-
<strong>isMandatoryOnUserOrder</strong>: boolean
|
|
1112
|
-
<div class="padding-left--md">
|
|
1113
|
-
|
|
1114
|
-
For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces'
|
|
1115
|
-
|
|
1116
|
-
</div>
|
|
1117
|
-
|
|
1118
|
-
</div>
|
|
1119
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1120
|
-
<strong>isOptional</strong>: boolean
|
|
1121
|
-
<div class="padding-left--md">
|
|
1122
|
-
|
|
1123
|
-
True if the node is optional.
|
|
1124
|
-
|
|
1125
|
-
</div>
|
|
1126
|
-
|
|
1127
|
-
</div>
|
|
1128
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1129
|
-
<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
|
|
1130
|
-
<div class="padding-left--md">
|
|
1131
|
-
|
|
1132
|
-
</div>
|
|
1133
|
-
|
|
1134
|
-
</div>
|
|
1135
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1136
|
-
<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1137
|
-
<div class="padding-left--md">
|
|
1138
|
-
|
|
1139
|
-
</div>
|
|
1140
|
-
|
|
1141
|
-
</div>
|
|
1142
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1143
|
-
<strong>type</strong>: <a href="#tokentype">TokenType</a>
|
|
1144
|
-
<div class="padding-left--md">
|
|
1145
|
-
|
|
1146
|
-
</div>
|
|
1147
|
-
|
|
1148
|
-
</div>
|
|
1149
|
-
|
|
1150
|
-
</div>
|
|
1151
|
-
|
|
1152
|
-
### ErrorEnvelope
|
|
1153
|
-
|
|
1154
|
-
<div class="padding-left--md">
|
|
1155
|
-
|
|
1156
|
-
An 'envelope' error object that has the mandatory error object.
|
|
1157
|
-
|
|
1158
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1159
|
-
<strong>error</strong>: <a href="#errorresponse">ErrorResponse</a>
|
|
1160
|
-
<div class="padding-left--md">
|
|
1161
|
-
|
|
1162
|
-
</div>
|
|
1163
|
-
|
|
1164
|
-
</div>
|
|
1165
|
-
|
|
1166
|
-
</div>
|
|
1167
|
-
|
|
1168
|
-
### ErrorResponse
|
|
1169
|
-
|
|
1170
|
-
<div class="padding-left--md">
|
|
1171
|
-
|
|
1172
|
-
The response for error state
|
|
1173
|
-
|
|
1174
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1175
|
-
<strong>code</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1176
|
-
<div class="padding-left--md">
|
|
1177
|
-
|
|
1178
|
-
Error code, which normally matches the HTTP error code.
|
|
1179
|
-
|
|
1180
|
-
</div>
|
|
1181
|
-
|
|
1182
|
-
</div>
|
|
1183
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1184
|
-
<strong>details</strong>: <a href="#errorresponsedetails">ErrorResponseDetails</a>
|
|
1185
|
-
<div class="padding-left--md">
|
|
1186
|
-
|
|
1187
|
-
</div>
|
|
1188
|
-
|
|
1189
|
-
</div>
|
|
1190
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1191
|
-
<strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1192
|
-
<div class="padding-left--md">
|
|
1193
|
-
|
|
1194
|
-
A short, clear error message without details
|
|
1195
|
-
|
|
1196
|
-
</div>
|
|
1197
|
-
|
|
1198
|
-
</div>
|
|
1199
|
-
|
|
1200
|
-
</div>
|
|
1201
|
-
|
|
1202
|
-
### ErrorResponseDetails
|
|
1203
|
-
|
|
1204
|
-
<div class="padding-left--md">
|
|
1205
|
-
|
|
1206
|
-
Detailed information about the error.
|
|
1207
|
-
|
|
1208
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1209
|
-
<strong>arguments</strong>: Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
1210
|
-
<div class="padding-left--md">
|
|
1211
|
-
|
|
1212
|
-
The arguments for the message format.
|
|
1213
|
-
|
|
1214
|
-
</div>
|
|
1215
|
-
|
|
1216
|
-
</div>
|
|
1217
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1218
|
-
<strong>errorMessage</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1219
|
-
<div class="padding-left--md">
|
|
1220
|
-
|
|
1221
|
-
Complete error message.
|
|
1222
|
-
|
|
1223
|
-
</div>
|
|
1224
|
-
|
|
1225
|
-
</div>
|
|
1226
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1227
|
-
<strong>errorMessageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1228
|
-
<div class="padding-left--md">
|
|
1229
|
-
|
|
1230
|
-
The message format of the error message, string.format based.
|
|
1231
|
-
|
|
1232
|
-
</div>
|
|
1233
|
-
|
|
1234
|
-
</div>
|
|
1235
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1236
|
-
<strong>errorMessageFormatSpecifierTypes</strong>: Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
1237
|
-
<div class="padding-left--md">
|
|
1238
|
-
|
|
1239
|
-
The corresponding DQL format specifier types for each format specifier used in the error message format.
|
|
1240
|
-
|
|
1241
|
-
</div>
|
|
1242
|
-
|
|
1243
|
-
</div>
|
|
1244
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1245
|
-
<strong>errorType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1246
|
-
<div class="padding-left--md">
|
|
1247
|
-
|
|
1248
|
-
The error type, e.g. COMMAND_NAME_MISSING
|
|
1249
|
-
|
|
1250
|
-
</div>
|
|
1251
|
-
|
|
1252
|
-
</div>
|
|
1253
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1254
|
-
<strong>exceptionType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1255
|
-
<div class="padding-left--md">
|
|
1256
|
-
|
|
1257
|
-
The exception type.
|
|
1258
|
-
|
|
1259
|
-
</div>
|
|
1260
|
-
|
|
1261
|
-
</div>
|
|
1262
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1263
|
-
<strong>queryString</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1264
|
-
<div class="padding-left--md">
|
|
1265
|
-
|
|
1266
|
-
Submitted query string.
|
|
1267
|
-
|
|
1268
|
-
</div>
|
|
1269
|
-
|
|
1270
|
-
</div>
|
|
1271
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1272
|
-
<strong>syntaxErrorPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1273
|
-
<div class="padding-left--md">
|
|
1274
|
-
|
|
1275
|
-
</div>
|
|
1276
|
-
|
|
1277
|
-
</div>
|
|
1278
|
-
|
|
1279
|
-
</div>
|
|
1280
|
-
|
|
1281
|
-
### ExecuteRequest
|
|
1282
|
-
|
|
1283
|
-
<div class="padding-left--md">
|
|
1284
|
-
|
|
1285
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1286
|
-
<strong>defaultSamplingRatio</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1287
|
-
<div class="padding-left--md">
|
|
1288
|
-
|
|
1289
|
-
In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries.
|
|
1290
|
-
|
|
1291
|
-
</div>
|
|
1292
|
-
|
|
1293
|
-
</div>
|
|
1294
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1295
|
-
<strong>defaultScanLimitGbytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1296
|
-
<div class="padding-left--md">
|
|
1297
|
-
|
|
1298
|
-
Limit in gigabytes for the amount data that will be scanned during read.
|
|
1299
|
-
|
|
1300
|
-
</div>
|
|
1301
|
-
|
|
1302
|
-
</div>
|
|
1303
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1304
|
-
<strong>defaultTimeframeEnd</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1305
|
-
<div class="padding-left--md">
|
|
1306
|
-
|
|
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._
|
|
1308
|
-
|
|
1309
|
-
</div>
|
|
1310
|
-
|
|
1311
|
-
</div>
|
|
1312
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1313
|
-
<strong>defaultTimeframeStart</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1314
|
-
<div class="padding-left--md">
|
|
1315
|
-
|
|
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._
|
|
1317
|
-
|
|
1318
|
-
</div>
|
|
1319
|
-
|
|
1320
|
-
</div>
|
|
1321
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1322
|
-
<strong>enablePreview</strong>: boolean
|
|
1323
|
-
<div class="padding-left--md">
|
|
1324
|
-
|
|
1325
|
-
Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response.
|
|
1326
|
-
|
|
1327
|
-
</div>
|
|
1328
|
-
|
|
1329
|
-
</div>
|
|
1330
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1331
|
-
<strong>fetchTimeoutSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1332
|
-
<div class="padding-left--md">
|
|
1333
|
-
|
|
1334
|
-
The query will stop after reaching the fetch-timeout.
|
|
1335
|
-
|
|
1336
|
-
</div>
|
|
1337
|
-
|
|
1338
|
-
</div>
|
|
1339
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1340
|
-
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1341
|
-
<div class="padding-left--md">
|
|
1342
|
-
|
|
1343
|
-
The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
|
|
1344
|
-
|
|
1345
|
-
</div>
|
|
1346
|
-
|
|
1347
|
-
</div>
|
|
1348
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1349
|
-
<strong>maxResultRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1350
|
-
<div class="padding-left--md">
|
|
1351
|
-
|
|
1352
|
-
The maximum number of result records that this query will return.
|
|
1353
|
-
|
|
1354
|
-
</div>
|
|
1355
|
-
|
|
1356
|
-
</div>
|
|
1357
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1358
|
-
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1359
|
-
<div class="padding-left--md">
|
|
1360
|
-
|
|
1361
|
-
The full query string.
|
|
1362
|
-
|
|
1363
|
-
</div>
|
|
1364
|
-
|
|
1365
|
-
</div>
|
|
1366
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1367
|
-
<strong>requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1368
|
-
<div class="padding-left--md">
|
|
1369
|
-
|
|
1370
|
-
The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result.
|
|
1371
|
-
|
|
1372
|
-
</div>
|
|
1373
|
-
|
|
1374
|
-
</div>
|
|
1375
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1376
|
-
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1377
|
-
<div class="padding-left--md">
|
|
1378
|
-
|
|
1379
|
-
The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
|
|
1380
|
-
|
|
1381
|
-
</div>
|
|
1382
|
-
|
|
1383
|
-
</div>
|
|
1384
|
-
|
|
1385
|
-
</div>
|
|
1386
|
-
|
|
1387
|
-
### FieldType
|
|
1388
|
-
|
|
1389
|
-
<div class="padding-left--md">
|
|
1390
|
-
|
|
1391
|
-
The possible type of a field in DQL.
|
|
1392
|
-
|
|
1393
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1394
|
-
<strong>type</strong>: <a href="#fieldtypetype">FieldTypeType</a>
|
|
1395
|
-
<div class="padding-left--md">
|
|
1396
|
-
|
|
1397
|
-
</div>
|
|
1398
|
-
|
|
1399
|
-
</div>
|
|
1400
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1401
|
-
<strong>types</strong>: Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>>
|
|
1402
|
-
<div class="padding-left--md">
|
|
1403
|
-
|
|
1404
|
-
</div>
|
|
1405
|
-
|
|
1406
|
-
</div>
|
|
1407
|
-
|
|
1408
|
-
</div>
|
|
1409
|
-
|
|
1410
|
-
### GeoPoint
|
|
1411
|
-
|
|
1412
|
-
<div class="padding-left--md">
|
|
1413
|
-
|
|
1414
|
-
DQL data type representing a geolocation point.
|
|
1415
|
-
|
|
1416
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1417
|
-
<strong>latitude</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1418
|
-
<div class="padding-left--md">
|
|
1419
|
-
|
|
1420
|
-
The coordinate that specifies the north–south position of a point on the surface of the earth.
|
|
1421
|
-
|
|
1422
|
-
</div>
|
|
1423
|
-
|
|
1424
|
-
</div>
|
|
1425
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1426
|
-
<strong>longitude</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1427
|
-
<div class="padding-left--md">
|
|
1428
|
-
|
|
1429
|
-
The coordinate that specifies the east–west position of a point on the surface of the earth.
|
|
1430
|
-
|
|
1431
|
-
</div>
|
|
1432
|
-
|
|
1433
|
-
</div>
|
|
1434
|
-
|
|
1435
|
-
</div>
|
|
1436
|
-
|
|
1437
|
-
### GrailMetadata
|
|
1438
|
-
|
|
1439
|
-
<div class="padding-left--md">
|
|
1440
|
-
|
|
1441
|
-
Collects various bits of metadata information.
|
|
1442
|
-
|
|
1443
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1444
|
-
<strong>analysisTimeframe</strong>: <a href="#timeframe">Timeframe</a>
|
|
1445
|
-
<div class="padding-left--md">
|
|
1446
|
-
|
|
1447
|
-
</div>
|
|
1448
|
-
|
|
1449
|
-
</div>
|
|
1450
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1451
|
-
<strong>canonicalQuery</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1452
|
-
<div class="padding-left--md">
|
|
1453
|
-
|
|
1454
|
-
The canonical form of the query. It has normalized spaces and canonical constructs.
|
|
1455
|
-
|
|
1456
|
-
</div>
|
|
1457
|
-
|
|
1458
|
-
</div>
|
|
1459
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1460
|
-
<strong>dqlVersion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1461
|
-
<div class="padding-left--md">
|
|
1462
|
-
|
|
1463
|
-
The version of DQL that was used to process the query request.
|
|
1464
|
-
|
|
1465
|
-
</div>
|
|
1466
|
-
|
|
1467
|
-
</div>
|
|
1468
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1469
|
-
<strong>executionTimeMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1470
|
-
<div class="padding-left--md">
|
|
1471
|
-
|
|
1472
|
-
The time it took to execute the query.
|
|
1473
|
-
|
|
1474
|
-
</div>
|
|
1475
|
-
|
|
1476
|
-
</div>
|
|
1477
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1478
|
-
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1479
|
-
<div class="padding-left--md">
|
|
1480
|
-
|
|
1481
|
-
Effective locale for the query.
|
|
1482
|
-
|
|
1483
|
-
</div>
|
|
1484
|
-
|
|
1485
|
-
</div>
|
|
1486
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1487
|
-
<strong>notifications</strong>: Array<<a href="#metadatanotification">MetadataNotification</a>>
|
|
1488
|
-
<div class="padding-left--md">
|
|
1489
|
-
|
|
1490
|
-
Collected messages during the execution of the query.
|
|
1491
|
-
|
|
1492
|
-
</div>
|
|
1493
|
-
|
|
1494
|
-
</div>
|
|
1495
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1496
|
-
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1497
|
-
<div class="padding-left--md">
|
|
1498
|
-
|
|
1499
|
-
The submitted query.
|
|
1500
|
-
|
|
1501
|
-
</div>
|
|
1502
|
-
|
|
1503
|
-
</div>
|
|
1504
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1505
|
-
<strong>queryId</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1506
|
-
<div class="padding-left--md">
|
|
1507
|
-
|
|
1508
|
-
The id of the query
|
|
1509
|
-
|
|
1510
|
-
</div>
|
|
1511
|
-
|
|
1512
|
-
</div>
|
|
1513
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1514
|
-
<strong>sampled</strong>: boolean
|
|
1515
|
-
<div class="padding-left--md">
|
|
1516
|
-
|
|
1517
|
-
True if sampling was used for at least one segment.
|
|
1518
|
-
|
|
1519
|
-
</div>
|
|
1520
|
-
|
|
1521
|
-
</div>
|
|
1522
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1523
|
-
<strong>scannedBytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1524
|
-
<div class="padding-left--md">
|
|
1525
|
-
|
|
1526
|
-
Number of scanned bytes during the query execution.
|
|
1527
|
-
|
|
1528
|
-
</div>
|
|
1529
|
-
|
|
1530
|
-
</div>
|
|
1531
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1532
|
-
<strong>scannedRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1533
|
-
<div class="padding-left--md">
|
|
1534
|
-
|
|
1535
|
-
Number of scanned records during the query execution.
|
|
1536
|
-
|
|
1537
|
-
</div>
|
|
1538
|
-
|
|
1539
|
-
</div>
|
|
1540
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1541
|
-
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1542
|
-
<div class="padding-left--md">
|
|
1543
|
-
|
|
1544
|
-
Effective timezone for the query.
|
|
1545
|
-
|
|
1546
|
-
</div>
|
|
1547
|
-
|
|
1548
|
-
</div>
|
|
1549
|
-
|
|
1550
|
-
</div>
|
|
1551
|
-
|
|
1552
|
-
### Metadata
|
|
1553
|
-
|
|
1554
|
-
<div class="padding-left--md">
|
|
1555
|
-
|
|
1556
|
-
Collects various bits of metadata information.
|
|
1557
|
-
|
|
1558
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1559
|
-
<strong>grail</strong>: <a href="#grailmetadata">GrailMetadata</a>
|
|
1560
|
-
<div class="padding-left--md">
|
|
1561
|
-
|
|
1562
|
-
</div>
|
|
1563
|
-
|
|
1564
|
-
</div>
|
|
1565
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1566
|
-
<strong>metrics</strong>: Array<<a href="#metricmetadata">MetricMetadata</a>>
|
|
1567
|
-
<div class="padding-left--md">
|
|
1568
|
-
|
|
1569
|
-
</div>
|
|
1570
|
-
|
|
1571
|
-
</div>
|
|
1572
|
-
|
|
1573
|
-
</div>
|
|
1574
|
-
|
|
1575
|
-
### MetadataNotification
|
|
1576
|
-
|
|
1577
|
-
<div class="padding-left--md">
|
|
1578
|
-
|
|
1579
|
-
The message that provides additional information about the execution of the query.
|
|
1580
|
-
|
|
1581
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1582
|
-
<strong>arguments</strong>: Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
1583
|
-
<div class="padding-left--md">
|
|
1584
|
-
|
|
1585
|
-
The arguments for the message format.
|
|
1586
|
-
|
|
1587
|
-
</div>
|
|
1588
|
-
|
|
1589
|
-
</div>
|
|
1590
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1591
|
-
<strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1592
|
-
<div class="padding-left--md">
|
|
1593
|
-
|
|
1594
|
-
The complete message of the notification.
|
|
1595
|
-
|
|
1596
|
-
</div>
|
|
1597
|
-
|
|
1598
|
-
</div>
|
|
1599
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1600
|
-
<strong>messageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1601
|
-
<div class="padding-left--md">
|
|
1602
|
-
|
|
1603
|
-
The message format of the notification, string.format based
|
|
1604
|
-
|
|
1605
|
-
</div>
|
|
1606
|
-
|
|
1607
|
-
</div>
|
|
1608
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1609
|
-
<strong>messageFormatSpecifierTypes</strong>: Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
1610
|
-
<div class="padding-left--md">
|
|
1611
|
-
|
|
1612
|
-
The corresponding DQL format specifier types for each format specifier used in the error message format.
|
|
1613
|
-
|
|
1614
|
-
</div>
|
|
1615
|
-
|
|
1616
|
-
</div>
|
|
1617
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1618
|
-
<strong>notificationType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1619
|
-
<div class="padding-left--md">
|
|
1620
|
-
|
|
1621
|
-
The notification type, e.g. LIMIT_ADDED.
|
|
1622
|
-
|
|
1623
|
-
</div>
|
|
1624
|
-
|
|
1625
|
-
</div>
|
|
1626
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1627
|
-
<strong>severity</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1628
|
-
<div class="padding-left--md">
|
|
1629
|
-
|
|
1630
|
-
The severity of the notification, currently: INFO, WARN, ERROR.
|
|
1631
|
-
|
|
1632
|
-
</div>
|
|
1633
|
-
|
|
1634
|
-
</div>
|
|
1635
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1636
|
-
<strong>syntaxPosition</strong>: <a href="#tokenposition">TokenPosition</a>
|
|
1637
|
-
<div class="padding-left--md">
|
|
1638
|
-
|
|
1639
|
-
</div>
|
|
1640
|
-
|
|
1641
|
-
</div>
|
|
1642
|
-
|
|
1643
|
-
</div>
|
|
1644
|
-
|
|
1645
|
-
### MetricMetadata
|
|
1646
|
-
|
|
1647
|
-
<div class="padding-left--md">
|
|
1648
|
-
|
|
1649
|
-
An object that defines additional metric metadata.
|
|
1650
|
-
|
|
1651
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1652
|
-
<strong>description</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1653
|
-
<div class="padding-left--md">
|
|
1654
|
-
|
|
1655
|
-
The description of the metadata.
|
|
1656
|
-
|
|
1657
|
-
</div>
|
|
1658
|
-
|
|
1659
|
-
</div>
|
|
1660
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1661
|
-
<strong>displayName</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1662
|
-
<div class="padding-left--md">
|
|
1663
|
-
|
|
1664
|
-
The display name of the metadata.
|
|
1665
|
-
|
|
1666
|
-
</div>
|
|
1667
|
-
|
|
1668
|
-
</div>
|
|
1669
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1670
|
-
<strong>metric.key</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1671
|
-
<div class="padding-left--md">
|
|
1672
|
-
|
|
1673
|
-
The metric key.
|
|
1674
|
-
|
|
1675
|
-
</div>
|
|
1676
|
-
|
|
1677
|
-
</div>
|
|
1678
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1679
|
-
<strong>unit</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1680
|
-
<div class="padding-left--md">
|
|
1681
|
-
|
|
1682
|
-
The unit used.
|
|
1683
|
-
|
|
1684
|
-
</div>
|
|
1685
|
-
|
|
1686
|
-
</div>
|
|
1687
|
-
|
|
1688
|
-
</div>
|
|
1689
|
-
|
|
1690
|
-
### ParseRequest
|
|
1691
|
-
|
|
1692
|
-
<div class="padding-left--md">
|
|
1693
|
-
|
|
1694
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1695
|
-
<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1696
|
-
<div class="padding-left--md">
|
|
1697
|
-
|
|
1698
|
-
The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
|
|
1699
|
-
|
|
1700
|
-
</div>
|
|
1701
|
-
|
|
1702
|
-
</div>
|
|
1703
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1704
|
-
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1705
|
-
<div class="padding-left--md">
|
|
1706
|
-
|
|
1707
|
-
The full query string.
|
|
1708
|
-
|
|
1709
|
-
</div>
|
|
1710
|
-
|
|
1711
|
-
</div>
|
|
1712
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1713
|
-
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1714
|
-
<div class="padding-left--md">
|
|
1715
|
-
|
|
1716
|
-
The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
|
|
1717
|
-
|
|
1718
|
-
</div>
|
|
1719
|
-
|
|
1720
|
-
</div>
|
|
1721
|
-
|
|
1722
|
-
</div>
|
|
1723
|
-
|
|
1724
|
-
### PositionInfo
|
|
1725
|
-
|
|
1726
|
-
<div class="padding-left--md">
|
|
1727
|
-
|
|
1728
|
-
The exact position in the query string.
|
|
1729
|
-
|
|
1730
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1731
|
-
<strong>column</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1732
|
-
<div class="padding-left--md">
|
|
1733
|
-
|
|
1734
|
-
Query position column zero based index.
|
|
1735
|
-
|
|
1736
|
-
</div>
|
|
1737
|
-
|
|
1738
|
-
</div>
|
|
1739
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1740
|
-
<strong>index</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1741
|
-
<div class="padding-left--md">
|
|
1742
|
-
|
|
1743
|
-
Query position index.
|
|
1744
|
-
|
|
1745
|
-
</div>
|
|
1746
|
-
|
|
1747
|
-
</div>
|
|
1748
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1749
|
-
<strong>line</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1750
|
-
<div class="padding-left--md">
|
|
1751
|
-
|
|
1752
|
-
Query position line zero based index.
|
|
1753
|
-
|
|
1754
|
-
</div>
|
|
1755
|
-
|
|
1756
|
-
</div>
|
|
1757
|
-
|
|
1758
|
-
</div>
|
|
1759
|
-
|
|
1760
|
-
### QueryPollResponse
|
|
1761
|
-
|
|
1762
|
-
<div class="padding-left--md">
|
|
1763
|
-
|
|
1764
|
-
The response of GET query:execute call.
|
|
1765
|
-
|
|
1766
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1767
|
-
<strong>progress</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1768
|
-
<div class="padding-left--md">
|
|
1769
|
-
|
|
1770
|
-
The progress of the query from 0 to 100.
|
|
1771
|
-
|
|
1772
|
-
</div>
|
|
1773
|
-
|
|
1774
|
-
</div>
|
|
1775
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1776
|
-
<strong>result</strong>: <a href="#queryresult">QueryResult</a>
|
|
1777
|
-
<div class="padding-left--md">
|
|
1778
|
-
|
|
1779
|
-
</div>
|
|
1780
|
-
|
|
1781
|
-
</div>
|
|
1782
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1783
|
-
<strong>state</strong>: <a href="#querystate">QueryState</a>
|
|
1784
|
-
<div class="padding-left--md">
|
|
1785
|
-
|
|
1786
|
-
</div>
|
|
1787
|
-
|
|
1788
|
-
</div>
|
|
1789
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1790
|
-
<strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1791
|
-
<div class="padding-left--md">
|
|
1792
|
-
|
|
1793
|
-
Time to live in seconds.
|
|
1794
|
-
|
|
1795
|
-
</div>
|
|
1796
|
-
|
|
1797
|
-
</div>
|
|
1798
|
-
|
|
1799
|
-
</div>
|
|
1800
|
-
|
|
1801
|
-
### QueryResult
|
|
1802
|
-
|
|
1803
|
-
<div class="padding-left--md">
|
|
1804
|
-
|
|
1805
|
-
The result of the DQL query.
|
|
1806
|
-
|
|
1807
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1808
|
-
<strong>metadata</strong>: <a href="#metadata">Metadata</a>
|
|
1809
|
-
<div class="padding-left--md">
|
|
1810
|
-
|
|
1811
|
-
</div>
|
|
1812
|
-
|
|
1813
|
-
</div>
|
|
1814
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1815
|
-
<strong>records</strong>: Array<null | <a href="#resultrecord">ResultRecord</a>>
|
|
1816
|
-
<div class="padding-left--md">
|
|
1817
|
-
|
|
1818
|
-
List of records containing the result fields data.
|
|
1819
|
-
|
|
1820
|
-
</div>
|
|
1821
|
-
|
|
1822
|
-
</div>
|
|
1823
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1824
|
-
<strong>types</strong>: Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>>
|
|
1825
|
-
<div class="padding-left--md">
|
|
1826
|
-
|
|
1827
|
-
The data types for the result records.
|
|
1828
|
-
|
|
1829
|
-
</div>
|
|
1830
|
-
|
|
1831
|
-
</div>
|
|
1832
|
-
|
|
1833
|
-
</div>
|
|
1834
|
-
|
|
1835
|
-
### QueryStartResponse
|
|
1836
|
-
|
|
1837
|
-
<div class="padding-left--md">
|
|
1838
|
-
|
|
1839
|
-
The response when starting a query.
|
|
1840
|
-
|
|
1841
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1842
|
-
<strong>progress</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1843
|
-
<div class="padding-left--md">
|
|
1844
|
-
|
|
1845
|
-
The progress of the query from 0 to 100.
|
|
1846
|
-
|
|
1847
|
-
</div>
|
|
1848
|
-
|
|
1849
|
-
</div>
|
|
1850
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1851
|
-
<strong>requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1852
|
-
<div class="padding-left--md">
|
|
1853
|
-
|
|
1854
|
-
The token returned by the POST query:execute call.
|
|
1855
|
-
|
|
1856
|
-
</div>
|
|
1857
|
-
|
|
1858
|
-
</div>
|
|
1859
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1860
|
-
<strong>result</strong>: <a href="#queryresult">QueryResult</a>
|
|
1861
|
-
<div class="padding-left--md">
|
|
1862
|
-
|
|
1863
|
-
</div>
|
|
1864
|
-
|
|
1865
|
-
</div>
|
|
1866
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1867
|
-
<strong>state</strong>: <a href="#querystate">QueryState</a>
|
|
1868
|
-
<div class="padding-left--md">
|
|
1869
|
-
|
|
1870
|
-
</div>
|
|
1871
|
-
|
|
1872
|
-
</div>
|
|
1873
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1874
|
-
<strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
1875
|
-
<div class="padding-left--md">
|
|
1876
|
-
|
|
1877
|
-
Time to live in seconds.
|
|
1878
|
-
|
|
1879
|
-
</div>
|
|
1880
|
-
|
|
1881
|
-
</div>
|
|
1882
|
-
|
|
1883
|
-
</div>
|
|
881
|
+
| Name | Type | Description |
|
|
882
|
+
| -------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------- |
|
|
883
|
+
| progress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The progress of the query from 0 to 100. |
|
|
884
|
+
| requestToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The token returned by the POST query:execute call. |
|
|
885
|
+
| result | <a href="#queryresult">QueryResult</a> | |
|
|
886
|
+
| state<sup>\*required</sup> | <a href="#querystate">QueryState</a> | |
|
|
887
|
+
| ttlSeconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Time to live in seconds. |
|
|
1884
888
|
|
|
1885
889
|
### RangedFieldTypes
|
|
1886
890
|
|
|
1887
|
-
<div class="padding-left--md">
|
|
1888
|
-
|
|
1889
891
|
The field type in range.
|
|
1890
892
|
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
The range of elements at use this type in arrays (null for records).
|
|
1896
|
-
|
|
1897
|
-
</div>
|
|
1898
|
-
|
|
1899
|
-
</div>
|
|
1900
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1901
|
-
<strong>mappings</strong>: <a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a>
|
|
1902
|
-
<div class="padding-left--md">
|
|
1903
|
-
|
|
1904
|
-
</div>
|
|
1905
|
-
|
|
1906
|
-
</div>
|
|
1907
|
-
|
|
1908
|
-
</div>
|
|
893
|
+
| Name | Type | Description |
|
|
894
|
+
| ----------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- |
|
|
895
|
+
| indexRange | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>> | The range of elements at use this type in arrays (null for records). |
|
|
896
|
+
| mappings<sup>\*required</sup> | <a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a> | |
|
|
1909
897
|
|
|
1910
898
|
### RangedFieldTypesMappings
|
|
1911
899
|
|
|
1912
|
-
<div class="padding-left--md">
|
|
1913
|
-
|
|
1914
900
|
The mapping between the field name and data type.
|
|
1915
901
|
|
|
1916
|
-
</div>
|
|
1917
|
-
|
|
1918
902
|
### ResultRecord
|
|
1919
903
|
|
|
1920
|
-
<div class="padding-left--md">
|
|
1921
|
-
|
|
1922
904
|
Single record that contains the result fields.
|
|
1923
905
|
|
|
1924
|
-
</div>
|
|
1925
|
-
|
|
1926
906
|
### Timeframe
|
|
1927
907
|
|
|
1928
|
-
<div class="padding-left--md">
|
|
1929
|
-
|
|
1930
908
|
DQL data type timeframe.
|
|
1931
909
|
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
<
|
|
1935
|
-
|
|
1936
|
-
The end time of the timeframe.
|
|
1937
|
-
|
|
1938
|
-
</div>
|
|
1939
|
-
|
|
1940
|
-
</div>
|
|
1941
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1942
|
-
<strong>start</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>
|
|
1943
|
-
<div class="padding-left--md">
|
|
1944
|
-
|
|
1945
|
-
The start time of the timeframe.
|
|
1946
|
-
|
|
1947
|
-
</div>
|
|
1948
|
-
|
|
1949
|
-
</div>
|
|
1950
|
-
|
|
1951
|
-
</div>
|
|
910
|
+
| Name | Type | Description |
|
|
911
|
+
| ----- | -------------------------------------------------------------------------------------------------------- | -------------------------------- |
|
|
912
|
+
| end | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a> | The end time of the timeframe. |
|
|
913
|
+
| start | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a> | The start time of the timeframe. |
|
|
1952
914
|
|
|
1953
915
|
### TokenPosition
|
|
1954
916
|
|
|
1955
|
-
<div class="padding-left--md">
|
|
1956
|
-
|
|
1957
917
|
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.
|
|
1958
918
|
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
|
-
<
|
|
1962
|
-
|
|
1963
|
-
</div>
|
|
1964
|
-
|
|
1965
|
-
</div>
|
|
1966
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1967
|
-
<strong>start</strong>: <a href="#positioninfo">PositionInfo</a>
|
|
1968
|
-
<div class="padding-left--md">
|
|
1969
|
-
|
|
1970
|
-
</div>
|
|
1971
|
-
|
|
1972
|
-
</div>
|
|
1973
|
-
|
|
1974
|
-
</div>
|
|
919
|
+
| Name | Type |
|
|
920
|
+
| -------------------------- | ---------------------------------------- |
|
|
921
|
+
| end<sup>\*required</sup> | <a href="#positioninfo">PositionInfo</a> |
|
|
922
|
+
| start<sup>\*required</sup> | <a href="#positioninfo">PositionInfo</a> |
|
|
1975
923
|
|
|
1976
924
|
### VerifyRequest
|
|
1977
925
|
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
<
|
|
1981
|
-
<
|
|
1982
|
-
<
|
|
1983
|
-
|
|
1984
|
-
The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
|
|
1985
|
-
|
|
1986
|
-
</div>
|
|
1987
|
-
|
|
1988
|
-
</div>
|
|
1989
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1990
|
-
<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
1991
|
-
<div class="padding-left--md">
|
|
1992
|
-
|
|
1993
|
-
The full query string.
|
|
1994
|
-
|
|
1995
|
-
</div>
|
|
1996
|
-
|
|
1997
|
-
</div>
|
|
1998
|
-
<div class="padding-left--md padding-bottom--md">
|
|
1999
|
-
<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
2000
|
-
<div class="padding-left--md">
|
|
2001
|
-
|
|
2002
|
-
The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
|
|
2003
|
-
|
|
2004
|
-
</div>
|
|
2005
|
-
|
|
2006
|
-
</div>
|
|
2007
|
-
|
|
2008
|
-
</div>
|
|
926
|
+
| Name | Type | Description |
|
|
927
|
+
| -------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
928
|
+
| locale | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
|
|
929
|
+
| query<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The full query string. |
|
|
930
|
+
| timezone | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
|
|
2009
931
|
|
|
2010
932
|
### VerifyResponse
|
|
2011
933
|
|
|
2012
|
-
<div class="padding-left--md">
|
|
2013
|
-
|
|
2014
934
|
Verify response.
|
|
2015
935
|
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
The notifications related to the supplied DQL query string.
|
|
2021
|
-
|
|
2022
|
-
</div>
|
|
2023
|
-
|
|
2024
|
-
</div>
|
|
2025
|
-
<div class="padding-left--md padding-bottom--md">
|
|
2026
|
-
<strong>valid</strong>: boolean
|
|
2027
|
-
<div class="padding-left--md">
|
|
2028
|
-
|
|
2029
|
-
True if the supplied DQL query string is valid.
|
|
2030
|
-
|
|
2031
|
-
</div>
|
|
2032
|
-
|
|
2033
|
-
</div>
|
|
2034
|
-
|
|
2035
|
-
</div>
|
|
936
|
+
| Name | Type | Description |
|
|
937
|
+
| -------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------- |
|
|
938
|
+
| notifications | Array<<a href="#metadatanotification">MetadataNotification</a>> | The notifications related to the supplied DQL query string. |
|
|
939
|
+
| valid<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | True if the supplied DQL query string is valid. |
|
|
2036
940
|
|
|
2037
941
|
## Enums
|
|
2038
942
|
|