oracledb 6.2.0 → 6.4.0

package/lib/thin/sqlnet/constants.js

@@ -27,175 +27,175 @@
 
 module.exports =  {
   // TNS packet types
-  NSPTCN : 1,          // Connect
-  NSPTAC : 2,          // Accept
-  NSPTAK : 3,          // Acknowledge
-  NSPTRF : 4,          // Refuse
-  NSPTRD : 5,          // Redirect
-  NSPTDA : 6,          // Data
-  NSPTNL : 7,          // Null
-  NSPTAB : 9,          // Abort
-  NSPTRS : 11,         // Re-send
-  NSPTMK : 12,         // Marker
-  NSPTAT : 13,         // Attention
-  NSPTCNL : 14,        // Control information
-  NSPTDD  : 15,        // data descriptor
-  NSPTHI  : 19,        // Highest legal packet type
+  NSPTCN: 1,          // Connect
+  NSPTAC: 2,          // Accept
+  NSPTAK: 3,          // Acknowledge
+  NSPTRF: 4,          // Refuse
+  NSPTRD: 5,          // Redirect
+  NSPTDA: 6,          // Data
+  NSPTNL: 7,          // Null
+  NSPTAB: 9,          // Abort
+  NSPTRS: 11,         // Re-send
+  NSPTMK: 12,         // Marker
+  NSPTAT: 13,         // Attention
+  NSPTCNL: 14,        // Control information
+  NSPTDD: 15,         // data descriptor
+  NSPTHI: 19,         // Highest legal packet type
 
   // Packet Header
-  NSPHDLEN  : 0,       // Packet length
-  NSPHDPSM  : 2,       // Packet checksum(deprecated in version 3.15 with large sdu support)
-  NSPHDTYP  : 4,       // Packet type
-  NSPHDFLGS : 5,       // Packet flags
-  NSPHDHSM  : 6,       // Header checksum
-  NSPSIZHD  : 8,       // Packet header size
+  NSPHDLEN: 0,       // Packet length
+  NSPHDPSM: 2,       // Packet checksum(deprecated in version 3.15 with large sdu support)
+  NSPHDTYP: 4,       // Packet type
+  NSPHDFLGS: 5,      // Packet flags
+  NSPHDHSM: 6,       // Header checksum
+  NSPSIZHD: 8,       // Packet header size
 
   /* Packet flags for NSPHDFLGS */
-  NSPFSID  : 0x01,     // SID is given
-  NSPFRDS  : 0x02,     // ReDirect Separation of cnda vs cndo
-  NSPFRDR  : 0x04,     // ReDiRected client Connect (NSPTCN)
-  NSPFLSD  : 0x20,     // packet with large sdu field
-  NO_HEADER_FLAGS : 0,
-  NSPFSRN  : 0x08,
+  NSPFSID: 0x01,     // SID is given
+  NSPFRDS: 0x02,     // ReDirect Separation of cnda vs cndo
+  NSPFRDR: 0x04,     // ReDiRected client Connect (NSPTCN)
+  NSPFLSD: 0x20,     // packet with large sdu field
+  NO_HEADER_FLAGS: 0,
+  NSPFSRN: 0x08,
 
   // Connect Packet
-  NSPCNVSN   : 8,    // My version number
-  NSPCNLOV   : 10,   // Lowest version number I can be compatible with
-  NSPCNOPT   : 12,   // Global service options
-  NSPCNSDU   : 14,   // My SDU size
-  NSPCNTDU   : 16,   // Maximum TDU size
-  NSPCNNTC   : 18,   // NT characterstics
-  NSPCNTNA   : 20,   // Line turnaround value
-  NSPCNONE   : 22,   // The value '1' in my hardware byte order
-  NSPCNLEN   : 24,   // Length of connect data
-  NSPCNOFF   : 26,   // Offset to connect data
-  NSPCNMXC   : 28,   // Maximum connect data you can send me
-  NSPCNFL0   : 32,   // Connect flags
-  NSPCNFL1   : 33,
-  NSPCNTMO   : 50,   // local connection timeout val
-  NSPCNTCK   : 52,   // local tick size
-  NSPCNADL   : 54,
-  NSPCNAOF   : 56,   // offset to reconnect tns addr
-  NSPCNLSD   : 58,   // large sdu
-  NSPCNLTD   : 62,   // large tdu
-  NSPCNCFL   : 66,   // compression data
-  NSPCNCFL2  : 70,   // connect flag2
+  NSPCNVSN: 8,    // My version number
+  NSPCNLOV: 10,   // Lowest version number I can be compatible with
+  NSPCNOPT: 12,   // Global service options
+  NSPCNSDU: 14,   // My SDU size
+  NSPCNTDU: 16,   // Maximum TDU size
+  NSPCNNTC: 18,   // NT characterstics
+  NSPCNTNA: 20,   // Line turnaround value
+  NSPCNONE: 22,   // The value '1' in my hardware byte order
+  NSPCNLEN: 24,   // Length of connect data
+  NSPCNOFF: 26,   // Offset to connect data
+  NSPCNMXC: 28,   // Maximum connect data you can send me
+  NSPCNFL0: 32,   // Connect flags
+  NSPCNFL1: 33,
+  NSPCNTMO: 50,   // local connection timeout val
+  NSPCNTCK: 52,   // local tick size
+  NSPCNADL: 54,
+  NSPCNAOF: 56,   // offset to reconnect tns addr
+  NSPCNLSD: 58,   // large sdu
+  NSPCNLTD: 62,   // large tdu
+  NSPCNCFL: 66,   // compression data
+  NSPCNCFL2: 70,  // connect flag2
   //  NSPCNV310DAT : (NSPCNTMO + 8), start of connect data, V3.10   packet
   //  NSPCNV315DAT : (NSPCNCFL + 4),
-  NSPCNDAT : 74,      // Start connect data
-  NSPMXCDATA : 230,   // Maximum length of connect data
+  NSPCNDAT: 74,      // Start connect data
+  NSPMXCDATA: 230,   // Maximum length of connect data
   // Connect flags (Used mostly by NA)
-  NSINAWANTED               : 0x01, // Want to use NA
-  NSINAINTCHG               : 0x02, // Interchange involved
+  NSINAWANTED: 0x01, // Want to use NA
+  NSINAINTCHG: 0x02, // Interchange involved
   NSINADISABLEDFORCONNECTION: 0x04, // Disable NA
-  NSINANOSERVICES           : 0x08, // No NA services linked
-  NSINAREQUIRED             : 0x10, // NA is required
-  NSINAAUTHWANTED           : 0x20, // Authentication linked
-  NSISUPSECRENEG            : 0x80, // bkwrd comp: SUPport SECurity RE-NEG
+  NSINANOSERVICES: 0x08, // No NA services linked
+  NSINAREQUIRED: 0x10,   // NA is required
+  NSINAAUTHWANTED: 0x20, // Authentication linked
+  NSISUPSECRENEG: 0x80,  // bkwrd comp: SUPport SECurity RE-NEG
   // Connect options
-  NSGDONTCARE               : 0x0001, // "don't care"
-  NSGHDX                    : 0x0002, // half-duplex (w/ token management)
-  NSGFDX                    : 0x0004, // full-duplex
-  NSGHDRCHKSUM              : 0x0008, // checksum on packet header
-  NSGPAKCHKSUM              : 0x0010, // checksum on entire packet
-  NSGBROKEN                 : 0x0020, // provide broken connection notification
-  NSGUSEVIO                 : 0x0040, // can use Vectored I/O
-  NSGOSAUTHOK               : 0x0080, // use OS authentication
-  NSGSENDATTN               : 0x0200, // can send attention
-  NSGRECVATTN               : 0x0400, // can recv attention
-  NSGNOATTNPR               : 0x0800, // no attention processing
-  NSGRAW                    : 0x1000, // I/O is direct to/from transport
-  TNS_VERSION_DESIRED       : 319,
-  TNS_VERSION_MINIMUM       : 300,
-  TNS_VERSION_MIN_UUID      : 319,
-  TNS_UUID_OFFSET           : 45,
+  NSGDONTCARE: 0x0001, // "don't care"
+  NSGHDX: 0x0002, // half-duplex (w/ token management)
+  NSGFDX: 0x0004, // full-duplex
+  NSGHDRCHKSUM: 0x0008, // checksum on packet header
+  NSGPAKCHKSUM: 0x0010, // checksum on entire packet
+  NSGBROKEN: 0x0020, // provide broken connection notification
+  NSGUSEVIO: 0x0040, // can use Vectored I/O
+  NSGOSAUTHOK: 0x0080, // use OS authentication
+  NSGSENDATTN: 0x0200, // can send attention
+  NSGRECVATTN: 0x0400, // can recv attention
+  NSGNOATTNPR: 0x0800, // no attention processing
+  NSGRAW: 0x1000, // I/O is direct to/from transport
+  TNS_VERSION_DESIRED: 319,
+  TNS_VERSION_MINIMUM: 300,
+  TNS_VERSION_MIN_UUID: 319,
+  TNS_UUID_OFFSET: 45,
 
   /* Accept Packet */
-  NSPACVSN : 8,   // connection version
-  NSPACOPT : 10,  // global service options
-  NSPACSDU : 12,  // SDU size
-  NSPACTDU : 14,  // Maximum TDU
-  NSPACONE : 16,  // The value '1' in my hardware byte order
-  NSPACLEN : 18,  // connect data length
-  NSPACOFF : 20,  // offset to connect data
-  NSPACFL0 : 22,  // connect flags
-  NSPACFL1 : 23,
-  NSPACTMO : 24,  // connection pool timeout value
-  NSPACTCK : 26,  // local tick size
-  NSPACADL : 28,  // reconnect tns address length
-  NSPACAOF : 30,  // offset to reconnect tns addr
-  NSPACLSD : 32,  // Large sdu
-  NSPACLTD : 36,  // Large tdu
-  NSPACCFL : 40,  // compression flag
-  NSPACFL2 : 41,  // accept flag2 (4 bytes)
-  NSPACV310DAT : 32, /* start of accept data, V3.10     packet */
-  NSPACV315DAT : 41, // start of accept data, V3.15     packet
+  NSPACVSN: 8,   // connection version
+  NSPACOPT: 10,  // global service options
+  NSPACSDU: 12,  // SDU size
+  NSPACTDU: 14,  // Maximum TDU
+  NSPACONE: 16,  // The value '1' in my hardware byte order
+  NSPACLEN: 18,  // connect data length
+  NSPACOFF: 20,  // offset to connect data
+  NSPACFL0: 22,  // connect flags
+  NSPACFL1: 23,
+  NSPACTMO: 24,  // connection pool timeout value
+  NSPACTCK: 26,  // local tick size
+  NSPACADL: 28,  // reconnect tns address length
+  NSPACAOF: 30,  // offset to reconnect tns addr
+  NSPACLSD: 32,  // Large sdu
+  NSPACLTD: 36,  // Large tdu
+  NSPACCFL: 40,  // compression flag
+  NSPACFL2: 41,  // accept flag2 (4 bytes)
+  NSPACV310DAT: 32, /* start of accept data, V3.10     packet */
+  NSPACV315DAT: 41, // start of accept data, V3.15     packet
 
   /* Refuse Packet */
-  NSPRFURS : 8,  // User (appliction) reason for refusal
-  NSPRFSRS : 9,  // System (NS) reason for
-  NSPRFLEN : 10, // Length of refuse data
-  NSPRFDAT : 12, // Start of connect data
+  NSPRFURS: 8,  // User (appliction) reason for refusal
+  NSPRFSRS: 9,  // System (NS) reason for
+  NSPRFLEN: 10, // Length of refuse data
+  NSPRFDAT: 12, // Start of connect data
   // Compression flags
-  NSPACCFON : 0x80, // 1st MSB:  compression on/off
-  NSPACCFAT : 0x40, // 2nd MSB :   compression auto
-  NSPACCFNT : 0x02, // Second last LSB : compression for non-tcp protocol
+  NSPACCFON: 0x80, // 1st MSB:  compression on/off
+  NSPACCFAT: 0x40, // 2nd MSB :   compression auto
+  NSPACCFNT: 0x02, // Second last LSB : compression for non-tcp protocol
   // Accept flag2
-  NSPACOOB     : 0x00000001, // OOB support check at connection time
-  NSGPCHKSCMD  : 0x01000000, // Support for Poll and Check logic
+  NSPACOOB: 0x00000001, // OOB support check at connection time
+  NSGPCHKSCMD: 0x01000000, // Support for Poll and Check logic
 
   /* Redirect packet */
-  NSPRDLEN : 8,   // Length of redirect data
-  NSPRDDAT : 10,  // Start of connect data
+  NSPRDLEN: 8,   // Length of redirect data
+  NSPRDDAT: 10,  // Start of connect data
 
   /* Data Packet */
-  NSPDAFLG  : 8,    // Data flags
-  NSPDADAT  : 10,   // Start of Data
-  NSPDAFEOF : 0x40, // "end of file"
+  NSPDAFLG: 8,    // Data flags
+  NSPDADAT: 10,   // Start of Data
+  NSPDAFEOF: 0x40, // "end of file"
 
   /* Marker Packet */
-  NSPMKTYP : 8,     // marker type (see below)
-  NSPMKODT : 9,     // old (pre-V3.05) data byte
-  NSPMKDAT : 10,    // data byte
-  NSPMKTD0 : 0,     // data marker - 0 data bytes
-  NSPMKTD1 : 1,     // data marker - 1 data byte
-  NSPMKTAT : 2,     // Attention Marker
-  NIQBMARK : 1,     // Break marker
-  NIQRMARK : 2,     // Reset marker
-  NIQIMARK : 3,     // Interrupt marker
+  NSPMKTYP: 8,     // marker type (see below)
+  NSPMKODT: 9,     // old (pre-V3.05) data byte
+  NSPMKDAT: 10,    // data byte
+  NSPMKTD0: 0,     // data marker - 0 data bytes
+  NSPMKTD1: 1,     // data marker - 1 data byte
+  NSPMKTAT: 2,     // Attention Marker
+  NIQBMARK: 1,     // Break marker
+  NIQRMARK: 2,     // Reset marker
+  NIQIMARK: 3,     // Interrupt marker
 
   /* Control Packet */
-  NSPCTLCMD      : 8,  // Control Command length is 2 bytes
-  NSPCTLDAT      : 10, // Control Data length is specific to the Command type.
-  NSPCTL_SERR    : 8,  // Error Control Command Type
-  NSPCTL_CLRATTN : 9,  // Clear OOB option
+  NSPCTLCMD: 8,  // Control Command length is 2 bytes
+  NSPCTLDAT: 10, // Control Data length is specific to the Command type.
+  NSPCTL_SERR: 8,  // Error Control Command Type
+  NSPCTL_CLRATTN: 9,  // Clear OOB option
 
   /* OPTIONS */
-  NSPDFSDULN  : 8192,    // default SDU size
-  NSPABSSDULN : 2097152, // maximim SDU size
-  NSPMXSDULN  : 65535,   // maximim SDU size
-  NSPMNSDULN  : 512,     // minimum SDU size
-  NSPDFTDULN  : 2097152, // default TDU size
-  NSPMXTDULN  : 2097152, // maximum TDU size
-  NSPMNTDULN  : 255,     // minimum TDU size
-  NSFIMM      : 0x0040,  // immediate close
+  NSPDFSDULN: 8192,    // default SDU size
+  NSPABSSDULN: 2097152, // maximim SDU size
+  NSPMXSDULN: 65535,   // maximim SDU size
+  NSPMNSDULN: 512,     // minimum SDU size
+  NSPDFTDULN: 2097152, // default TDU size
+  NSPMXTDULN: 2097152, // maximum TDU size
+  NSPMNTDULN: 255,     // minimum TDU size
+  NSFIMM: 0x0040,  // immediate close
 
   /* PARAMETERS */
-  DISABLE_OOB_STR      : 'DISABLE_OOB', // disable OOB parameter
-  EXPIRE_TIME          : 'EXPIRE_TIME', // expire Time
-  PEM_WALLET_FILE_NAME : 'ewallet.pem',
+  DISABLE_OOB_STR: 'DISABLE_OOB', // disable OOB parameter
+  EXPIRE_TIME: 'EXPIRE_TIME', // expire Time
+  PEM_WALLET_FILE_NAME: 'ewallet.pem',
 
   /* Get/Set options */
-  NT_MOREDATA : 1, // More Data in Transport available
-  NS_MOREDATA : 2, // More Data available to be read
-  SVCNAME     : 3, // Service name
-  SERVERTYPE  : 4, // Server type
-  REMOTEADDR  : 5, // Remote Address
-  HEALTHCHECK : 6, // Health check of connection
-  CONNCLASS   : 7, // Connection Class
-  PURITY      : 8, // Purity
-  SID         : 9, // SID
+  NT_MOREDATA: 1, // More Data in Transport available
+  NS_MOREDATA: 2, // More Data available to be read
+  SVCNAME: 3, // Service name
+  SERVERTYPE: 4, // Server type
+  REMOTEADDR: 5, // Remote Address
+  HEALTHCHECK: 6, // Health check of connection
+  CONNCLASS: 7, // Connection Class
+  PURITY: 8, // Purity
+  SID: 9, // SID
 
   /* FLAGS */
-  NSNOBLOCK : 0x0001, // Do not block
+  NSNOBLOCK: 0x0001, // Do not block
 };

