oracledb 5.5.0 → 6.0.1

package/examples/example.js

@@ -0,0 +1,156 @@
+/* Copyright (c) 2018, 2023, 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.
+ *
+ * NAME
+ *   example.js
+ *
+ * DESCRIPTION
+ *   A basic node-oracledb example.
+ *
+ *   For connection pool examples see connectionpool.js and webapp.js
+ *   For a ResultSet example see resultset1.js
+ *   For a query stream example see selectstream.js
+ *
+ *****************************************************************************/
+
+'use strict';
+
+Error.stackTraceLimit = 50;
+
+const oracledb = require('oracledb');
+const dbConfig = require('./dbconfig.js');
+
+// This example runs in both node-oracledb Thin and Thick modes.
+//
+// Optionally run in node-oracledb Thick mode
+if (process.env.NODE_ORACLEDB_DRIVER_MODE === 'thick') {
+
+  // Thick mode requires Oracle Client or Oracle Instant Client libraries.
+  // On Windows and macOS Intel you can specify the directory containing the
+  // libraries at runtime or before Node.js starts.  On other platforms (where
+  // Oracle libraries are available) the system library search path must always
+  // include the Oracle library path before Node.js starts.  If the search path
+  // is not correct, you will get a DPI-1047 error.  See the node-oracledb
+  // installation documentation.
+  let clientOpts = {};
+  if (process.platform === 'win32') {                                   // Windows
+    clientOpts = { libDir: 'C:\\oracle\\instantclient_19_17' };
+  } else if (process.platform === 'darwin' && process.arch === 'x64') { // macOS Intel
+    clientOpts = { libDir: process.env.HOME + '/Downloads/instantclient_19_8' };
+  }
+  oracledb.initOracleClient(clientOpts);  // enable node-oracledb Thick mode
+}
+
+async function run() {
+  let connection;
+
+  try {
+
+    let sql, binds, options, result;
+
+    connection = await oracledb.getConnection(dbConfig);
+
+    //
+    // Create a table
+    //
+
+    const stmts = [
+      `DROP TABLE no_example`,
+
+      `CREATE TABLE no_example (id NUMBER, data VARCHAR2(20))`
+    ];
+
+    for (const s of stmts) {
+      try {
+        await connection.execute(s);
+      } catch (e) {
+        if (e.errorNum != 942)
+          console.error(e);
+      }
+    }
+
+    //
+    // Insert three rows
+    //
+
+    sql = `INSERT INTO no_example VALUES (:1, :2)`;
+
+    binds = [
+      [101, "Alpha" ],
+      [102, "Beta" ],
+      [103, "Gamma" ]
+    ];
+
+    // For a complete list of options see the documentation.
+    options = {
+      autoCommit: true,
+      // batchErrors: true,  // continue processing even if there are data errors
+      bindDefs: [
+        { type: oracledb.NUMBER },
+        { type: oracledb.STRING, maxSize: 20 }
+      ]
+    };
+
+    result = await connection.executeMany(sql, binds, options);
+
+    console.log("Number of rows inserted:", result.rowsAffected);
+
+    //
+    // Query the data
+    //
+
+    sql = `SELECT * FROM no_example`;
+
+    binds = {};
+
+    // For a complete list of options see the documentation.
+    options = {
+      outFormat: oracledb.OUT_FORMAT_OBJECT,   // query result format
+      // extendedMetaData: true,               // get extra metadata
+      // fetchArraySize:   100                 // internal buffer allocation size for tuning
+    };
+
+    result = await connection.execute(sql, binds, options);
+
+    // Column metadata can be shown, if desired
+    // console.log("Metadata: ");
+    // console.dir(result.metaData, { depth: null });
+
+    console.log("Query results: ");
+    console.dir(result.rows, { depth: null });
+
+  } catch (err) {
+    console.error(err);
+  } finally {
+    if (connection) {
+      try {
+        await connection.close();
+      } catch (err) {
+        console.error(err);
+      }
+    }
+  }
+}
+
+run();

package/index.js

@@ -1 +1,27 @@
+// Copyright (c) 2015, 2023, 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.
+//
+//-----------------------------------------------------------------------------
+
 module.exports = require('./lib/oracledb.js');

package/lib/aqDeqOptions.js

@@ -1,17 +1,24 @@
-// Copyright (c) 2019, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2019, 2023, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
-// You may not use the identified files except in compliance with the Apache
-// License, Version 2.0 (the "License.")
+// 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
-// http://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.
+//    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.
 //
