oracledb 6.5.1 → 6.6.0

package/lib/errors.js

@@ -156,6 +156,13 @@ const ERR_VECTOR_VERSION_NOT_SUPPORTED = 145;
 const ERR_OBJECT_IS_NOT_A_COLLECTION = 146;
 const ERR_CURSOR_HAS_BEEN_CLOSED = 147;
 const ERR_DML_RETURNING_DUP_BINDS = 149;
+const ERR_INVALID_TPC_BEGIN_FLAGS = 150;
+const ERR_INVALID_TPC_END_FLAGS = 151;
+const ERR_UNKNOWN_TRANSACTION_STATE = 152;
+const ERR_INVALID_TRANSACTION_SIZE = 153;
+const ERR_INVALID_BRANCH_SIZE = 154;
+const ERR_OPERATION_NOT_SUPPORTED_ON_BFILE = 155;
+const ERR_OPERATION_ONLY_SUPPORTED_ON_BFILE = 156;
 
 // Oracle Net layer errors start from 500
 const ERR_CONNECTION_CLOSED = 500;
@@ -179,6 +186,13 @@ const ERR_INVALID_SERVICE_NAME = 518;
 const ERR_INVALID_SID = 519;
 const ERR_TNS_NAMES_FILE_MISSING = 520;
 const ERR_CONNECTION_EOF = 521;
+const ERR_AZURE_CONFIG_PROVIDER_AUTH_FAILED = 522;
+const ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG = 523;
+const ERR_CONFIG_PROVIDER_NOT_SUPPORTED = 524;
+const ERR_CONFIG_PROVIDER_LOAD_FAILED = 525;
+const ERR_OCIOBJECT_CONFIG_PROVIDER_AUTH_FAILED = 526;
+const ERR_AZURE_VAULT_AUTH_FAILED = 527;
+const ERR_AZURE_SERVICE_PRINCIPAL_AUTH_FAILED = 528;
 
 // Oracle SUCCESS_WITH_INFO warning start from 700
 const WRN_COMPILATION_CREATE = 700;
@@ -434,6 +448,20 @@ messages.set(ERR_CURSOR_HAS_BEEN_CLOSED,                // NJS-147
   'cursor has been closed by the database');
 messages.set(ERR_DML_RETURNING_DUP_BINDS,               // NJS-149
   'the bind variable placeholder "%s" cannot be used both before and after the RETURNING clause in a DML RETURNING statement');
+messages.set(ERR_INVALID_TPC_BEGIN_FLAGS,               // NJS-150
+  'invalid flags for tpcBegin() in Two Phase Commit');
+messages.set(ERR_INVALID_TPC_END_FLAGS,                 // NJS-151
+  'invalid flags for tpcEnd() in Two Phase Commit');
+messages.set(ERR_UNKNOWN_TRANSACTION_STATE,             // NJS-152
+  'internal error: unknown transaction state {state} in Two Phase Commit');
+messages.set(ERR_INVALID_TRANSACTION_SIZE,              // NJS-153
+  'size of the transaction ID is %d and cannot exceed 64');
+messages.set(ERR_INVALID_BRANCH_SIZE,              // NJS-154
+  'size of the branch ID is %d and cannot exceed 64');
+messages.set(ERR_OPERATION_NOT_SUPPORTED_ON_BFILE,      // NJS-155
+  'operation is not supported on BFILE LOBs');
+messages.set(ERR_OPERATION_ONLY_SUPPORTED_ON_BFILE,     // NJS-156
+  'operation is only supported on BFILE LOBs');
 
 // Oracle Net layer errors
 
@@ -479,7 +507,20 @@ messages.set(ERR_TNS_NAMES_FILE_MISSING,                // NJS-520
   'cannot connect to Oracle Database. File tnsnames.ora not found in %s');
 messages.set(ERR_CONNECTION_EOF,                        // NJS-521
   'connection to host %s port %d received end-of-file on communication channel. (CONNECTION_ID=%s)');
