@dynatrace-sdk/client-query 1.7.2 → 1.8.1

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 @dynatrace-sdk/client-query
 
+## 1.8.1
+
+### Patch Changes
+
+- Update documentation.
+
+## 1.8.0
+
+### Minor Changes
+
+- `rollup` and `rate` properties were added to the `MetricMetadata` object
+
 ## 1.7.2
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.7.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.7.2)
+[![npm](https://img.shields.io/badge/npm-v1.8.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.8.1)
 [![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

package/cjs/index.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2023 Dynatrace LLC
+ * Copyright 2023-2024 Dynatrace LLC
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -2302,10 +2302,18 @@ function isMetricMetadata(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
+  const modelKeys = /* @__PURE__ */ new Set([
+    "metric.key",
+    "displayName",
+    "description",
+    "unit",
+    "fieldName",
+    "rollup",
+    "rate"
+  ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName", "rollup", "rate"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -2322,10 +2330,18 @@ function isJson23(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
+  const modelKeys = /* @__PURE__ */ new Set([
+    "metric.key",
+    "displayName",
+    "description",
+    "unit",
+    "fieldName",
+    "rollup",
+    "rate"
+  ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName", "rollup", "rate"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -2333,23 +2349,27 @@ function isJson23(value) {
   return containsRequiredOrOptionalKeys && doesNotContainExtraKeys && allPropertiesMatchFormat;
 }
 function fromJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName, rollup, rate } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
     unit,
-    fieldName
+    fieldName,
+    rollup,
+    rate
   };
 }
 function toJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName, rollup, rate } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
     unit,
-    fieldName
+    fieldName,
+    rollup,
+    rate
   };
 }
 

package/docs/DOCS.md

@@ -7,7 +7,7 @@ description: Exposes an API to fetch records stored in Grail.
 
 Exposes an API to fetch records stored in Grail
 
-import NpmLogo from '@site/static/img/npm-logo.png';
+import NpmLogo from "@site/static/img/npm-logo.png";
 
 <div class="row margin-bottom--md">
   <div class="col">
@@ -16,8 +16,10 @@ import NpmLogo from '@site/static/img/npm-logo.png';
       <img className="no-zoom" width="20px" src={NpmLogo} />
     </a>
   </div>
-  <div class="col" style={{textAlign: 'right'}}>
-    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.7.2">v1.7.2</a>
+  <div class="col" style={{ textAlign: "right" }}>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.8.1">
+      v1.8.1
+    </a>
   </div>
 </div>
 
@@ -40,7 +42,7 @@ import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
 
 Get a structured list of suggestions for the query at the given position.
 
-For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
 
 <h2> Overview</h2>
 
@@ -119,7 +121,7 @@ const data = await queryAssistanceClient.queryAutocomplete({
 
 Get a structured tree of the canonical form of the query.
 
-For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
 
 <h2> Overview</h2>
 
@@ -354,7 +356,7 @@ const data = await queryAssistanceClient.queryParse({
 
 Verifies a query without executing it.
 
-For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
 
 <h2> Overview</h2>
 
@@ -410,7 +412,7 @@ import { queryExecutionClient } from "@dynatrace-sdk/client-query";
 
 Cancels the query and returns the result if the query was already finished, otherwise discards it.
 
-For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
 
 <h3> Overview:</h3>
 
@@ -485,7 +487,7 @@ const data = await queryExecutionClient.queryCancel({
 
 Starts a Grail query.
 
-For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
 
 <h3> Overview:</h3>
 
@@ -565,7 +567,7 @@ const data = await queryExecutionClient.queryExecute({
 
 Retrieves query status and final result from Grail.
 
-For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
 
 <h3> Overview:</h3>
 
@@ -761,7 +763,7 @@ Detailed information about the error.
 | 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>     |
 | 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>     |
 | 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.                                                                                                                                                   |
-| fetchTimeoutSeconds        | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>   | The query will stop after reaching the fetch-timeout.                                                                                                                                                                                                                                         |
+| fetchTimeoutSeconds        | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>   | 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.                                                                                                                                      |
 | 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'.                         |
 | 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.                                                                                                                                                                                                                               |
 | 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.                                                                                                                                                                                                                             |
@@ -839,6 +841,8 @@ An object that defines additional metric metadata.
 | displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the metadata.                   |
 | fieldName   | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the associated field used in the query. |
 | metric.key  | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The metric key.                                     |
+| rate        | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The specified rate normalization parameter.         |
+| rollup      | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Metadata about the rollup type.                     |
 | unit        | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unit used.                                      |
 
 ### ParseRequest

package/dynatrace-metadata.json

@@ -1,10 +1,10 @@
 {
   "dynagen": {
-    "version": "0.12.9",
+    "version": "0.13.1",
     "generatedAt": "",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.18.6"
+      "version": "0.18.10"
     },
     "featureFlags": {
       "typeguards": true
@@ -12,7 +12,7 @@
   },
   "spec": {
     "title": "DQL Query",
-    "version": "1.6.0",
+    "version": "1.7.0",
     "baseUrl": "/platform/storage/query/v1"
   }
 }

package/esm/index.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2023 Dynatrace LLC
+ * Copyright 2023-2024 Dynatrace LLC
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -2248,10 +2248,18 @@ function isMetricMetadata(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
+  const modelKeys = /* @__PURE__ */ new Set([
+    "metric.key",
+    "displayName",
+    "description",
+    "unit",
+    "fieldName",
+    "rollup",
+    "rate"
+  ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName", "rollup", "rate"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -2268,10 +2276,18 @@ function isJson23(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
+  const modelKeys = /* @__PURE__ */ new Set([
+    "metric.key",
+    "displayName",
+    "description",
+    "unit",
+    "fieldName",
+    "rollup",
+    "rate"
+  ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName", "rollup", "rate"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -2279,23 +2295,27 @@ function isJson23(value) {
   return containsRequiredOrOptionalKeys && doesNotContainExtraKeys && allPropertiesMatchFormat;
 }
 function fromJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName, rollup, rate } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
     unit,
-    fieldName
+    fieldName,
+    rollup,
+    rate
   };
 }
 function toJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName, rollup, rate } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
     unit,
-    fieldName
+    fieldName,
+    rollup,
+    rate
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.7.2",
+  "version": "1.8.1",
   "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

@@ -19,7 +19,7 @@ export declare class QueryAssistanceClient {
     /**
      * Verifies a query without executing it.
      *
-     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ## Overview
      *
@@ -46,7 +46,7 @@ export declare class QueryAssistanceClient {
     /**
      * Get a structured tree of the canonical form of the query.
      *
-     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ## Overview
      *
@@ -258,7 +258,7 @@ export declare class QueryAssistanceClient {
     /**
      * Get a structured list of suggestions for the query at the given position.
      *
-     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ## Overview
      *

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

@@ -16,7 +16,7 @@ export declare class QueryExecutionClient {
     /**
      * Retrieves query status and final result from Grail.
      *
-     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ### Overview:
      *
@@ -67,7 +67,7 @@ export declare class QueryExecutionClient {
     /**
      * Starts a Grail query.
      *
-     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ### Overview:
      *
@@ -124,7 +124,7 @@ export declare class QueryExecutionClient {
     /**
      * Cancels the query and returns the result if the query was already finished, otherwise discards it.
      *
-     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
+     * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ### Overview:
      *

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

@@ -28,7 +28,7 @@ export interface ExecuteRequest {
      */
     maxResultBytes?: number;
     /**
-     * The query will stop after reaching the fetch-timeout.
+     * 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.
      */
     fetchTimeoutSeconds?: number;
     /**

package/types/packages/client/query/src/lib/models/metric-metadata.d.ts

@@ -22,4 +22,12 @@ export interface MetricMetadata {
      * The name of the associated field used in the query.
      */
     fieldName?: string;
+    /**
+     * Metadata about the rollup type.
+     */
+    rollup?: string;
+    /**
+     * The specified rate normalization parameter.
+     */
+    rate?: string;
 }

package/types/packages/client/query/src/lib/models/metric-metadata.transformation.d.ts

@@ -5,6 +5,8 @@ export interface AsJson {
     description?: string;
     unit?: string;
     fieldName?: string;
+    rollup?: string;
+    rate?: string;
 }
 export declare function isMetricMetadata(value: any): value is MetricMetadata;
 export declare function isJson(value: any): value is AsJson;