@@ -19,9 +26,142 @@
 
 'use strict';
 
+const { Buffer } = require('buffer');
+const constants = require('./constants.js');
+const errors = require('./errors.js');
+
 class AqDeqOptions {
 
-  _extend(oracledb) { //eslint-disable-line
+  //---------------------------------------------------------------------------
+  // condition
+  //
+  // Property for the condition to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get condition() {
+    return this._impl.getCondition();
+  }
+
+  set condition(value) {
+    errors.assertPropValue(typeof value === 'string', "condition");
+    this._impl.setCondition(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // consumerName
+  //
+  // Property for the consumer name to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get consumerName() {
+    return this._impl.getConsumerName();
+  }
+
+  set consumerName(value) {
+    errors.assertPropValue(typeof value === 'string', "consumerName");
+    this._impl.setConsumerName(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // correlation
+  //
+  // Property for the correlation to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get correlation() {
+    return this._impl.getCorrelation();
+  }
+
+  set correlation(value) {
+    errors.assertPropValue(typeof value === 'string', "correlation");
+    this._impl.setCorrelation(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // mode
+  //
+  // Property for the mode to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get mode() {
+    return this._impl.getMode();
+  }
+
+  set mode(value) {
+    errors.assertPropValue(value === constants.AQ_DEQ_MODE_BROWSE ||
+      value === constants.AQ_DEQ_MODE_LOCKED ||
+      value === constants.AQ_DEQ_MODE_REMOVE ||
+      value === constants.AQ_DEQ_MODE_REMOVE_NO_DATA, "mode");
+    this._impl.setMode(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // msgId
+  //
+  // Property for the message id to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get msgId() {
+    return this._impl.getMsgId();
+  }
+
+  set msgId(value) {
+    errors.assertPropValue(Buffer.isBuffer(value), "msgId");
+    this._impl.setMsgId(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // navigation
+  //
+  // Property for the navigation to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get navigation() {
+    return this._impl.getNavigation();
+  }
+
+  set navigation(value) {
+    errors.assertPropValue(value === constants.AQ_DEQ_NAV_FIRST_MSG ||
+        value === constants.AQ_DEQ_NAV_NEXT_TRANSACTION ||
+        value === constants.AQ_DEQ_NAV_NEXT_MSG, "navigation");
+    this._impl.setNavigation(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // transformation
+  //
+  // Property for the transformation to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get transformation() {
+    return this._impl.getTransformation();
+  }
+
+  set transformation(value) {
+    errors.assertPropValue(typeof value === 'string', "transformation");
+    this._impl.setTransformation(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // visibility
+  //
+  // Property for the visibility to use for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get visibility() {
+    return this._impl.getVisibility();
+  }
+
+  set visibility(value) {
+    errors.assertPropValue(value === constants.AQ_VISIBILITY_IMMEDIATE ||
+      value === constants.AQ_VISIBILITY_ON_COMMIT, "visibility");
+    this._impl.setVisibility(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // wait
+  //
+  // Property for the time to wait for dequeuing messages.
+  //---------------------------------------------------------------------------
+  get wait() {
+    return this._impl.getWait();
+  }
+
+  set wait(value) {
+    errors.assertPropValue(Number.isInteger(value) && value >= 0, "wait");
+    this._impl.setWait(value);
   }
 
 }

package/lib/aqEnqOptions.js

@@ -2,16 +2,23 @@
 
 //-----------------------------------------------------------------------------
 //
-// You may not use the identified files except in compliance with the Apache
-// License, Version 2.0 (the "License.")
+// 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
-// http://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.
+//    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.
 //
@@ -19,9 +26,54 @@
 
 'use strict';
 
+const constants = require('./constants.js');
+const errors = require('./errors.js');
+
 class AqEnqOptions {
 
-  _extend(oracledb) { //eslint-disable-line
+  //---------------------------------------------------------------------------
+  // deliveryMode
+  //
+  // Property for the delivery mode to use for enqueuing messages.
+  //---------------------------------------------------------------------------
+  get deliveryMode() {
+    return this._impl.getDeliveryMode();
+  }
+
+  set deliveryMode(value) {
+    errors.assertPropValue(value === constants.AQ_MSG_DELIV_MODE_PERSISTENT ||
+      value === constants.AQ_MSG_DELIV_MODE_BUFFERED ||
+      value === constants.AQ_MSG_DELIV_MODE_PERSISTENT_OR_BUFFERED, "deliveryMode");
+    this._impl.setDeliveryMode(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // transformation
+  //
+  // Property for the transformation to use for enqueuing messages.
+  //---------------------------------------------------------------------------
+  get transformation() {
+    return this._impl.getTransformation();
+  }
+
+  set transformation(value) {
+    errors.assertPropValue(typeof value === 'string', "transformation");
+    this._impl.setTransformation(value);
+  }
+
+  //---------------------------------------------------------------------------
+  // visibility
+  //
+  // Property for the visibility to use for enqueuing messages.
+  //---------------------------------------------------------------------------
+  get visibility() {
+    return this._impl.getVisibility();
+  }
+
+  set visibility(value) {
+    errors.assertPropValue(value === constants.AQ_VISIBILITY_IMMEDIATE ||
+      value === constants.AQ_VISIBILITY_ON_COMMIT, "visibility");
+    this._impl.setVisibility(value);
   }
 
 }

package/lib/aqMessage.js

@@ -2,16 +2,23 @@
 
 //-----------------------------------------------------------------------------
 //
-// You may not use the identified files except in compliance with the Apache
-// License, Version 2.0 (the "License.")
+// 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
-// http://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.
+//    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.
 //
@@ -19,9 +26,113 @@
 
 'use strict';
 
+const DbObjectImpl = require('./impl/dbObject.js');
+
 class AqMessage {
 
-  _extend(oracledb) { //eslint-disable-line
+  //---------------------------------------------------------------------------
+  // correlation
+  //
+  // Property for the correlation used for the message.
+  //---------------------------------------------------------------------------
+  get correlation() {
+    return this._impl.getCorrelation();
+  }
+
+  //---------------------------------------------------------------------------
+  // delay
+  //
+  // Property for the delay used for the message.
+  //---------------------------------------------------------------------------
+  get delay() {
+    return this._impl.getDelay();
+  }
+
+  //---------------------------------------------------------------------------
+  // deliveryMode
+  //
+  // Property for the delivery mode used for the message.
+  //---------------------------------------------------------------------------
+  get deliveryMode() {
+    return this._impl.getDeliveryMode();
+  }
+
+  //---------------------------------------------------------------------------
+  // exceptionQueue
+  //
+  // Property for the exception queue used for the message.
+  //---------------------------------------------------------------------------
+  get exceptionQueue() {
+    return this._impl.getExceptionQueue();
+  }
+
+  //---------------------------------------------------------------------------
+  // expiration
+  //
+  // Property for the expiration used for the message.
+  //---------------------------------------------------------------------------
+  get expiration() {
+    return this._impl.getExpiration();
+  }
+
+  //---------------------------------------------------------------------------
+  // msgId
+  //
+  // Property for the message id used for the message.
+  //---------------------------------------------------------------------------
+  get msgId() {
+    return this._impl.getMsgId();
+  }
+
+  //---------------------------------------------------------------------------
+  // numAttempts
+  //
+  // Property for the number of attempts used for the message.
+  //---------------------------------------------------------------------------
+  get numAttempts() {
+    return this._impl.getNumAttempts();
+  }
+
+  //---------------------------------------------------------------------------
+  // originalMsgId
+  //
+  // Property for the original message id used for the message.
+  //---------------------------------------------------------------------------
+  get originalMsgId() {
+    return this._impl.getOriginalMsgId();
+  }
+
+  //---------------------------------------------------------------------------
+  // payload
+  //
+  // Property for the payload used for the message.
+  //---------------------------------------------------------------------------
+  get payload() {
+    const payload = this._impl.getPayload();
+    if (payload instanceof DbObjectImpl) {
+      const obj = Object.create(this._payloadTypeClass.prototype);
+      obj._impl = payload;
+      return obj;
+    }
+    return payload;
+  }
+
+  //---------------------------------------------------------------------------
+  // priority
+  //
+  // Property for the priority used for the message.
+  //---------------------------------------------------------------------------
+  get priority() {
+    return this._impl.getPriority();
+  }
+
+  //---------------------------------------------------------------------------
+  // state
+  //
+  // Property for the state used for the message.
+  //---------------------------------------------------------------------------
+  get state() {
+    return this._impl.getState();
   }
 
 }