@dynatrace-sdk/client-query 1.0.0 → 1.1.0

package/docs/DOCS.md

@@ -1,6 +1,6 @@
 # Storage – Query Service
 
-SDK package version **1.0.0**
+SDK package version **1.1.0**
 
 ```bash
 npm install @dynatrace-sdk/client-query
@@ -516,7 +516,7 @@ The result has three main sections:
 * the 'metadata' section contains information about the query like 'analysisTimeframe', 'timezone' or 'locale'.
 
 Every record has an implicit 'index' according to the position in the 'records' JSON array.
-The types section has a list of 1..N possibhttps://dev.deus-dev.internal.dynatracelabs.com/query-frontend/docs/rest/swagger-ui/index.html?urls.primaryName=v0.5#/Query%20Execution/query%3Acancelle type 'buckets'. Each such bucket has an 'indexRange' which indicates which
+The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
 records will find their field types in which bucket. The index range has two values start & end and can be thought of as [startIndex, endIndex).
 
 A field part of a record with index 'i' will find its corresponding field type by first locating the bucket that satisfies:
@@ -536,108 +536,6 @@ It is guaranteed that every field of every record will have a corresponding type
 **Clients should always take the included types into account when consuming records!**
 
 
-As an example, the following response highlights a collision, where a field called "cancelled" was ingested both as a
-boolean but also wrongly as a string. The first record contains the field "cancelled" as a string, but the very next record has the
-field with the same name but of boolean type. The types section has two entries. One corresponds to first record that has
-the field cancelled of type string. The second entry in the types section corresponds to the subsequent records which have
-the boolean field type.
-
-```json
-{
-  "state":"SUCCEEDED",
-  "ttlSeconds":197,
-  "result": {
-    "records": [
-      {
-        "type": "user_event",
-        "order_id": "1ea34-2515-1515-fe1g",
-        "cancelled": "true"
-      },
-      {
-        "type": "user_event",
-        "order_id": "2ea34-2515-1515-fe1g",
-        "cancelled": false
-      },
-      {
-        "type": "user_event",
-        "order_id": "3ea34-2515-1515-fe1g",
-        "cancelled": true
-      },
-      {
-        "type": "user_event",
-        "order_id": "4ea34-2515-1515-fe1g",
-        "cancelled": false
-      }
-    ],
-    "types": [
-      {
-        "indexRange": [
-          0,
-          1
-        ],
-        "mappings": {
-          "type": {
-            "type": "string"
-          },
-          "order_id": {
-            "type": "string"
-          },
-          "cancelled": {
-            "type": "string"
-          }
-        }
-      },
-      {
-        "indexRange": [
-          1,
-          4
-        ],
-        "mappings": {
-          "type": {
-            "type": "string"
-          },
-          "order_id": {
-            "type": "string"
-          },
-          "cancelled": {
-            "type": "boolean"
-          }
-        }
-      }
-    ],
-    "metadata": {
-      "query": "fetch events | ...",
-      "dqlVersion": "V0_3",
-      "appliedTimeframe": {
-        "start": 1657624357056,
-        "end": 1657631557056
-      },
-      "timezone": "Z",
-      "locale": ""
-    }
-  }
-}
-```
-
-### Field data types
-
-The possible Grail types encountered in the "types" section is limited to a list of well-defined types:
-```
-  BOOLEAN
-  STRING
-  DOUBLE
-  LONG
-  TIMESTAMP
-  TIMEFRAME
-  DURATION
-  BINARY
-  IP_ADDRESS
-  GEO_POINT
-  ARRAY
-  RECORD
-```
-
-
 **Parameters**
 
 <div class="padding-left--md padding-bottom--md">
@@ -713,16 +611,32 @@ For details about the query language see the [Dynatrace Query Language documenta
 
 ### The response format:
 
-The json response will contain the state of the started query and a request token to reference it in future polling requests:
+The json response will contain the state of the started query. If the query succeeded, the result will be included. Otherwise the response will contain a request token to reference the query in future polling requests.
+
+The result has two main sections:
+* The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+* The 'types' section describes the corresponding data types that a record field has.
+
+Every record has an implicit 'index' according to the position in the 'records' JSON array.
+The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
+records will find their field types in which bucket. The index range has two values start & end and can be thought of as [startIndex, endIndex).
+
+A field part of a record with index 'i' will find its corresponding field type by first locating the bucket that satisfies:
 
-```json
-{
-  "state":"RUNNING",
-  "requestToken":"5tCm27WbTHmyi+749/wGsw==",
-  "ttlSeconds":197
-}
+```text
+startIndex &lt;= i &lt;= endIndex
 ```
 
+Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
+
+
+Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
+field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
+When a collision does occur, we will create a new type 'bucket' that will have a different index range where
+the new record field types will be placed.
+It is guaranteed that every field of every record will have a corresponding type.
+**Clients should always take the included types into account when consuming records!**
+
 
 **Parameters**
 
