Add toMap API for dbObject of collection type (GH Issue #1627)

Author: sharadraju

doc/src/release_notes.rst

@@ -13,6 +13,10 @@ node-oracledb `v6.4.0 <https://github.com/oracle/node-oracledb/compare/v6.3.0...
 Common Changes
 ++++++++++++++
 
+#)  Added :meth:`~dbObject.toMap` method to :ref:`DbObject Class<dbobjectclass>`
+    which returns a map object.
+    See `Issue #1627 <https://github.com/oracle/node-oracledb/issues/1627>`__.
+
 #)  Accept an object as an input parameter for :meth:`connection.execute()`
     as per GitHub user request.
     See `Issue #1629 <https://github.com/oracle/node-oracledb/issues/1629>`__.

lib/dbObject.js

@@ -439,6 +439,25 @@ class BaseDbObject {
     return (this._toPojo());
   }
 
+  //---------------------------------------------------------------------------
+  // toMap()
+  //
+  // Returns the Map object where the collection’s indexes are the keys and
+  // the elements are its values.
+  //---------------------------------------------------------------------------
+  toMap() {
+    errors.assertArgCount(arguments, 0, 0);
+    if (!this.isCollection) {
+      errors.throwErr(errors.ERR_OBJECT_IS_NOT_A_COLLECTION,
+        this.name);
+    }
+    const result = new Map();
+    this.getKeys().forEach(element => {
+      result.set(element, this.getElement(element));
+    });
+    return result;
+  }
+
 }
 
 // method for transforming the error
@@ -472,6 +491,7 @@ wrapFns(BaseDbObject.prototype,
   "getNextIndex",
   "getPrevIndex",
   "getValues",
+  "toMap",
   "hasElement",
   "setElement",
   "trim"

lib/errors.js

@@ -142,6 +142,7 @@ const ERR_WRONG_LENGTH_FOR_DBOBJECT_ATTR = 142;
 const ERR_WRONG_LENGTH_FOR_DBOBJECT_ELEM = 143;
 const ERR_VECTOR_FORMAT_NOT_SUPPORTED = 144;
 const ERR_VECTOR_VERSION_NOT_SUPPORTED = 145;
+const ERR_OBJECT_IS_NOT_A_COLLECTION = 146;
 
 // Oracle Net layer errors start from 500
 const ERR_CONNECTION_CLOSED = 500;
@@ -414,6 +415,8 @@ messages.set(ERR_VECTOR_FORMAT_NOT_SUPPORTED,           // NJS-144
   'VECTOR format %d is not supported');
 messages.set(ERR_VECTOR_VERSION_NOT_SUPPORTED,          // NJS-145
   'VECTOR version %d is not supported');
+messages.set(ERR_OBJECT_IS_NOT_A_COLLECTION,            // NJS-146
+  'object %s is not a collection');
 
 // Oracle Net layer errors
 
@@ -804,6 +807,7 @@ module.exports = {
   ERR_WRONG_LENGTH_FOR_DBOBJECT_ELEM,
   ERR_VECTOR_FORMAT_NOT_SUPPORTED,
   ERR_VECTOR_VERSION_NOT_SUPPORTED,
+  ERR_OBJECT_IS_NOT_A_COLLECTION,
   ERR_CONNECTION_CLOSED_CODE: `${ERR_PREFIX}-${ERR_CONNECTION_CLOSED}`,
   WRN_COMPILATION_CREATE,
   assert,

test/dbObject20.js

@@ -1042,4 +1042,60 @@ describe('290. dbObject20.js', () => {
     });
 
   });
+
+  describe('290.5 Associative Arrays fetch ', function() {
+    let conn;
+    const PKG1 = 'NODB_PKG_OBJ_1_PLS_INTEGER';
+    const TYPE1 = 'NODB_TYP_OBJ_1_PLS_ARRAY_INTEGER';
+
+    before(async () => {
+      conn = await oracledb.getConnection(dbConfig);
+      let sql =
+        `CREATE OR REPLACE PACKAGE ${PKG1} AUTHID DEFINER AS
+      TYPE ${TYPE1} IS TABLE OF NUMBER INDEX BY PLS_INTEGER;
+      FUNCTION F1  RETURN ${TYPE1};
+      END;`;
+      await conn.execute(sql);
+
+      sql = `CREATE OR REPLACE PACKAGE BODY ${PKG1}  AS
+              FUNCTION F1  RETURN ${TYPE1} IS
+              R ${TYPE1};
+              BEGIN
+                R(2):=22;
+                R(5):=55;
+                RETURN R;
+              END ;
+              END ${PKG1} ;`;
+      await conn.execute(sql);
+
+    }); // before()
+
+    after(async () => {
+      if (conn) {
+        await testsUtil.dropType(conn, TYPE1);
+        const sql = `DROP package ${PKG1}`;
+        await conn.execute(sql);
+        await conn.close();
+      }
+    }); // after()
+
+    it('290.5.1 verify associative array outbinds ', async () => {
+      // verify pls array of integers
+      const inDataobj = {2: 22, 5: 55};
+      const result = await conn.execute(
+        `BEGIN
+          :ret := ${PKG1}.f1;
+         END;`,
+        {
+          ret: {
+            dir: oracledb.BIND_OUT,
+            type: `${PKG1}.${TYPE1}`
+          }
+        });
+      const res = result.outBinds.ret;
+      const outMap = res.toMap();
+      assert.deepStrictEqual(JSON.stringify(Object.fromEntries(outMap)), JSON.stringify(inDataobj));
+    });
+  });
+
 });