-
+messages.set(ERR_AZURE_CONFIG_PROVIDER_AUTH_FAILED,                        // NJS-522
+  'Azure Authentication Failed: The authentication parameter value %s may be incorrect');
+messages.set(ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG,                        // NJS-523
+  'Failed to retrieve configuration from Centralized Configuration Provider:\n %s');
+messages.set(ERR_CONFIG_PROVIDER_NOT_SUPPORTED,               // NJS-524
+  'Configuration Provider not supported: %s');
+messages.set(ERR_CONFIG_PROVIDER_LOAD_FAILED,                 // NJS-525
+  'Centralized Config Provider failed to load required libraries. Please install the required libraries.\n %s');
+messages.set(ERR_OCIOBJECT_CONFIG_PROVIDER_AUTH_FAILED,                        // NJS-526
+  'OCI authentication failed: The authentication parameter value %s may be incorrect');
+messages.set(ERR_AZURE_VAULT_AUTH_FAILED,                        // NJS-527
+  'Azure Vault: Provide correct azure vault authentication details');
+messages.set(ERR_AZURE_SERVICE_PRINCIPAL_AUTH_FAILED,                        // NJS-528
+  'Azure service principal authentication requires either a client certificate path or a client secret string');
 // Oracle SUCCESS_WITH_INFO warning
 
 messages.set(WRN_COMPILATION_CREATE,                           // NJS-700
@@ -789,6 +830,13 @@ module.exports = {
   ERR_NO_CONFIG_DIR,
   ERR_TNS_ENTRY_NOT_FOUND,
   ERR_CONNECTION_EOF,
+  ERR_AZURE_CONFIG_PROVIDER_AUTH_FAILED,
+  ERR_OCIOBJECT_CONFIG_PROVIDER_AUTH_FAILED,
+  ERR_AZURE_VAULT_AUTH_FAILED,
+  ERR_AZURE_SERVICE_PRINCIPAL_AUTH_FAILED,
+  ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG,
+  ERR_CONFIG_PROVIDER_NOT_SUPPORTED,
+  ERR_CONFIG_PROVIDER_LOAD_FAILED,
   ERR_INVALID_BIND_NAME,
   ERR_WRONG_NUMBER_OF_POSITIONAL_BINDS,
   ERR_BUFFER_LENGTH_INSUFFICIENT,
@@ -841,7 +889,14 @@ module.exports = {
   ERR_OBJECT_IS_NOT_A_COLLECTION,
   ERR_CURSOR_HAS_BEEN_CLOSED,
   ERR_DML_RETURNING_DUP_BINDS,
+  ERR_INVALID_TPC_BEGIN_FLAGS,
+  ERR_INVALID_TPC_END_FLAGS,
+  ERR_UNKNOWN_TRANSACTION_STATE,
+  ERR_INVALID_TRANSACTION_SIZE,
+  ERR_INVALID_BRANCH_SIZE,
   ERR_CONNECTION_CLOSED_CODE: `${ERR_PREFIX}-${ERR_CONNECTION_CLOSED}`,
+  ERR_OPERATION_NOT_SUPPORTED_ON_BFILE,
+  ERR_OPERATION_ONLY_SUPPORTED_ON_BFILE,
   WRN_COMPILATION_CREATE,
   assert,
   assertArgCount,

package/lib/impl/datahandlers/constants.js

@@ -32,7 +32,8 @@ module.exports = {
 
   // vector constants
   TNS_VECTOR_MAGIC_BYTE: 0xDB,
-  TNS_VECTOR_VERSION: 0,
+  TNS_VECTOR_VERSION_BASE: 0,
+  TNS_VECTOR_VERSION_WITH_BINARY: 1,
 
   // vector flags
   TNS_VECTOR_FLAG_NORMSRC: 0x0010,
@@ -99,6 +100,7 @@ module.exports = {
   VECTOR_FORMAT_FLOAT32: constants.VECTOR_FORMAT_FLOAT32,
   VECTOR_FORMAT_FLOAT64: constants.VECTOR_FORMAT_FLOAT64,
   VECTOR_FORMAT_INT8: constants.VECTOR_FORMAT_INT8,
+  VECTOR_FORMAT_BINARY: constants.VECTOR_FORMAT_BINARY,
 
   TNS_NULL_LENGTH_INDICATOR: 255,
   TNS_LONG_LENGTH_INDICATOR: 254,

package/lib/impl/datahandlers/vector.js

@@ -50,11 +50,11 @@ class VectorDecoder extends BaseBuffer {
       errors.throwErr(errors.ERR_UNEXPECTED_DATA,
         Buffer.from([magicByte]).toString('hex'));
     const version = this.readUInt8();
-    if (version != constants.TNS_VECTOR_VERSION)
+    if (version > constants.TNS_VECTOR_VERSION_WITH_BINARY)
       errors.throwErr(errors.ERR_VECTOR_VERSION_NOT_SUPPORTED, version);
     const flags = this.readUInt16BE();
     const vectorFormat = this.readUInt8();
-    const numElements = this.readUInt32BE();
+    let numElements = this.readUInt32BE();
     let elementSize, result;
     if (vectorFormat === constants.VECTOR_FORMAT_FLOAT32) {
       elementSize = 4;
@@ -65,10 +65,18 @@ class VectorDecoder extends BaseBuffer {
     } else if (vectorFormat === constants.VECTOR_FORMAT_INT8) {
       elementSize = 1;
       result = new Int8Array(numElements);
+    } else if (vectorFormat === constants.VECTOR_FORMAT_BINARY) {
+      elementSize = 1;
+      // The number of dimensions are assumed to be multiple of 8.
+      numElements = numElements / 8;
+      result = new Uint8Array(numElements);
     } else {
       errors.throwErr(errors.ERR_VECTOR_FORMAT_NOT_SUPPORTED, vectorFormat);
     }
-    if (flags & constants.TNS_VECTOR_FLAG_NORM)
+
+    // For binary vector, NORM will never be present but space for NORM is reserved to keep
+    // same header lengh across the different vector formats.
+    if (vectorFormat === constants.VECTOR_FORMAT_BINARY || flags & constants.TNS_VECTOR_FLAG_NORM)
       this.skipBytes(8);
 
     // parse data
@@ -100,6 +108,10 @@ class VectorEncoder extends GrowableBuffer {
     // determine some basic information about the vector
     let vectorFormat = constants.VECTOR_FORMAT_FLOAT32;
     let writeFn = this.writeBinaryFloat.bind(this);
+    let numElements = value.length;
+    let vectorVersion = constants.TNS_VECTOR_VERSION_BASE;
+    let flags = constants.TNS_VECTOR_FLAG_NORMSRC
+      | constants.TNS_VECTOR_FLAG_NORM; // NORM is present and reserve space.
 
     if (Array.isArray(value) || value instanceof Float64Array) {
       vectorFormat = constants.VECTOR_FORMAT_FLOAT64;
@@ -107,18 +119,21 @@ class VectorEncoder extends GrowableBuffer {
     } else if (value instanceof Int8Array) {
       vectorFormat = constants.VECTOR_FORMAT_INT8;
       writeFn = this.writeSB1.bind(this);
+    } else if (value.constructor.name === 'Uint8Array') {
+      vectorFormat = constants.VECTOR_FORMAT_BINARY;
+      // The number of dimensions are assumed to be multiple of 8.
+      numElements = numElements * 8;
+      vectorVersion = constants.TNS_VECTOR_VERSION_WITH_BINARY;
+      flags = constants.TNS_VECTOR_FLAG_NORMSRC; // only space is reserved.
+      writeFn = this.writeUInt8.bind(this);
     }
 
-    // Let server generate the norm (TNS_VECTOR_FLAG_NORMSRC)
-    const flags = constants.TNS_VECTOR_FLAG_NORM
-      | constants.TNS_VECTOR_FLAG_NORMSRC;
-
     // write header
     this.writeUInt8(constants.TNS_VECTOR_MAGIC_BYTE);
-    this.writeUInt8(constants.TNS_VECTOR_VERSION);
+    this.writeUInt8(vectorVersion);
     this.writeUInt16BE(flags);
     this.writeUInt8(vectorFormat);
-    this.writeUInt32BE(value.length);
+    this.writeUInt32BE(numElements);
     this.reserveBytes(8);
 
     // write data

package/lib/impl/lob.js

@@ -53,6 +53,15 @@ class LobImpl {
     errors.throwNotImplemented("closing a LOB");
   }
 
+  //---------------------------------------------------------------------------
+  // fileExists()
+  //
+  // Checks if BFILE present or not.
+  //---------------------------------------------------------------------------
+  fileExists() {
+    errors.throwNotImplemented("check if BFILE exists");
+  }
+
   //---------------------------------------------------------------------------
   // getData()
   //
@@ -62,6 +71,15 @@ class LobImpl {
     errors.throwNotImplemented("getting all of the data from a LOB");
   }
 
+  //---------------------------------------------------------------------------
+  // getDirFileName()
+  //
+  // returns directory and filename of LOB (BFILE).
+  //----------------------------------------------------------------------------
+  getDirFileName() {
+    errors.throwNotImplemented("getting directory and filename of LOB(BFILE)");
+  }
+
   //---------------------------------------------------------------------------
   // read()
   //
@@ -71,6 +89,15 @@ class LobImpl {
     errors.throwNotImplemented("reading from a LOB");
   }
 
+  //---------------------------------------------------------------------------
+  // setDirFileName()
+  //
+  // sets directory and filename for LOB (BFILE)
+  //---------------------------------------------------------------------------
+  setDirFileName() {
+    errors.throwNotImplemented("setting directory and filename of LOB(BFILE)");
+  }
+
   //---------------------------------------------------------------------------
   // write()
   //

package/lib/impl/resultset.js

@@ -236,7 +236,8 @@ class ResultSetImpl {
         this.nestedCursorIndices.push(i);
       } else if (info.fetchType === types.DB_TYPE_CLOB ||
           info.fetchType === types.DB_TYPE_NCLOB ||
-          info.fetchType === types.DB_TYPE_BLOB) {
+          info.fetchType === types.DB_TYPE_BLOB ||
+          info.fetchType === types.DB_TYPE_BFILE) {
         this.lobIndices.push(i);
       } else if (info.fetchType === types.DB_TYPE_OBJECT) {
         this.dbObjectIndices.push(i);
@@ -275,6 +276,30 @@ class ResultSetImpl {
     errors.throwNotImplemented("getting rows");
   }
 
+  //---------------------------------------------------------------------------
+  // _getAllRows() [INTERNAL]
+  //
+  // Fetches all the rows from the database to use internally.
+  //---------------------------------------------------------------------------
+  async _getAllRows() {
+    const fetchArraySize = 100;
+    // fetch all rows
+    let rowsFetched = [];
+    while (true) {    // eslint-disable-line
+      // constant default value for fetchArraySize
+      const rows = await this.getRows(fetchArraySize, {});
+      if (rows) {
+        await this._processRows(rows, false);
+        rowsFetched = rowsFetched.concat(rows);
+      }
+      if (rows.length < fetchArraySize) {
+        break;
+      }
+    }
+
+    return rowsFetched;
+  }
+
 }
 
 module.exports = ResultSetImpl;

package/lib/lob.js

@@ -46,6 +46,22 @@ class Lob extends Duplex {
     });
   }
 
+  // called by BFILE specific functions to throw errors for other
+  // datatypes.
+  _checkIsBfile() {
+    if (this.type !== types.DB_TYPE_BFILE) {
+      errors.throwErr(errors.ERR_OPERATION_ONLY_SUPPORTED_ON_BFILE);
+    }
+  }
+
+  // called by functions not allowed for BFILE and throw errors if
+  // such operations are performed on BFILE.
+  _checkNotBfile() {
+    if (this.type === types.DB_TYPE_BFILE) {
+      errors.throwErr(errors.ERR_OPERATION_NOT_SUPPORTED_ON_BFILE);
+    }
+  }
+
   // called by stream.destroy() and ensures that the LOB is closed if it has
   // not already been closed (never called directly)
   async _destroy(err, cb) {
@@ -101,7 +117,10 @@ class Lob extends Duplex {
   // called to associate a LOB implementation with this user facing object
   _setup(lobImpl, autoCloseLob) {
     this._impl = lobImpl;
-    this._chunkSize = lobImpl.getChunkSize();
+    // chunk size is not defined for BFILE LOBs
+    if (this.type !== types.DB_TYPE_BFILE) {
+      this._chunkSize = lobImpl.getChunkSize();
+    }
     this._pieceSize = lobImpl.getPieceSize();
     this._length = lobImpl.getLength();
     this._type = lobImpl.getType();
@@ -153,6 +172,7 @@ class Lob extends Duplex {
   // Property for the chunk size of the LOB.
   //---------------------------------------------------------------------------
   get chunkSize() {
+    this._checkNotBfile();
     return this._chunkSize;
   }
 
@@ -209,6 +229,36 @@ class Lob extends Duplex {
     return await this._impl.getData(offset, amount);
   }
 
+  //---------------------------------------------------------------------------
+  // getDirFileName()
+  //  To obtain the BFILE Lob object properties dirName & fileName
+  //---------------------------------------------------------------------------
+  getDirFileName() {
+    this._checkIsBfile();
+    return this._impl.getDirFileName();
+  }
+
+  //--------------------------------------------------------------------------
+  // setDirFileName()
+  //  To set the BFILE Lob object properties dirName & fileName
+  //--------------------------------------------------------------------------
+  setDirFileName(a1) {
+    this._checkIsBfile();
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(nodbUtil.isObject(a1), 1);
+    this._impl.setDirFileName(a1);
+  }
+
+  //---------------------------------------------------------------------------
+  // fileExists
+  //
+  //   To obtain file existence status of BFILE file
+  //---------------------------------------------------------------------------
+  async fileExists() {
+    this._checkIsBfile();
+    return await this._impl.fileExists();
+  }
+
   //---------------------------------------------------------------------------
   // length
   //
@@ -248,6 +298,7 @@ class Lob extends Duplex {
 
 nodbUtil.wrapFns(Lob.prototype, errors.ERR_BUSY_LOB,
   "close",
+  "fileExists",
   "getData");
 Lob.prototype._serializedRead = nodbUtil.serialize(Lob.prototype._readData);
 Lob.prototype._serializedWrite = nodbUtil.serialize(Lob.prototype._writeData);

package/lib/oracledb.js

@@ -129,6 +129,7 @@ async function _verifyOptions(options, inCreatePool) {
   // define normalized options (value returned to caller)
   const outOptions = {};
 
+  options = await _checkConfigProvider(options);
   // only one of "user" and "username" may be specified (and must be strings)
   if (options.user !== undefined) {
     errors.assertParamPropValue(typeof options.user === 'string', 1, "user");
@@ -177,6 +178,13 @@ async function _verifyOptions(options, inCreatePool) {
     outOptions.walletLocation = options.walletLocation;
   }
 
+  //wallet content must be a string
+  if (options.walletContent !== undefined) {
+    errors.assertParamPropValue(typeof options.walletContent === 'string', 1,
+      "walletContent");
+    outOptions.walletContent = options.walletContent;
+  }
+
   // edition must be a string
   if (options.edition !== undefined) {
     errors.assertParamPropValue(typeof options.edition === 'string', 1,
@@ -760,6 +768,51 @@ async function shutdown(a1, a2) {
   await conn.close();
 }
 
+//-----------------------------------------------------------------------------
+// _checkConfigProvider()
+//
+// Look for the config provider in the connection string and retreives
+// object stored in the config Provider.
+// Returns object based on precedence between input object and the one retrieved
+// from Config Provider.
+//-----------------------------------------------------------------------------
+async function _checkConfigProvider(options) {
+  const url = options.connectString || options.connectionString;
+  if (!url)
+    return options;
+  let parsedUrl = url;
+  let urlExtendedPart;
+  const baseRegex = new RegExp("^config-(?<provider>[A-Za-z0-9]+)(://)(?<provider_arg>[^?]+)");
+  if (url.indexOf('?') != -1) {
+    parsedUrl = url.substring(0, url.indexOf('?'));
+    urlExtendedPart = url.substring(url.indexOf('?'), url.length); //extended part
+  }
+  const match = parsedUrl.match(baseRegex);
+  if (match) {
+    const provider = match.groups.provider;
+    const provider_arg = match.groups.provider_arg;
+    let configPckg;
+    try {
+      configPckg = require('./configProviders/' + provider);
+    } catch (err) {
+      errors.throwErr(errors.ERR_CONFIG_PROVIDER_NOT_SUPPORTED, provider);
+    }
+    const configProvider = new configPckg(provider_arg, urlExtendedPart);
+    try {
+      configProvider.init();
+    } catch (err) {
+      errors.throwErr(errors.ERR_CONFIG_PROVIDER_LOAD_FAILED, err.message);
+    }
+    let secondOpts;
+    try {
+      secondOpts = await configProvider.returnConfig();
+    } catch (err) {
+      errors.throwErr(errors.ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG, err.message);
+    }
+    options = configProvider.modifyOptionsPrecedence(secondOpts, options);
+  }
+  return options;
+}
 
 //-----------------------------------------------------------------------------
 // startup()
@@ -1007,6 +1060,7 @@ module.exports = {
   VECTOR_FORMAT_FLOAT32: constants.VECTOR_FORMAT_FLOAT32,
   VECTOR_FORMAT_FLOAT64: constants.VECTOR_FORMAT_FLOAT64,
   VECTOR_FORMAT_INT8: constants.VECTOR_FORMAT_INT8,
+  VECTOR_FORMAT_BINARY: constants.VECTOR_FORMAT_BINARY,
 
   // database type aliases
   BLOB: types.DB_TYPE_BLOB,