@dynatrace-sdk/client-query 1.11.0 → 1.11.1
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 +6 -0
- package/README.md +50 -46
- package/cjs/index.js +441 -2
- package/docs/DOCS.md +7 -7
- package/esm/index.js +441 -2
- package/package.json +1 -1
- package/types/packages/client/query/src/lib/models/dql-node-node-type.transformation.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/field-type-type.transformation.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/query-state.transformation.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/result-record-value.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/result-record-value.transformation.d.ts +1 -1
- package/types/packages/client/query/src/lib/models/token-type.transformation.d.ts +1 -1
- package/types/packages/client/query/src/lib/utils/url-helpers.d.ts +1 -1
- package/types/packages/http-client/src/lib/platform/abort-controller.d.ts +1 -1
- package/types/packages/http-client/src/lib/platform/abort-signal.d.ts +1 -1
- package/types/packages/http-client/src/lib/platform/decode-form-data.d.ts +48 -0
- package/types/packages/http-client/src/lib/platform/http-client.d.ts +8 -0
- package/types/packages/http-client/src/lib/types/data-types.d.ts +1 -1
- package/types/packages/http-client/src/lib/types/form-data-request-body.d.ts +2 -2
- package/types/packages/http-client/src/lib/types/form-data-response-body.d.ts +2 -2
- package/types/packages/http-client/src/lib/types/request-body-types.d.ts +1 -1
- package/types/packages/http-client/src/lib/types/response-body-types.d.ts +1 -1
- package/types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts +1 -1
- package/types/packages/platform/error-handlers/src/lib/types/global-error-serializer.d.ts +1 -1
- package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-query
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.11.1)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
Exposes an API to fetch records stored in Grail
|
|
@@ -35,10 +35,11 @@ import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
|
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
<a name="queryautocomplete"></a>
|
|
38
39
|
### queryAutocomplete
|
|
39
40
|
|
|
40
41
|
<div class="padding-bottom--md">
|
|
41
|
-
<strong>queryAssistanceClient.queryAutocomplete(config): Promise<
|
|
42
|
+
<strong>queryAssistanceClient.queryAutocomplete(config): Promise<<a href="#autocompleteresponse">AutocompleteResponse</a>></strong>
|
|
42
43
|
|
|
43
44
|
<div class="padding-left--md">
|
|
44
45
|
|
|
@@ -89,7 +90,7 @@ a link to docs, etc.
|
|
|
89
90
|
|
|
90
91
|
| Name | Type |
|
|
91
92
|
| --- | --- |
|
|
92
|
-
|config.body<sup>*required</sup
|
|
93
|
+
|config.body<sup>*required</sup>|<a href="#autocompleterequest" target="_blank" rel="noopener noreferrer">AutocompleteRequest</a>|
|
|
93
94
|
|
|
94
95
|
|
|
95
96
|
|
|
@@ -102,7 +103,6 @@ A list of structured autocomplete suggestions.
|
|
|
102
103
|
<details>
|
|
103
104
|
<summary>
|
|
104
105
|
Code example
|
|
105
|
-
|
|
106
106
|
</summary>
|
|
107
107
|
|
|
108
108
|
```ts
|
|
@@ -123,10 +123,11 @@ const data = await queryAssistanceClient.queryAutocomplete({
|
|
|
123
123
|
</div>
|
|
124
124
|
|
|
125
125
|
|
|
126
|
+
<a name="queryparse"></a>
|
|
126
127
|
### queryParse
|
|
127
128
|
|
|
128
129
|
<div class="padding-bottom--md">
|
|
129
|
-
<strong>queryAssistanceClient.queryParse(config): Promise<
|
|
130
|
+
<strong>queryAssistanceClient.queryParse(config): Promise<<a href="#dqlnode">DQLNode</a>></strong>
|
|
130
131
|
|
|
131
132
|
<div class="padding-left--md">
|
|
132
133
|
|
|
@@ -333,7 +334,7 @@ When displaying the query, pick one option. You may use the other options for ho
|
|
|
333
334
|
|
|
334
335
|
| Name | Type |
|
|
335
336
|
| --- | --- |
|
|
336
|
-
|config.body<sup>*required</sup
|
|
337
|
+
|config.body<sup>*required</sup>|<a href="#parserequest" target="_blank" rel="noopener noreferrer">ParseRequest</a>|
|
|
337
338
|
|
|
338
339
|
|
|
339
340
|
|
|
@@ -346,7 +347,6 @@ A node containing more nodes, a node offering different (semantically equivalen
|
|
|
346
347
|
<details>
|
|
347
348
|
<summary>
|
|
348
349
|
Code example
|
|
349
|
-
|
|
350
350
|
</summary>
|
|
351
351
|
|
|
352
352
|
```ts
|
|
@@ -367,10 +367,11 @@ const data = await queryAssistanceClient.queryParse({
|
|
|
367
367
|
</div>
|
|
368
368
|
|
|
369
369
|
|
|
370
|
+
<a name="queryverify"></a>
|
|
370
371
|
### queryVerify
|
|
371
372
|
|
|
372
373
|
<div class="padding-bottom--md">
|
|
373
|
-
<strong>queryAssistanceClient.queryVerify(config): Promise<
|
|
374
|
+
<strong>queryAssistanceClient.queryVerify(config): Promise<<a href="#verifyresponse">VerifyResponse</a>></strong>
|
|
374
375
|
|
|
375
376
|
<div class="padding-left--md">
|
|
376
377
|
|
|
@@ -392,7 +393,7 @@ submitting the query for execution.
|
|
|
392
393
|
|
|
393
394
|
| Name | Type |
|
|
394
395
|
| --- | --- |
|
|
395
|
-
|config.body<sup>*required</sup
|
|
396
|
+
|config.body<sup>*required</sup>|<a href="#verifyrequest" target="_blank" rel="noopener noreferrer">VerifyRequest</a>|
|
|
396
397
|
|
|
397
398
|
|
|
398
399
|
|
|
@@ -405,7 +406,6 @@ Supplied query and parameters were verified.
|
|
|
405
406
|
<details>
|
|
406
407
|
<summary>
|
|
407
408
|
Code example
|
|
408
|
-
|
|
409
409
|
</summary>
|
|
410
410
|
|
|
411
411
|
```ts
|
|
@@ -432,10 +432,11 @@ import { queryExecutionClient } from '@dynatrace-sdk/client-query';
|
|
|
432
432
|
```
|
|
433
433
|
|
|
434
434
|
|
|
435
|
+
<a name="querycancel"></a>
|
|
435
436
|
### queryCancel
|
|
436
437
|
|
|
437
438
|
<div class="padding-bottom--md">
|
|
438
|
-
<strong>queryExecutionClient.queryCancel(config): Promise<void |
|
|
439
|
+
<strong>queryExecutionClient.queryCancel(config): Promise<void | <a href="#querypollresponse">QueryPollResponse</a>></strong>
|
|
439
440
|
|
|
440
441
|
<div class="padding-left--md">
|
|
441
442
|
|
|
@@ -499,7 +500,6 @@ The query already finished.
|
|
|
499
500
|
<details>
|
|
500
501
|
<summary>
|
|
501
502
|
Code example
|
|
502
|
-
|
|
503
503
|
</summary>
|
|
504
504
|
|
|
505
505
|
```ts
|
|
@@ -517,10 +517,11 @@ const data = await queryExecutionClient.queryCancel({
|
|
|
517
517
|
</div>
|
|
518
518
|
|
|
519
519
|
|
|
520
|
+
<a name="queryexecute"></a>
|
|
520
521
|
### queryExecute
|
|
521
522
|
|
|
522
523
|
<div class="padding-bottom--md">
|
|
523
|
-
<strong>queryExecutionClient.queryExecute(config): Promise<
|
|
524
|
+
<strong>queryExecutionClient.queryExecute(config): Promise<<a href="#querystartresponse" target="_blank" rel="noopener noreferrer">QueryStartResponse</a>></strong>
|
|
524
525
|
|
|
525
526
|
<div class="padding-left--md">
|
|
526
527
|
|
|
@@ -571,7 +572,7 @@ It is guaranteed that every field of every record will have a corresponding type
|
|
|
571
572
|
|
|
572
573
|
| Name | Type | Description |
|
|
573
574
|
| --- | --- | --- |
|
|
574
|
-
|config.body<sup>*required</sup
|
|
575
|
+
|config.body<sup>*required</sup>|<a href="#executerequest">ExecuteRequest</a>| |
|
|
575
576
|
|config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
|
|
576
577
|
|
|
577
578
|
|
|
@@ -585,7 +586,6 @@ The final status and results of the supplied query if it finished within a suppl
|
|
|
585
586
|
<details>
|
|
586
587
|
<summary>
|
|
587
588
|
Code example
|
|
588
|
-
|
|
589
589
|
</summary>
|
|
590
590
|
|
|
591
591
|
```ts
|
|
@@ -606,10 +606,11 @@ const data = await queryExecutionClient.queryExecute({
|
|
|
606
606
|
</div>
|
|
607
607
|
|
|
608
608
|
|
|
609
|
+
<a name="querypoll"></a>
|
|
609
610
|
### queryPoll
|
|
610
611
|
|
|
611
612
|
<div class="padding-bottom--md">
|
|
612
|
-
<strong>queryExecutionClient.queryPoll(config): Promise<
|
|
613
|
+
<strong>queryExecutionClient.queryPoll(config): Promise<<a href="#querypollresponse" target="_blank" rel="noopener noreferrer">QueryPollResponse</a>></strong>
|
|
613
614
|
|
|
614
615
|
<div class="padding-left--md">
|
|
615
616
|
|
|
@@ -672,7 +673,6 @@ The current status and results of the supplied query.
|
|
|
672
673
|
<details>
|
|
673
674
|
<summary>
|
|
674
675
|
Code example
|
|
675
|
-
|
|
676
676
|
</summary>
|
|
677
677
|
|
|
678
678
|
```ts
|
|
@@ -704,7 +704,7 @@ const data = await queryExecutionClient.queryPoll({
|
|
|
704
704
|
|locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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'. |
|
|
705
705
|
|maxDataSuggestions|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
706
706
|
|query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
|
|
707
|
-
|queryOptions
|
|
707
|
+
|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
|
|
708
708
|
|timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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' |
|
|
709
709
|
|
|
710
710
|
### AutocompleteResponse
|
|
@@ -718,7 +718,7 @@ The response of the autocomplete call.
|
|
|
718
718
|
| --- | --- | --- |
|
|
719
719
|
|optional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the suggestions are optional. |
|
|
720
720
|
|suggestedTtlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|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. |
|
|
721
|
-
|suggestions<sup>*required</sup>|Array<
|
|
721
|
+
|suggestions<sup>*required</sup>|Array<<a href="#autocompletesuggestion" target="_blank" rel="noopener noreferrer">AutocompleteSuggestion</a>>|The list of suggestions. |
|
|
722
722
|
|
|
723
723
|
### AutocompleteSuggestion
|
|
724
724
|
|
|
@@ -730,7 +730,7 @@ Single suggestion for completion of the query.
|
|
|
730
730
|
| Name | Type | Description |
|
|
731
731
|
| --- | --- | --- |
|
|
732
732
|
|alreadyTypedCharacters<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of characters that the user user already typed for this suggestion. |
|
|
733
|
-
|parts<sup>*required</sup>|Array<
|
|
733
|
+
|parts<sup>*required</sup>|Array<<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>>|List of suggestion parts. |
|
|
734
734
|
|suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
|
|
735
735
|
|
|
736
736
|
### AutocompleteSuggestionPart
|
|
@@ -759,7 +759,7 @@ The DQL node that has alternatives.
|
|
|
759
759
|
|alternatives|object|The different alternatives. |
|
|
760
760
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
761
761
|
|nodeType<sup>*required</sup>|DQLNodeNodeType| |
|
|
762
|
-
|tokenPosition
|
|
762
|
+
|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
|
|
763
763
|
|
|
764
764
|
### DQLContainerNode
|
|
765
765
|
|
|
@@ -770,10 +770,10 @@ The DQL node that contains other nodes.
|
|
|
770
770
|
|
|
771
771
|
| Name | Type | Description |
|
|
772
772
|
| --- | --- | --- |
|
|
773
|
-
|children|Array<
|
|
773
|
+
|children|Array<<a href="#dqlnode">DQLNode</a>>|The list of children nodes. |
|
|
774
774
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
775
775
|
|nodeType<sup>*required</sup>|DQLNodeNodeType| |
|
|
776
|
-
|tokenPosition
|
|
776
|
+
|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
|
|
777
777
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the node. |
|
|
778
778
|
|
|
779
779
|
### DQLNode
|
|
@@ -787,7 +787,7 @@ General Node in the DQL query.
|
|
|
787
787
|
| --- | --- | --- |
|
|
788
788
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
789
789
|
|nodeType<sup>*required</sup>|DQLNodeNodeType| |
|
|
790
|
-
|tokenPosition
|
|
790
|
+
|tokenPosition|<a href="#tokenposition">TokenPosition</a>| |
|
|
791
791
|
|
|
792
792
|
### DQLTerminalNode
|
|
793
793
|
|
|
@@ -802,7 +802,7 @@ Node that represents single token.
|
|
|
802
802
|
|isMandatoryOnUserOrder|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces' |
|
|
803
803
|
|isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
|
|
804
804
|
|nodeType<sup>*required</sup>|DQLNodeNodeType| |
|
|
805
|
-
|tokenPosition
|
|
805
|
+
|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
|
|
806
806
|
|type|TokenType| |
|
|
807
807
|
|
|
808
808
|
### ErrorEnvelope
|
|
@@ -814,7 +814,7 @@ An 'envelope' error object that has the mandatory error object.
|
|
|
814
814
|
|
|
815
815
|
| Name | Type |
|
|
816
816
|
| --- | --- |
|
|
817
|
-
|error<sup>*required</sup
|
|
817
|
+
|error<sup>*required</sup>|<a href="#errorresponse">ErrorResponse</a>|
|
|
818
818
|
|
|
819
819
|
### ErrorResponse
|
|
820
820
|
|
|
@@ -826,7 +826,7 @@ The response for error state
|
|
|
826
826
|
| Name | Type | Description |
|
|
827
827
|
| --- | --- | --- |
|
|
828
828
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Error code, which normally matches the HTTP error code. |
|
|
829
|
-
|details<sup>*required</sup
|
|
829
|
+
|details<sup>*required</sup>|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>| |
|
|
830
830
|
|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
|
|
831
831
|
|
|
832
832
|
### ErrorResponseDetails
|
|
@@ -846,7 +846,7 @@ Detailed information about the error.
|
|
|
846
846
|
|exceptionType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The exception type. |
|
|
847
847
|
|queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
848
848
|
|queryString<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Submitted query string. |
|
|
849
|
-
|syntaxErrorPosition
|
|
849
|
+
|syntaxErrorPosition|<a href="#tokenposition">TokenPosition</a>| |
|
|
850
850
|
|
|
851
851
|
### ExecuteRequest
|
|
852
852
|
|
|
@@ -867,7 +867,7 @@ Detailed information about the error.
|
|
|
867
867
|
|maxResultBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result bytes that this query will return. |
|
|
868
868
|
|maxResultRecords|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result records that this query will return. |
|
|
869
869
|
|query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
|
|
870
|
-
|queryOptions
|
|
870
|
+
|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
|
|
871
871
|
|requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|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. |
|
|
872
872
|
|timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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' |
|
|
873
873
|
|
|
@@ -881,7 +881,7 @@ The possible type of a field in DQL.
|
|
|
881
881
|
| Name | Type |
|
|
882
882
|
| --- | --- |
|
|
883
883
|
|type<sup>*required</sup>|FieldTypeType|
|
|
884
|
-
|types|Array<
|
|
884
|
+
|types|Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>>|
|
|
885
885
|
|
|
886
886
|
### GeoPoint
|
|
887
887
|
|
|
@@ -904,12 +904,12 @@ Collects various bits of metadata information.
|
|
|
904
904
|
|
|
905
905
|
| Name | Type | Description |
|
|
906
906
|
| --- | --- | --- |
|
|
907
|
-
|analysisTimeframe
|
|
907
|
+
|analysisTimeframe|<a href="#timeframe" target="_blank" rel="noopener noreferrer">Timeframe</a>| |
|
|
908
908
|
|canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The canonical form of the query. It has normalized spaces and canonical constructs. |
|
|
909
909
|
|dqlVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of DQL that was used to process the query request. |
|
|
910
910
|
|executionTimeMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time it took to execute the query. |
|
|
911
911
|
|locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Effective locale for the query. |
|
|
912
|
-
|notifications|Array<
|
|
912
|
+
|notifications|Array<<a href="#metadatanotification">MetadataNotification</a>>|Collected messages during the execution of the query. |
|
|
913
913
|
|query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The submitted query. |
|
|
914
914
|
|queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the query |
|
|
915
915
|
|sampled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if sampling was used for at least one segment. |
|
|
@@ -927,8 +927,8 @@ Collects various bits of metadata information.
|
|
|
927
927
|
|
|
928
928
|
| Name | Type |
|
|
929
929
|
| --- | --- |
|
|
930
|
-
|grail
|
|
931
|
-
|metrics|Array<
|
|
930
|
+
|grail|<a href="#grailmetadata" target="_blank" rel="noopener noreferrer">GrailMetadata</a>|
|
|
931
|
+
|metrics|Array<<a href="#metricmetadata">MetricMetadata</a>>|
|
|
932
932
|
|
|
933
933
|
### MetadataNotification
|
|
934
934
|
|
|
@@ -945,7 +945,7 @@ The message that provides additional information about the execution of the quer
|
|
|
945
945
|
|messageFormatSpecifierTypes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The corresponding DQL format specifier types for each format specifier used in the error message format. |
|
|
946
946
|
|notificationType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The notification type, e.g. LIMIT_ADDED. |
|
|
947
947
|
|severity|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The severity of the notification, currently: INFO, WARN, ERROR. |
|
|
948
|
-
|syntaxPosition
|
|
948
|
+
|syntaxPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
|
|
949
949
|
|
|
950
950
|
### MetricMetadata
|
|
951
951
|
|
|
@@ -976,7 +976,7 @@ An object that defines additional metric metadata.
|
|
|
976
976
|
| --- | --- | --- |
|
|
977
977
|
|locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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'. |
|
|
978
978
|
|query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
|
|
979
|
-
|queryOptions
|
|
979
|
+
|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
|
|
980
980
|
|timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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' |
|
|
981
981
|
|
|
982
982
|
### PositionInfo
|
|
@@ -1009,7 +1009,7 @@ The response of GET query:execute call.
|
|
|
1009
1009
|
| Name | Type | Description |
|
|
1010
1010
|
| --- | --- | --- |
|
|
1011
1011
|
|progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
|
|
1012
|
-
|result
|
|
1012
|
+
|result|<a href="#queryresult" target="_blank" rel="noopener noreferrer">QueryResult</a>| |
|
|
1013
1013
|
|state<sup>*required</sup>|QueryState| |
|
|
1014
1014
|
|ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
|
|
1015
1015
|
|
|
@@ -1022,9 +1022,9 @@ The result of the DQL query.
|
|
|
1022
1022
|
|
|
1023
1023
|
| Name | Type | Description |
|
|
1024
1024
|
| --- | --- | --- |
|
|
1025
|
-
|metadata<sup>*required</sup
|
|
1026
|
-
|records<sup>*required</sup>|Array<null |
|
|
1027
|
-
|types<sup>*required</sup>|Array<
|
|
1025
|
+
|metadata<sup>*required</sup>|<a href="#metadata">Metadata</a>| |
|
|
1026
|
+
|records<sup>*required</sup>|Array<null | <a href="#resultrecord" target="_blank" rel="noopener noreferrer">ResultRecord</a>>|List of records containing the result fields data. |
|
|
1027
|
+
|types<sup>*required</sup>|Array<<a href="#rangedfieldtypes">RangedFieldTypes</a>>|The data types for the result records. |
|
|
1028
1028
|
|
|
1029
1029
|
### QueryStartResponse
|
|
1030
1030
|
|
|
@@ -1037,7 +1037,7 @@ The response when starting a query.
|
|
|
1037
1037
|
| --- | --- | --- |
|
|
1038
1038
|
|progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
|
|
1039
1039
|
|requestToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The token returned by the POST query:execute call. |
|
|
1040
|
-
|result
|
|
1040
|
+
|result|<a href="#queryresult" target="_blank" rel="noopener noreferrer">QueryResult</a>| |
|
|
1041
1041
|
|state<sup>*required</sup>|QueryState| |
|
|
1042
1042
|
|ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
|
|
1043
1043
|
|
|
@@ -1051,7 +1051,7 @@ The field type in range.
|
|
|
1051
1051
|
| Name | Type | Description |
|
|
1052
1052
|
| --- | --- | --- |
|
|
1053
1053
|
|indexRange|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|The range of elements at use this type in arrays (null for records). |
|
|
1054
|
-
|mappings<sup>*required</sup
|
|
1054
|
+
|mappings<sup>*required</sup>|<a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a>| |
|
|
1055
1055
|
|
|
1056
1056
|
### RangedFieldTypesMappings
|
|
1057
1057
|
**type**: Record<string, FieldType | undefined>
|
|
@@ -1088,8 +1088,8 @@ The position of a token in a query string used for errors and notification to ma
|
|
|
1088
1088
|
|
|
1089
1089
|
| Name | Type |
|
|
1090
1090
|
| --- | --- |
|
|
1091
|
-
|end<sup>*required</sup
|
|
1092
|
-
|start<sup>*required</sup
|
|
1091
|
+
|end<sup>*required</sup>|<a href="#positioninfo" target="_blank" rel="noopener noreferrer">PositionInfo</a>|
|
|
1092
|
+
|start<sup>*required</sup>|<a href="#positioninfo">PositionInfo</a>|
|
|
1093
1093
|
|
|
1094
1094
|
### VerifyRequest
|
|
1095
1095
|
|
|
@@ -1103,7 +1103,7 @@ The position of a token in a query string used for errors and notification to ma
|
|
|
1103
1103
|
|generateCanonicalQuery|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| <i>default:</i> <code>false</code>|
|
|
1104
1104
|
|locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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'. |
|
|
1105
1105
|
|query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
|
|
1106
|
-
|queryOptions
|
|
1106
|
+
|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
|
|
1107
1107
|
|timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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' |
|
|
1108
1108
|
|
|
1109
1109
|
### VerifyResponse
|
|
@@ -1116,11 +1116,12 @@ Verify response.
|
|
|
1116
1116
|
| Name | Type | Description |
|
|
1117
1117
|
| --- | --- | --- |
|
|
1118
1118
|
|canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
1119
|
-
|notifications|Array<
|
|
1119
|
+
|notifications|Array<<a href="#metadatanotification">MetadataNotification</a>>|The notifications related to the supplied DQL query string. |
|
|
1120
1120
|
|valid<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the supplied DQL query string is valid. |
|
|
1121
1121
|
|
|
1122
1122
|
## Enums
|
|
1123
1123
|
|
|
1124
|
+
<a name="dqlnodenodetype"></a>
|
|
1124
1125
|
### DQLNodeNodeType
|
|
1125
1126
|
|
|
1126
1127
|
<div class="padding-left--md">
|
|
@@ -1138,6 +1139,7 @@ The type of the node.
|
|
|
1138
1139
|
|
|
1139
1140
|
</div>
|
|
1140
1141
|
|
|
1142
|
+
<a name="fieldtypetype"></a>
|
|
1141
1143
|
### FieldTypeType
|
|
1142
1144
|
|
|
1143
1145
|
<div class="padding-left--md">
|
|
@@ -1155,6 +1157,7 @@ The type of the node.
|
|
|
1155
1157
|
|
|
1156
1158
|
</div>
|
|
1157
1159
|
|
|
1160
|
+
<a name="querystate"></a>
|
|
1158
1161
|
### QueryState
|
|
1159
1162
|
|
|
1160
1163
|
<div class="padding-left--md">
|
|
@@ -1172,6 +1175,7 @@ Possible state of the query.
|
|
|
1172
1175
|
|
|
1173
1176
|
</div>
|
|
1174
1177
|
|
|
1178
|
+
<a name="tokentype"></a>
|
|
1175
1179
|
### TokenType
|
|
1176
1180
|
|
|
1177
1181
|
<div class="padding-left--md">
|