@@ -791,7 +705,7 @@ If set additional data will be available in the metadata section.
 #### Returns
 
 <div class="padding-left--md">
-The final status and results of the supplied query if it finished within a supplied request-timeout-milliseconds. | The status of the query to start.
+The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. | The status of the query to start.
 
 </div>
 
@@ -820,17 +734,7 @@ Retrieves query status and final result from Grail.
 Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
 
 ### The response format:
-The response consists of:
-* The state of the query.
-* ttlSeconds until the query will be wiped
-* If the query succeeded, also a result
-
-```json
-{
-  "state":"RUNNING",
-  "ttlSeconds":197
-}
-```
+The json response will contain the state of the query. If the query succeeded, the result will be included.
 
 The result has two main sections:
 * The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
@@ -856,104 +760,6 @@ the new record field types will be placed.
 It is guaranteed that every field of every record will have a corresponding type.
 **Clients should always take the included types into account when consuming records!**
 
-As an example, the following response highlights a collision, where a field called "cancelled" was ingested both as a
-boolean but also wrongly as a string. The first record contains the field "cancelled" as a string, but the very next record has the
-field with the same name but of boolean type. The types section has two entries. One corresponds to first record that has
-the field cancelled of type string. The second entry in the types section corresponds to the subsequent records which have
-the boolean field type.
-
-```json
-{
-  "state":"SUCCEEDED",
-  "result": {
-    "records": [
-      {
-        "type": "user_event",
-        "order_id": "1ea34-2515-1515-fe1g",
-        "cancelled": "true"
-      },
-      {
-        "type": "user_event",
-        "order_id": "2ea34-2515-1515-fe1g",
-        "cancelled": false
-      },
-      {
-        "type": "user_event",
-        "order_id": "3ea34-2515-1515-fe1g",
-        "cancelled": true
-      },
-      {
-        "type": "user_event",
-        "order_id": "4ea34-2515-1515-fe1g",
-        "cancelled": false
-      }
-    ],
-    "types": [
-      {
-        "indexRange": [
-          0,
-          1
-        ],
-        "mappings": {
-          "type": {
-            "type": "string"
-          },
-          "order_id": {
-            "type": "string"
-          },
-          "cancelled": {
-            "type": "string"
-          }
-        }
-      },
-      {
-        "indexRange": [
-          1,
-          4
-        ],
-        "mappings": {
-          "type": {
-            "type": "string"
-          },
-          "order_id": {
-            "type": "string"
-          },
-          "cancelled": {
-            "type": "boolean"
-          }
-        }
-      }
-    ],
-    "metadata": {
-      "query": "fetch events | ...",
-      "dqlVersion": "V0_3",
-      "appliedTimeframe": {
-        "start": 1657624357056,
-        "end": 1657631557056
-      },
-      "timezone": "Z",
-      "locale": ""
-    }
-  }
-}
-```
-
-The possible Grail types ened in the "types" section is limited to a list of well-defined types:
-```
-  BOOLEAN
-  STRING
-  DOUBLE
-  LONG
-  TIMESTAMP
-  TIMEFRAME
-  DURATION
-  BINARY
-  IP_ADDRESS
-  GEO_POINT
-  ARRAY
-  RECORD
-```
-
 
 **Parameters**
 
@@ -997,7 +803,7 @@ If set additional data will be available in the metadata section.
 <strong>config.requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
 <div class="padding-left--md">
 
-The request timeout in milliseconds. The response will be delayed for up to the specified time in milliseconds to wait for the result of the query.
+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.
 
 </div>
 
@@ -1736,7 +1542,7 @@ Limit in gigabytes for the amount data that will be scanned during read.
 <strong>defaultTimeframeEnd</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
 
-The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. &lt;em&gt;Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.&lt;/em&gt;
+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.*
 
 </div>
 
@@ -1748,7 +1554,7 @@ The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timefra
 <strong>defaultTimeframeStart</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
 <div class="padding-left--md">
 
-The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. &lt;em&gt;Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.&lt;/em&gt;
+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.*
 
 </div>
 
@@ -1760,7 +1566,7 @@ The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timef
 <strong>enablePreview</strong>: boolean
 <div class="padding-left--md">
 
-Request preview results. If a preview is available within the request-timeout-milliseconds, then it will be returned as part of the response.
+Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response.
 
 </div>
 

package/dynatrace-metadata.json

@@ -1,10 +1,13 @@
 {
   "dynagen": {
-    "version": "0.10.4",
+    "version": "0.10.7",
     "generatedAt": "",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.13.7"
+      "version": "0.17.0"
+    },
+    "featureFlags": {
+      "typeguards": true
     }
   },
   "spec": {