package/lib/thin/sqlnet/navNodes.js

@@ -35,10 +35,10 @@ const dnsPromises = dns.promises;
 const cInfo = require("../util.js").CLIENT_INFO;
 
 const SchemaObjectFactoryInterface = {
-  ADDR:0,
-  ADDR_LIST:1,
-  DESC:2,
-  DESC_LIST:3,
+  ADDR: 0,
+  ADDR_LIST: 1,
+  DESC: 2,
+  DESC_LIST: 3,
 };
 
 /**
@@ -451,7 +451,7 @@ const NavSchemaObject = {
   CONID: "(CONNECTION_ID="
 };
 const options = {
-  all:true,
+  all: true,
 };
 /**
  * Class that navigates the address node in the tree.

package/lib/thin/sqlnet/networkSession.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -46,6 +46,7 @@ const downHostInstance = require("./connStrategy.js").SOLE_INST_DHCACHE;
 
 async function getConnectionInfo(userConfig) {
   const connStr = await resolveConnectStr(userConfig.connectString, userConfig.configDir);
+  const addressNode = await createNode(connStr);
   let nvpair;
   if (typeof connStr === 'string')
     nvpair = createNVPair(connStr);
@@ -58,7 +59,7 @@ async function getConnectionInfo(userConfig) {
   const sid =   findValue(nvpair, ["DESCRIPTION", "CONNECT_DATA", "SID"]);
   const poolPurity = findValue(nvpair, ["DESCRIPTION", "CONNECT_DATA", "POOL_PURITY"]);
 
-  return [serverVal, connClass, svcname, poolPurity, sid ];
+  return [serverVal, connClass, svcname, poolPurity, sid, addressNode ];
 }
 
 /**
@@ -510,7 +511,13 @@ class NetworkSession {
   */
   async connect(userConfig) {
     const connStr = userConfig.connectString ? userConfig.connectString : userConfig.connectionString;
-    const addressNode = await resolveAddress(connStr, userConfig.configDir);
+    let addressNode;
+    if (userConfig._connInfo) {
+      addressNode = userConfig._connInfo[5];
+      addressNode.reset();
+    } else {
+      addressNode = await resolveAddress(connStr, userConfig.configDir);
+    }
     let address;
     try {
       address = await this.getAddress(addressNode, userConfig);
@@ -523,6 +530,18 @@ class NetworkSession {
     await this.connect1(address, addressNode, userConfig);
   }
 
+  /**
+   * Force Disconnect the stream, primarily used
+   * to disconnect dead/hung connections.
+   */
+  forceDisconnect(err) {
+    if (!this.connected) {
+      return;
+    }
+    this.ntAdapter.stream.destroy(err);
+    this.connected = false;
+  }
+
   /**
    * Disconnect
    * @param {int} type of disconnect

package/lib/thin/sqlnet/ntTcp.js

@@ -228,10 +228,10 @@ class NTTCP {
           this.doDNMatch = false; //Don't match initial connect
         try {
           secureContext = tls.createSecureContext({
-            cert : this.atts.wallet,
-            key : this.atts.wallet,
+            cert: this.atts.wallet,
+            key: this.atts.wallet,
             passphrase: this.atts.walletPassword,
-            ca : this.atts.wallet,
+            ca: this.atts.wallet,
           });
         } catch (err) {
           errors.throwErr(errors.ERR_TLS_INIT_FAILURE);
@@ -415,7 +415,7 @@ class NTTCP {
           buf: tempBuf.subarray(0, len),
           type: tempBuf[4],
           flags: tempBuf[5],
-          num : this.packetNum++
+          num: this.packetNum++
         };
         this.packets.push(packet);
         if (this.readWaiter) {
@@ -474,10 +474,10 @@ class NTTCP {
       this.checkErr();
       this.doDNMatch = true;
       const secureContext = tls.createSecureContext({
-        cert : this.atts.wallet,
-        key : this.atts.wallet,
+        cert: this.atts.wallet,
+        key: this.atts.wallet,
         passphrase: this.atts.walletPassword,
-        ca : this.atts.wallet,
+        ca: this.atts.wallet,
       });
       await this.tlsConnect(secureContext, this.connStream);
     } finally {

package/lib/thin/statement.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -142,7 +142,7 @@ class Parser {
           break;
         }
         inComment = true;
-      } else if (!exitingComment && ch === '*') {
+      } else if (ch === '*') {
         exitingComment = true;
       } else if (exitingComment) {
         if (ch === '/') {
@@ -219,10 +219,10 @@ class Parser {
 
   /**
    * Single line comments consist of two dashes and all characters up to the
-   * next line break. This method is called when the first dash is detected
-   * and checks for the subsequent dash. If found, the single line comment
-   * is traversed and the current position is updated; otherwise, the
-   * current position is left untouched.
+   * next line break (or the end of the data). This method is called when
+   * the first dash is detected and checks for the subsequent dash. If found,
+   * the single line comment is traversed and the current position is updated;
+   * otherwise, the current position is left untouched.
    */
   _parseSingleLineComment() {
     let inComment = false;
@@ -233,15 +233,15 @@ class Parser {
       ch = this.sqlData[pos];
       if (!inComment) {
         if (ch !== '-') {
-          break;
+          return;
         }
         inComment = true;
       } else if (ch === '\n') {
-        this.pos = pos;
         break;
       }
       pos += 1;
     }
+    this.pos = pos;
   }
 
   /**

package/lib/thin/statementCache.js

@@ -0,0 +1,167 @@
+// Copyright (c) 2024, Oracle and/or its affiliates.
+
+//-----------------------------------------------------------------------------
+//
+// This software is dual-licensed to you under the Universal Permissive License
+// (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+// 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+// either license.
+//
+// If you elect to accept the software under the Apache License, Version 2.0,
+// the following applies:
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Node file defining the StatementCache class used to manage cached statements
+//-----------------------------------------------------------------------------
+
+const errors = require("../errors.js");
+const { Statement } = require("./statement");
+
+class StatementCache {
+  constructor(maxSize) {
+    this._cachedStatements = new Map();
+    this._maxSize = maxSize;
+    this._cursorsToClose = new Set();
+    this._openCursors = new Set();
+  }
+
+  //---------------------------------------------------------------------------
+  // _addCursorToClose()
+  //
+  // Add the statement's cursor to the list of cursors that need to be closed.
+  //---------------------------------------------------------------------------
+  _addCursorToClose(statement) {
+    if (this._cursorsToClose.has(statement.cursorId)) {
+      const reason = `attempt to close cursor ${statement.cursorId} twice`;
+      errors.throwErr(errors.ERR_INTERNAL, reason);
+    }
+    if (statement.cursorId != 0) {
+      this._cursorsToClose.add(statement.cursorId);
+    }
+    this._openCursors.delete(statement);
+  }
+
+  //---------------------------------------------------------------------------
+  // _adjustCache()
+  // Adjust the cache so that no more than the maximum number of statements
+  // are cached by removing least recently used statements
+  //---------------------------------------------------------------------------
+  _adjustCache() {
+    while (this._cachedStatements.size > this._maxSize) {
+      const sql = this._cachedStatements.keys().next().value;
+      const stmt = this._cachedStatements.get(sql);
+      this._cachedStatements.delete(sql);
+      if (stmt.inUse) {
+        stmt.returnToCache = false;
+      } else if (stmt.cursorId !== 0) {
+        this._addCursorToClose(stmt);
+      }
+    }
+  }
+
+  //---------------------------------------------------------------------------
+  //clearOpenCursors() {
+  // Clears the list of open cursors and removes the list of cursors that
+  // need to be closed. This is required when a DRCP session change has
+  // taken place as the cursor ID values are invalidated.
+  //---------------------------------------------------------------------------
+  clearOpenCursors() {
+    const newOpenCursors = new Set();
+    for (const stmt of this._openCursors) {
+      stmt.cursorId = 0;
+      if (stmt.inUse) {
+        newOpenCursors.add(stmt);
+      }
+    }
+    this._openCursors = newOpenCursors;
+  }
+
+  //---------------------------------------------------------------------------
+  // get_statement()
+  // Get a statement from the statement cache, or prepare a new statement
+  // for use. If a statement is already in use or the statement is not
+  // supposed to be cached, a copy will be made (and not returned to the
+  // cache).
+  //---------------------------------------------------------------------------
+  getStatement(sql, cacheStatement = false) {
+    let stmt = null;
+    if (sql) {
+      stmt = this._cachedStatements.get(sql);
+      if (!cacheStatement) {
+        this._openCursors.add(stmt);
+        this._cachedStatements.delete(sql);
+      }
+    }
+    if (!stmt) {
+      stmt = new Statement();
+      if (sql) {
+        stmt._prepare(sql);
+      }
+      if (cacheStatement && !stmt.isDdl && this._maxSize > 0) {
+        stmt.returnToCache = true;
+        this._cachedStatements.set(sql, stmt);
+        this._adjustCache();
+      }
+      this._openCursors.add(stmt);
+    } else if (stmt.inUse || !cacheStatement) {
+      stmt = stmt._copy();
+      this._openCursors.add(stmt);
+    } else {
+      this._cachedStatements.delete(sql);
+      this._cachedStatements.set(sql, stmt);
+    }
+    stmt.inUse = true;
+    return stmt;
+  }
+
+  //---------------------------------------------------------------------------
+  // returnStatement()
+  // Return the statement to the statement cache, if applicable. If the
+  // statement must not be returned to the statement cache, add the cursor
+  // id to the list of cursor ids to close on the next round trip to the
+  // database. Clear all bind variables and fetch variables in order to
+  // ensure that unnecessary references are not retained.
+  //---------------------------------------------------------------------------
+  returnStatement(statement) {
+    if (statement.bindInfoList) {
+      statement.bindInfoList.forEach(bindInfo => {
+        bindInfo.bindVar = null;
+      });
+    }
+    if (statement.queryVars) {
+      statement.queryVars.forEach(queryVar => {
+        queryVar.values.fill(null);
+      });
+    }
+    if (statement.returnToCache) {
+      statement.inUse = false;
+    } else if (statement.cursorId !== 0) {
+      this._addCursorToClose(statement);
+    }
+  }
+
+  //---------------------------------------------------------------------------
+  // writeCursorsToClose()
+  // Write the list of cursors to close to the buffer.
+  //---------------------------------------------------------------------------
+  writeCursorsToClose(buf) {
+    buf.writeUB4(this._cursorsToClose.size);
+    for (const cursorNum of this._cursorsToClose.keys()) {
+      buf.writeUB4(cursorNum);
+    }
+    this._cursorsToClose.clear();
+  }
+}
+
+module.exports = StatementCache;