Add listIndex() method of SODA collection object to fetch all indexes in a SODA collection

Author: sharadraju

doc/src/release_notes.rst

@@ -28,6 +28,9 @@ Thin Mode Changes
 Thick Mode Changes
 ++++++++++++++++++
 
+#)  Implemented enhancement to support listIndexes() method to fetch all the
+    current indexes from the SODA collection.
+
 #)  Fixed bug where a segmentation fault (segfault) occurred while populating
     object Collection having BLOB property. See
     `node-oracledb public Slack channel <https://node-oracledb.slack.com/
@@ -38,6 +41,7 @@ Thick Mode Changes
     on any SODA document. An explicit commit or rollback is required to unlock
     and modify any corresponding SODA document.
 
+
 #)  Fixed bug that throws an 'ORA-21525' error with dbObjects having one or
     more 'Number' attributes of precision less than or equal to 18 and scale
     as 0.

lib/sodaCollection.js

@@ -188,6 +188,16 @@ class SodaCollection {
     return doc;
   }
 
+  //---------------------------------------------------------------------------
+  // listIndexes()
+  //
+  //   To obtain all indices from the collection
+  //---------------------------------------------------------------------------
+  async listIndexes() {
+    const arr = await this._impl.listIndexes();
+    return arr.map(i => JSON.parse(i));
+  }
+
   //---------------------------------------------------------------------------
   // metaData()
   //
@@ -262,6 +272,7 @@ nodbUtil.wrapFns(SodaCollection.prototype,
   "insertManyAndGet",
   "insertOne",
   "insertOneAndGet",
+  "listIndexes",
   "save",
   "saveAndGet",
   "truncate");

src/njsBaton.c

@@ -228,6 +228,11 @@ void njsBaton_free(njsBaton *baton, napi_env env)
                 baton->sodaCollNames);
         NJS_FREE_AND_CLEAR(baton->sodaCollNames);
     }
+    if (baton->indexList) {
+        dpiContext_freeStringList(baton->globals->context, baton->indexList);
+        NJS_FREE_AND_CLEAR(baton->indexList);
+    }
+
     if (!baton->jsBufferRef) {
         NJS_FREE_AND_CLEAR(baton->bufferPtr);
     }

src/njsModule.h

@@ -333,6 +333,7 @@ struct njsBaton {
     uint32_t *bindNameLengths;
     dpiSodaOperOptions *sodaOperOptions;
     dpiStringList *sodaCollNames;
+    dpiStringList *indexList;
     njsLobBuffer *lob;
 
     // ODPI-C handles (requires release)

src/njsSodaCollection.c

@@ -44,6 +44,7 @@ NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_insertMany);
 NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_insertManyAndGet);
 NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_insertOne);
 NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_insertOneAndGet);
+NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_listIndexes);
 NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_save);
 NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_saveAndGet);
 NJS_NAPI_METHOD_DECL_ASYNC(njsSodaCollection_truncate);
@@ -57,6 +58,7 @@ static NJS_ASYNC_METHOD(njsSodaCollection_insertManyAsync);
 static NJS_ASYNC_METHOD(njsSodaCollection_insertManyAndGetAsync);
 static NJS_ASYNC_METHOD(njsSodaCollection_insertOneAsync);
 static NJS_ASYNC_METHOD(njsSodaCollection_insertOneAndGetAsync);
+static NJS_ASYNC_METHOD(njsSodaCollection_listIndexesAsync);
 static NJS_ASYNC_METHOD(njsSodaCollection_saveAsync);
 static NJS_ASYNC_METHOD(njsSodaCollection_saveAndGetAsync);
 static NJS_ASYNC_METHOD(njsSodaCollection_truncateAsync);
@@ -67,6 +69,7 @@ static NJS_ASYNC_POST_METHOD(njsSodaCollection_dropIndexPostAsync);
 static NJS_ASYNC_POST_METHOD(njsSodaCollection_getDataGuidePostAsync);
 static NJS_ASYNC_POST_METHOD(njsSodaCollection_insertManyAndGetPostAsync);
 static NJS_ASYNC_POST_METHOD(njsSodaCollection_insertOneAndGetPostAsync);
+static NJS_ASYNC_POST_METHOD(njsSodaCollection_listIndexesPostAsync);
 static NJS_ASYNC_POST_METHOD(njsSodaCollection_saveAndGetPostAsync);
 
 // processing arguments methods
@@ -99,6 +102,8 @@ static const napi_property_descriptor njsClassProperties[] = {
             napi_default, NULL },
     { "getName", NULL, njsSodaCollection_getName, NULL, NULL, NULL,
             napi_default, NULL },
+    { "listIndexes", NULL, njsSodaCollection_listIndexes, NULL, NULL, NULL,
+            napi_default, NULL },
     { "save", NULL, njsSodaCollection_save, NULL, NULL, NULL, napi_default,
             NULL },
     { "saveAndGet", NULL, njsSodaCollection_saveAndGet, NULL, NULL, NULL,
@@ -633,6 +638,64 @@ static bool njsSodaCollection_insertOneAndGetPostAsync(njsBaton *baton,
 }
 
 
+
+//-----------------------------------------------------------------------------
+// njsSodaCollection_listIndexes()
+//   Obtains a list of indexes from the collection and returns.  Each index
+//   is an object
+//-----------------------------------------------------------------------------
+NJS_NAPI_METHOD_IMPL_ASYNC(njsSodaCollection_listIndexes, 0, NULL)
+{
+    return njsBaton_queueWork(baton, env, "listIndexes",
+            njsSodaCollection_listIndexesAsync,
+            njsSodaCollection_listIndexesPostAsync, returnValue);
+}
+
+
+//-----------------------------------------------------------------------------
+// njsSodaCollection_listIndexesAsync()
+//   Worker function for njsSodaCollection_listIndexes().
+//-----------------------------------------------------------------------------
+static bool njsSodaCollection_listIndexesAsync(njsBaton *baton)
+{
+    njsSodaCollection *coll = (njsSodaCollection*) baton->callingInstance;
+
+    baton->indexList = calloc(1, sizeof(dpiStringList));
+    if (!baton->indexList)
+        return njsBaton_setErrorInsufficientMemory(baton);
+    if (dpiSodaColl_listIndexes(coll->handle, DPI_SODA_FLAGS_DEFAULT,
+            baton->indexList) < 0)  {
+        return njsBaton_setErrorDPI(baton);
+    }
+    return true;
+}
+
+
+//-----------------------------------------------------------------------------
+// njsSodaCollection_listIndexesPostAsync()
+//  Defines the value returned to JS
+//-----------------------------------------------------------------------------
+static bool njsSodaCollection_listIndexesPostAsync(njsBaton *baton,
+        napi_env env, napi_value *result)
+{
+    napi_value temp;
+    uint32_t   i;
+
+    NJS_CHECK_NAPI(env, napi_create_array_with_length(env,
+            baton->indexList->numStrings, result))
+    for (i = 0; i < baton->indexList->numStrings; i++) {
+        NJS_CHECK_NAPI(env, napi_create_string_utf8(env,
+            baton->indexList->strings[i],
+            baton->indexList->stringLengths[i], &temp))
+        NJS_CHECK_NAPI(env, napi_set_element(env, *result, i, temp))
+    }
+
+    return true;
+}
+
+
+
+
 //-----------------------------------------------------------------------------
 // njsSodaCollection_newFromBaton()
 //   Called when a SODA collection is being created from the baton.

test/list.txt

@@ -5502,6 +5502,14 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
         285.3.3 msgId in enqOne/deqOne in reverse order
         285.3.4 msgId in enqOne/deqOne in non-sequential order
 
+286. listIndexes.js
+    286.1 listIndexes before creating any indexes
+    286.2 listIndexes after 1-createIndex
+    286.3 listIndexes after 2-createIndex
+    286.4 listIndexes after 2-createIndex 1-drop index
+    286.5 listIndexes after 2-createIndex 2-drop index
+    286.6 listIndexes after 3-createIndex
+
 287. sodaOperationsLock.js
     287.1 lock on sodaOperations