populate isOson metadata

Author: sharadraju

doc/src/release_notes.rst

@@ -13,6 +13,9 @@ node-oracledb `v6.4.0 <https://github.com/oracle/node-oracledb/compare/v6.3.0...
 Common Changes
 ++++++++++++++
 
+#)  Added new extended :ref:`metadata <execmetadata>` information attribute
+    ``isOson`` for a fetched column.
+
 #)  Added :attr:`oracledb.poolPingTimeout` and :attr:`pool.poolPingTimeout`
     to limit the :meth:`connection.ping()` call time.
     `Issue #1626 <https://github.com/oracle/node-oracledb/issues/1626>`__.

lib/thin/protocol/constants.js

@@ -680,6 +680,7 @@ module.exports = {
 
   // UDS flags
   TNS_UDS_FLAGS_IS_JSON: 0x00000100,
+  TNS_UDS_FLAGS_IS_OSON: 0x00000800,
 
   // other constants
   TNS_MAX_SHORT_LENGTH: 252,

lib/thin/protocol/messages/withData.js

@@ -223,6 +223,7 @@ class MessageWithData extends Message {
       nullable: nullable
     };
     fetchInfo.isJson = Boolean(udsFlags & constants.TNS_UDS_FLAGS_IS_JSON);
+    fetchInfo.isOson = Boolean(udsFlags & constants.TNS_UDS_FLAGS_IS_OSON);
     if (buf.caps.ttcFieldVersion >= constants.TNS_CCAP_FIELD_VERSION_23_1) {
       numBytes = buf.readUB4();
       if (numBytes > 0) {

odpi

@@ -428,6 +428,7 @@ struct njsBaton {
     bool sodaMetadataCache;
     bool keepInStmtCache;
     bool isJson;
+    bool isOson;
 
     // LOB buffer (requires free only if string was used)
     uint64_t bufferSize;
@@ -640,6 +641,7 @@ struct njsVariable {
     bool isArray;
     bool isNullable;
     bool isJson;
+    bool isOson;
     const char *domainSchema;
     size_t domainSchemaLength;
     const char *domainName;

src/njsModule.h

@@ -275,6 +275,11 @@ bool njsVariable_getMetadataOne(njsVariable *var, napi_env env,
     NJS_CHECK_NAPI(env, napi_set_named_property(env, *metadata, "isJson",
             temp))
 
+    // store isOson
+    NJS_CHECK_NAPI(env, napi_get_boolean(env, var->isOson, &temp))
+    NJS_CHECK_NAPI(env, napi_set_named_property(env, *metadata, "isOson",
+            temp))
+
     // store domainSchema
     if (var->domainSchemaLength) {
         NJS_CHECK_NAPI(env, napi_create_string_utf8(env, var->domainSchema,
@@ -486,6 +491,7 @@ bool njsVariable_initForQuery(njsVariable *vars, uint32_t numVars,
         if (queryInfo.typeInfo.objectType)
             vars[i].dpiObjectTypeHandle = queryInfo.typeInfo.objectType;
         vars[i].isJson = queryInfo.typeInfo.isJson;
+        vars[i].isOson = queryInfo.typeInfo.isOson;
         if (queryInfo.typeInfo.domainSchemaLength) {
             vars[i].domainSchemaLength = queryInfo.typeInfo.domainSchemaLength;
             vars[i].domainSchema = queryInfo.typeInfo.domainSchema;

src/njsVariable.c

@@ -41,6 +41,7 @@ const fs       = require('fs');
 const assert   = require('assert');
 const dbConfig = require('./dbconfig.js');
 const assist   = require('./dataTypeAssist.js');
+const testsUtil = require(`./testsUtil.js`);
 
 const inFileName = 'test/fuzzydinosaur.jpg';  // contains the image to be inserted
 const outFileName = 'test/blobstreamout.jpg';
@@ -153,4 +154,42 @@ describe('41. dataTypeBlob.js', function() {
     });
   });
 
+  describe('41.3 OSON column metadata ', function() {
+    let isRunnable = false;
+    const TABLE = "nodb_myblobs_oson_col";
+    const createTable = (`CREATE TABLE ${TABLE} (
+        IntCol number(9) not null,
+        OsonCol  blob not null,
+        blobCol  blob not null,
+        constraint TestOsonCols_ck_1 check (OsonCol is json format oson)
+        )`
+    );
+    const plsql = testsUtil.sqlCreateTable(TABLE, createTable);
+
+    before('create table', async function() {
+      if (testsUtil.getClientVersion() >= 2100000000 &&
+        connection.oracleServerVersion >= 2100000000) {
+        isRunnable = true;
+      }
+
+      if (!isRunnable) {
+        this.skip();
+      }
+
+      await connection.execute(plsql);
+    });
+
+    after(async function() {
+      await connection.execute(testsUtil.sqlDropTable(TABLE));
+    });
+
+    it('41.3.1 Verify isOson flag in column metadata', async function() {
+      const result = await connection.execute(`select * from ${TABLE}`);
+      assert.strictEqual(result.metaData[0].isOson, false);
+      assert.strictEqual(result.metaData[1].isOson, true);
+      assert.strictEqual(result.metaData[2].isOson, false);
+    }); // 41.3.1
+
+  }); //41.3
+
 });

test/dataTypeBlob.js

@@ -654,6 +654,8 @@ Overview of node-oracledb functional tests
         41.1.2 BLOB getData()
     41.2 stores null value correctly
         41.2.1 testing Null, Empty string and Undefined
+    41.3 OSON column metadata
+        41.3.1 Verify isOson flag in column metadata
 
 42. dataTypeRaw.js
     42.1 testing RAW data in various lengths