feat: untyped param types (#1869)

This features allows customers to not pass paramType in parametrised queries. It gives backend to flexibly match the type. Example: Previously is timestamp was passed as string, it would be passed to backend with string type code and hence an error would be thrown. Now it is passed without any type code and hence backend handles checking its time and the code succeeds.

Author: asthamohta

samples/dml.js

@@ -288,6 +288,21 @@ function updateUsingDmlWithStruct(instanceId, databaseId, projectId) {
         params: {
           name: nameStruct,
         },
+        types: {
+          name: {
+            type: 'struct',
+            fields: [
+              {
+                name: 'FirstName',
+                type: 'string',
+              },
+              {
+                name: 'LastName',
+                type: 'string',
+              },
+            ],
+          },
+        },
       });
 
       console.log(`Successfully updated ${rowCount} record.`);

samples/struct.js

@@ -111,6 +111,21 @@ async function queryDataWithStruct(instanceId, databaseId, projectId) {
     params: {
       name: nameStruct,
     },
+    types: {
+      name: {
+        type: 'struct',
+        fields: [
+          {
+            name: 'FirstName',
+            type: 'string',
+          },
+          {
+            name: 'LastName',
+            type: 'string',
+          },
+        ],
+      },
+    },
   };
 
   // Queries rows from the Singers table
@@ -250,6 +265,21 @@ async function queryStructField(instanceId, databaseId, projectId) {
     params: {
       name: nameStruct,
     },
+    types: {
+      name: {
+        type: 'struct',
+        fields: [
+          {
+            name: 'FirstName',
+            type: 'string',
+          },
+          {
+            name: 'LastName',
+            type: 'string',
+          },
+        ],
+      },
+    },
   };
 
   // Queries rows from the Singers table

src/codec.ts

@@ -597,10 +597,6 @@ function getType(value: Value): Type {
     return {type: 'bool'};
   }
 
-  if (is.string(value)) {
-    return {type: 'string'};
-  }
-
   if (Buffer.isBuffer(value)) {
     return {type: 'bytes'};
   }
@@ -643,6 +639,7 @@ function getType(value: Value): Type {
     return {type: 'json'};
   }
 
+  // String type is also returned as unspecified to allow untyped parameters
   return {type: 'unspecified'};
 }
 

src/transaction.ts

@@ -1300,7 +1300,10 @@ export class Snapshot extends EventEmitter {
     if (!is.empty(typeMap)) {
       Object.keys(typeMap).forEach(param => {
         const type = typeMap[param];
-        paramTypes[param] = codec.createTypeObject(type);
+        const typeObject = codec.createTypeObject(type);
+        if (typeObject.code !== 'TYPE_CODE_UNSPECIFIED') {
+          paramTypes[param] = codec.createTypeObject(type);
+        }
       });
     }