Add DB_TYPE_XMLTYPE for XMLTYPE db column

Author: sharadraju

doc/src/api_manual/oracledb.rst

@@ -178,6 +178,9 @@ instead of ``result.metadata[0].fetchType == 2001``.
     * - ``oracledb.DB_TYPE_VARCHAR``
       - 2001
       - VARCHAR2
+    * - ``oracledb.DB_TYPE_XMLTYPE``
+      - 2032
+      - XMLTYPE
 
 Note that the values for these constants changed in node-oracledb 4.0.
 

doc/src/release_notes.rst

@@ -13,6 +13,10 @@ node-oracledb `v6.3.0 <https://github.com/oracle/node-oracledb/compare/v6.2.0...
 Common Changes
 ++++++++++++++
 
+#)  Added constant ``oracledb.DB_TYPE_XMLTYPE`` to represent data of type
+    ``SYS.XMLTYPE`` in metadata ``fetchType`` and ``dbType`` attributes.
+    Previously the constant used was ``oracledb.DB_TYPE_LONG`` in Thick mode.
+
 #)  Added support for using the Azure and Oracle Cloud Infrastructure (OCI)
     Software Development Kits (SDKs) to generate
     :ref:`authentication tokens <tokenbasedauthentication>`.

doc/src/user_guide/appendix_a.rst

@@ -763,8 +763,8 @@ when binding numeric values.
       - DB_TYPE_OBJECT
       - Thick mode only
     * - XMLType
-      - Not applicable
-      - No
+      - DB_TYPE_XMLTYPE
+      - Thick mode only
 
 .. _testingmode:
 

lib/oracledb.js

@@ -867,6 +867,7 @@ module.exports = {
   DB_TYPE_TIMESTAMP_LTZ: types.DB_TYPE_TIMESTAMP_LTZ,
   DB_TYPE_TIMESTAMP_TZ: types.DB_TYPE_TIMESTAMP_TZ,
   DB_TYPE_VARCHAR: types.DB_TYPE_VARCHAR,
+  DB_TYPE_XMLTYPE: types.DB_TYPE_XMLTYPE,
 
   // fetchInfo type defaulting
   DEFAULT: constants.DEFAULT,

lib/types.js

@@ -196,6 +196,9 @@ const DB_TYPE_UROWID = new DbType(2030,
 const DB_TYPE_VARCHAR = new DbType(2001,
   "DB_TYPE_VARCHAR", "VARCHAR2",
   { oraTypeNum: 1, csfrm: constants.CSFRM_IMPLICIT, bufferSizeFactor: 4 });
+const DB_TYPE_XMLTYPE = new DbType(2032,
+  "DB_TYPE_XMLTYPE", "XMLTYPE",
+  { oraTypeNum: 109, csfrm: constants.CSFRM_IMPLICIT, bufferSizeFactor: 2147483647 });
 
 // database type conversion map: the top level key refers to the database
 // type being fetched and the value is another map; this map's key is the
@@ -304,7 +307,8 @@ const DB_TYPE_FETCH_TYPE_MAP = new Map([
   [DB_TYPE_TIMESTAMP_LTZ, DB_TYPE_TIMESTAMP_TZ],
   [DB_TYPE_TIMESTAMP_TZ, DB_TYPE_TIMESTAMP_TZ],
   [DB_TYPE_UROWID, DB_TYPE_UROWID],
-  [DB_TYPE_VARCHAR, DB_TYPE_VARCHAR]
+  [DB_TYPE_VARCHAR, DB_TYPE_VARCHAR],
+  [DB_TYPE_XMLTYPE, DB_TYPE_XMLTYPE]
 ]);
 
 // additional aliases for types by column type name
@@ -351,6 +355,7 @@ module.exports = {
   DB_TYPE_VARCHAR,
   DB_TYPE_CONVERSION_MAP,
   DB_TYPE_FETCH_TYPE_MAP,
+  DB_TYPE_XMLTYPE,
   getTypeByColumnTypeName,
   getTypeByNum,
   getTypeByOraTypeNum

src/njsResultSet.c

@@ -334,6 +334,7 @@ static bool njsResultSet_setFetchTypes(napi_env env, njsResultSet *rs,
             case DPI_ORACLE_TYPE_LONG_NVARCHAR:
             case DPI_ORACLE_TYPE_LONG_VARCHAR:
             case DPI_ORACLE_TYPE_LONG_RAW:
+            case DPI_ORACLE_TYPE_XMLTYPE:
                 var->maxSize = (uint32_t) -1;
                 break;
             case DPI_ORACLE_TYPE_DATE:

src/njsVariable.c

@@ -62,6 +62,7 @@ bool njsVariable_createBuffer(njsVariable *var, njsConnection *conn,
         case DPI_ORACLE_TYPE_LONG_NVARCHAR:
         case DPI_ORACLE_TYPE_LONG_VARCHAR:
         case DPI_ORACLE_TYPE_LONG_RAW:
+        case DPI_ORACLE_TYPE_XMLTYPE:
             var->nativeTypeNum = DPI_NATIVE_TYPE_BYTES;
             break;
         case DPI_ORACLE_TYPE_NATIVE_FLOAT:

test/constants.js

@@ -79,6 +79,7 @@ describe('18. constants.js', function() {
     assert.strictEqual(2014, oracledb.DB_TYPE_TIMESTAMP_LTZ.num);
     assert.strictEqual(2013, oracledb.DB_TYPE_TIMESTAMP_TZ.num);
     assert.strictEqual(2001, oracledb.DB_TYPE_VARCHAR.num);
+    assert.strictEqual(2032, oracledb.DB_TYPE_XMLTYPE.num);
 
   });
 

test/dataTypeXML.js

@@ -106,10 +106,19 @@ describe('181. dataTypeXML.js', function() {
   it('181.1 basic case, insert XML data and query back', async () => {
     const conn = await oracledb.getConnection(dbConfig);
     const sql = "select content from " + tableName + " where num = :id";
+    const expectedMetadata = {
+      name: 'CONTENT',
+      dbType: oracledb.DB_TYPE_XMLTYPE,
+      nullable: false,
+      isJson: false,
+      dbTypeName: 'XMLTYPE',
+      fetchType: oracledb.DB_TYPE_XMLTYPE
+    };
     const bindVar = { id: testRowID };
     const options = { outFormat: oracledb.OUT_FORMAT_OBJECT };
     const result = await conn.execute(sql, bindVar, options);
     assert.strictEqual(result.rows[0].CONTENT, testXMLData);
+    assert.deepStrictEqual(result.metaData[0], expectedMetadata);
     await conn.close();
   }); // 181.1