@dynatrace-sdk/client-query 1.19.0 → 1.20.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 @dynatrace-sdk/client-query
 
+## 1.20.0
+
+### Minor changes
+- Add request body parameter `includeTypes` to `ExecuteRequest`
+- Add header `dt-client-context` to all query endpoints
+- Add `enforce-query-consumption-limit` header to `/query:execute` and `/query:autocomplete` endpoints
+
 ## 1.19.0
 
 ### Minor Changes

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.19.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.19.0)
+[![npm](https://img.shields.io/badge/npm-v1.20.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.20.0)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Exposes an API to fetch records stored in Grail
@@ -88,9 +88,11 @@ a link to docs, etc.
 
 #### Parameters
 
-| Name | Type |
-| --- | --- |
-|config.body<sup>*required</sup>|<a href="#autocompleterequest" target="_blank" rel="noopener noreferrer">AutocompleteRequest</a>| 
+| Name | Type | Description |
+| --- | --- | --- |
+|config.body<sup>*required</sup>|<a href="#autocompleterequest" target="_blank" rel="noopener noreferrer">AutocompleteRequest</a>| |
+|config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
+|config.enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set, query consumption limit will be enforced. |
 
 
 
@@ -341,9 +343,10 @@ When displaying the query, pick one option. You may use the other options for ho
 
 #### Parameters
 
-| Name | Type |
-| --- | --- |
-|config.body<sup>*required</sup>|<a href="#parserequest" target="_blank" rel="noopener noreferrer">ParseRequest</a>| 
+| Name | Type | Description |
+| --- | --- | --- |
+|config.body<sup>*required</sup>|<a href="#parserequest" target="_blank" rel="noopener noreferrer">ParseRequest</a>| |
+|config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
 
 
 
@@ -409,9 +412,10 @@ submitting the query for execution.
 
 #### Parameters
 
-| Name | Type |
-| --- | --- |
-|config.body<sup>*required</sup>|<a href="#verifyrequest" target="_blank" rel="noopener noreferrer">VerifyRequest</a>| 
+| Name | Type | Description |
+| --- | --- | --- |
+|config.body<sup>*required</sup>|<a href="#verifyrequest" target="_blank" rel="noopener noreferrer">VerifyRequest</a>| |
+|config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
 
 
 
@@ -513,6 +517,7 @@ It is guaranteed that every field of every record will have a corresponding type
 
 | Name | Type | Description |
 | --- | --- | --- |
+|config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
 |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
 |config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
 
@@ -609,6 +614,8 @@ It is guaranteed that every field of every record will have a corresponding type
 | Name | Type | Description |
 | --- | --- | --- |
 |config.body<sup>*required</sup>|<a href="#executerequest">ExecuteRequest</a>| |
+|config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
+|config.enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set, query consumption limit will be enforced. |
 |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
 
 
@@ -704,6 +711,7 @@ It is guaranteed that every field of every record will have a corresponding type
 
 | Name | Type | Description |
 | --- | --- | --- |
+|config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
 |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
 |config.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 query status is returned. |
 |config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
@@ -890,12 +898,13 @@ Detailed information about the error.
 |enablePreview|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response. |
 |fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The query will stop reading data after reaching the fetch-timeout. The query execution will continue, providing a partial result based on the read data. |
 |filterSegments|<a href="#filtersegments">FilterSegments</a>|Represents a collection of filter segments. |
+|includeTypes|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Parameter to exclude the type information from the query result. In case not specified, the type information will be included. <i>default:</i> <code>true</code>|
 |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'. |
 |maxResultBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result bytes that this query will return. |
 |maxResultRecords|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result records that this query will return. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
 |queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
-|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. |
+|requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time the response will be delayed to wait for a result. (This excludes the sending time and time spent in any services between the query-frontend and the client.) If the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result. |
 |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' |
 
 ### FieldType

package/cjs/index.js

@@ -263,6 +263,9 @@ var QueryAssistanceClient = class {
       throw new import_shared_errors3.ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:verify`,
@@ -271,7 +274,8 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -599,6 +603,9 @@ var QueryAssistanceClient = class {
       throw new import_shared_errors3.ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:parse`,
@@ -607,7 +614,8 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -782,6 +790,12 @@ var QueryAssistanceClient = class {
       throw new import_shared_errors3.ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) },
+      ...config.enforceQueryConsumptionLimit !== void 0 && {
+        "enforce-query-consumption-limit": String(config.enforceQueryConsumptionLimit)
+      }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:autocomplete`,
@@ -790,7 +804,8 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -1045,12 +1060,16 @@ var QueryExecutionClient = class {
       },
       { explode: { "request-token": false, "request-timeout-milliseconds": false } }
     );
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:poll${query}`,
         method: "GET",
         headers: {
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -1247,6 +1266,12 @@ var QueryExecutionClient = class {
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
     const query = toQueryString({ enrich: config.enrich });
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) },
+      ...config.enforceQueryConsumptionLimit !== void 0 && {
+        "enforce-query-consumption-limit": String(config.enforceQueryConsumptionLimit)
+      }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:execute${query}`,
@@ -1255,7 +1280,8 @@ var QueryExecutionClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -1617,12 +1643,16 @@ var QueryExecutionClient = class {
       { "request-token": config.requestToken, enrich: config.enrich },
       { explode: { "request-token": false } }
     );
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:cancel${query}`,
         method: "POST",
         headers: {
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {

package/dynatrace-metadata.json

@@ -1,7 +1,7 @@
 {
   "dynagen": {
     "version": "0.18.0",
-    "generatedAt": "2025-03-12T14:13:49.759Z",
+    "generatedAt": "2025-03-31T11:21:40.514Z",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
       "version": "0.33.2"
@@ -12,7 +12,7 @@
   },
   "spec": {
     "title": "DQL Query",
-    "version": "1.14.0",
+    "version": "1.15.0",
     "baseUrl": "/platform/storage/query/v1"
   }
 }

package/esm/index.js

@@ -228,6 +228,9 @@ var QueryAssistanceClient = class {
       throw new ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:verify`,
@@ -236,7 +239,8 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -564,6 +568,9 @@ var QueryAssistanceClient = class {
       throw new ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:parse`,
@@ -572,7 +579,8 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -747,6 +755,12 @@ var QueryAssistanceClient = class {
       throw new ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) },
+      ...config.enforceQueryConsumptionLimit !== void 0 && {
+        "enforce-query-consumption-limit": String(config.enforceQueryConsumptionLimit)
+      }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:autocomplete`,
@@ -755,7 +769,8 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -1020,12 +1035,16 @@ var QueryExecutionClient = class {
       },
       { explode: { "request-token": false, "request-timeout-milliseconds": false } }
     );
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:poll${query}`,
         method: "GET",
         headers: {
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -1222,6 +1241,12 @@ var QueryExecutionClient = class {
     }
     const encodedBody = this.shouldTransformDates ? transformRequest(config.body, []) : config.body;
     const query = toQueryString({ enrich: config.enrich });
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) },
+      ...config.enforceQueryConsumptionLimit !== void 0 && {
+        "enforce-query-consumption-limit": String(config.enforceQueryConsumptionLimit)
+      }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:execute${query}`,
@@ -1230,7 +1255,8 @@ var QueryExecutionClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {
@@ -1592,12 +1618,16 @@ var QueryExecutionClient = class {
       { "request-token": config.requestToken, enrich: config.enrich },
       { explode: { "request-token": false } }
     );
+    const headerParameters = {
+      ...config.dtClientContext !== void 0 && { "dt-client-context": String(config.dtClientContext) }
+    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:cancel${query}`,
         method: "POST",
         headers: {
-          Accept: "application/json"
+          Accept: "application/json",
+          ...headerParameters
         },
         abortSignal: config instanceof EventTarget ? config : config.abortSignal,
         statusValidator: (status) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "description": "Exposes an API to fetch records stored in Grail.",
   "license": "Apache-2.0",
   "dependencies": {

package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts

@@ -48,6 +48,7 @@ export declare class QueryAssistanceClient {
      */
     queryVerify(config: {
         body: VerifyRequest;
+        /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
         abortSignal?: AbortSignal;
     }): Promise<VerifyResponse>;
     /**
@@ -264,6 +265,7 @@ export declare class QueryAssistanceClient {
      */
     queryParse(config: {
         body: ParseRequest;
+        /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
         abortSignal?: AbortSignal;
     }): Promise<DQLNode>;
     /**
@@ -324,6 +326,8 @@ export declare class QueryAssistanceClient {
      */
     queryAutocomplete(config: {
         body: AutocompleteRequest;
+        /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
+        /** If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
         abortSignal?: AbortSignal;
     }): Promise<AutocompleteResponse>;
 }

package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts

@@ -70,6 +70,7 @@ export declare class QueryExecutionClient {
         /** The request-token of the query. */ requestToken: string;
         /** 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. */ requestTimeoutMilliseconds?: number;
         /** If set additional data will be available in the metadata section. */ enrich?: string;
+        /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
         abortSignal?: AbortSignal;
     }): Promise<QueryPollResponse>;
     /**
@@ -132,6 +133,8 @@ export declare class QueryExecutionClient {
     queryExecute(config: {
         body: ExecuteRequest;
         /** If set additional data will be available in the metadata section. */ enrich?: string;
+        /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
+        /** If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
         abortSignal?: AbortSignal;
     }): Promise<QueryStartResponse>;
     /**
@@ -189,6 +192,7 @@ export declare class QueryExecutionClient {
     queryCancel(config: {
         /** The request-token of the query. */ requestToken: string;
         /** If set additional data will be available in the metadata section. */ enrich?: string;
+        /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
         abortSignal?: AbortSignal;
     }): Promise<QueryPollResponse | void>;
 }

package/types/packages/client/query/src/lib/models/execute-request.d.ts

@@ -34,7 +34,7 @@ export interface ExecuteRequest {
      */
     fetchTimeoutSeconds?: 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.
+     * The maximum time the response will be delayed to wait for a result. (This excludes the sending time and time spent in any services between the query-frontend and the client.) If the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result.
      */
     requestTimeoutMilliseconds?: number;
     /**
@@ -57,4 +57,8 @@ export interface ExecuteRequest {
      * Represents a collection of filter segments.
      */
     filterSegments?: FilterSegments;
+    /**
+     * Parameter to exclude the type information from the query result. In case not specified, the type information will be included.
+     */
+    includeTypes?: boolean;
 }