Add connection.executeMany() for batch statement execution

Author: cjbj

doc/api.md

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -130,7 +130,6 @@ BEGIN EXECUTE IMMEDIATE 'DROP TABLE dmlrupdtab'; EXCEPTION WHEN OTHERS THEN IF S
 CREATE TABLE dmlrupdtab (id NUMBER, name VARCHAR2(40));
 INSERT INTO dmlrupdtab VALUES (1001, 'Venkat');
 INSERT INTO dmlrupdtab VALUES (1002, 'Neeharika');
-COMMIT;
 
 -- For LOB examples
 BEGIN EXECUTE IMMEDIATE 'DROP TABLE mylobs'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
@@ -186,3 +185,68 @@ SHOW ERRORS
 BEGIN EXECUTE IMMEDIATE 'DROP TABLE myraw'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
 /
 CREATE TABLE myraw (r RAW(64));
+
+-- For the executemany*.js examples
+
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE em_tab'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE em_childtab'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE em_parenttab'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
+
+CREATE TABLE em_tab (
+    id  NUMBER NOT NULL,
+    val VARCHAR2(20)
+);
+
+CREATE TABLE em_parenttab (
+    parentid    NUMBER NOT NULL,
+    description VARCHAR2(60) NOT NULL,
+    CONSTRAINT parenttab_pk PRIMARY KEY (parentid)
+);
+
+CREATE TABLE em_childtab (
+    childid     NUMBER NOT NULL,
+    parentid    NUMBER NOT NULL,
+    description VARCHAR2(30) NOT NULL,
+    CONSTRAINT em_childtab_pk PRIMARY KEY (childid),
+    CONSTRAINT em_childtab_fk FOREIGN KEY (parentid) REFERENCES em_parenttab
+);
+
+INSERT INTO em_parenttab VALUES (10, 'Parent 10');
+INSERT INTO em_parenttab VALUES (20, 'Parent 20');
+INSERT INTO em_parenttab VALUES (30, 'Parent 30');
+INSERT INTO em_parenttab VALUES (40, 'Parent 40');
+INSERT INTO em_parenttab VALUES (50, 'Parent 50');
+
+INSERT INTO em_childtab VALUES (1001, 10, 'Child 1001 of Parent 10');
+INSERT INTO em_childtab VALUES (1002, 20, 'Child 1002 of Parent 20');
+INSERT INTO em_childtab VALUES (1003, 20, 'Child 1003 of Parent 20');
+INSERT INTO em_childtab VALUES (1004, 20, 'Child 1004 of Parent 20');
+INSERT INTO em_childtab VALUES (1005, 30, 'Child 1005 of Parent 30');
+INSERT INTO em_childtab VALUES (1006, 30, 'Child 1006 of Parent 30');
+INSERT INTO em_childtab VALUES (1007, 40, 'Child 1007 of Parent 40');
+INSERT INTO em_childtab VALUES (1008, 40, 'Child 1008 of Parent 40');
+INSERT INTO em_childtab VALUES (1009, 40, 'Child 1009 of Parent 40');
+INSERT INTO em_childtab VALUES (1010, 40, 'Child 1010 of Parent 40');
+INSERT INTO em_childtab VALUES (1011, 40, 'Child 1011 of Parent 40');
+INSERT INTO em_childtab VALUES (1012, 50, 'Child 1012 of Parent 50');
+INSERT INTO em_childtab VALUES (1013, 50, 'Child 1013 of Parent 50');
+INSERT INTO em_childtab VALUES (1014, 50, 'Child 1014 of Parent 50');
+INSERT INTO em_childtab VALUES (1015, 50, 'Child 1015 of Parent 50');
+
+CREATE OR REPLACE PROCEDURE em_testproc (
+  a_num IN NUMBER,
+  a_outnum OUT NUMBER,
+  a_outstr OUT VARCHAR2)
+AS
+BEGIN
+  a_outnum := a_num * 2;
+  FOR i IN 1..a_num LOOP
+    a_outstr := a_outstr || 'X';
+  END LOOP;
+END;
+/
+
+COMMIT;

examples/demo.sql

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -54,3 +54,11 @@ DROP PROCEDURE lob_in_out;
 DROP PROCEDURE lobs_in;
 
 DROP PROCEDURE lobs_out;
+
+DROP TABLE em_tab;
+
+DROP TABLE em_childtab;
+
+DROP TABLE em_parenttab;
+
+DROP PROCEDURE em_testproc;

examples/demodrop.sql

@@ -0,0 +1,89 @@
+/* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved. */
+
+/******************************************************************************
+ *
+ * You may not use the identified files except in compliance with the Apache
+ * License, Version 2.0 (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.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * NAME
+ *   em_batcherrors.js
+ *
+ * DESCRIPTION
+ *   Array DML example showing batchErrors behavior.  Note, despite the
+ *   autoCommit flag, no commit occurs because of data errors. However
+ *   valid rows are part of a transaction that can be committed if
+ *   desired.
+ *   Use demo.sql to create the required schema.
+ *
+ *****************************************************************************/
+
+var async = require('async');
+var oracledb = require('oracledb');
+var dbConfig = require('./dbconfig.js');
+
+var doconnect = function(cb) {
+  oracledb.getConnection(dbConfig, cb);
+};
+
+var dorelease = function(conn) {
+  conn.close(function (err) {
+    if (err)
+      console.error(err.message);
+  });
+};
+
+var doinsert = function(conn, cb) {
+  var sql = "INSERT INTO em_childtab VALUES (:1, :2, :3)";
+
+  var binds = [
+    [1016, 10, "Child 2 of Parent A"],
+    [1017, 10, "Child 3 of Parent A"],
+    [1018, 20, "Child 4 of Parent B"],
+    [1018, 20, "Child 4 of Parent B"],   // duplicate key
+    [1019, 30, "Child 3 of Parent C"],
+    [1020, 40, "Child 4 of Parent D"],
+    [1021, 75, "Child 1 of Parent F"],   // parent does not exist
+    [1022, 40, "Child 6 of Parent D"]
+  ];
+
+  var options = {
+    autoCommit: true,
+    batchErrors: true,
+    dmlRowCounts: true,
+    bindDefs: [
+      { type: oracledb.NUMBER },
+      { type: oracledb.NUMBER },
+      { type: oracledb.STRING, maxSize: 20 }
+    ]
+  };
+
+  conn.executeMany(sql, binds, options, function (err, result) {
+    if (err)
+      return cb(err, conn);
+    else {
+      console.log("Result is:", result);
+      return cb(null, conn);
+    }
+  });
+};
+
+async.waterfall(
+  [
+    doconnect,
+    doinsert
+  ],
+  function (err, conn) {
+    if (err) { console.error("In waterfall error cb: ==>", err, "<=="); }
+    if (conn)
+      dorelease(conn);
+  });

examples/em_batcherrors.js

@@ -0,0 +1,87 @@
+/* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved. */
+
+/******************************************************************************
+ *
+ * You may not use the identified files except in compliance with the Apache
+ * License, Version 2.0 (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.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * NAME
+ *   em_batcherrors_aa.js
+ *
+ * DESCRIPTION
+ *   Array DML example showing batchErrors behavior.  Note, despite the
+ *   autoCommit flag, no commit occurs because of data errors. However
+ *   valid rows are part of a transaction that can be committed if
+ *   desired.
+ *   This example also uses Async/Await of Node 8.
+ *   Use demo.sql to create the required schema.
+ *
+ *****************************************************************************/
+
+var oracledb = require('oracledb');
+var dbConfig = require('./dbconfig.js');
+
+const sql = "INSERT INTO em_childtab VALUES (:1, :2, :3)";
+
+const binds = [
+  [1016, 10, "Child 2 of Parent A"],
+  [1017, 10, "Child 3 of Parent A"],
+  [1018, 20, "Child 4 of Parent B"],
+  [1018, 20, "Child 4 of Parent B"],   // duplicate key
+  [1019, 30, "Child 3 of Parent C"],
+  [1020, 40, "Child 4 of Parent D"],
+  [1021, 75, "Child 1 of Parent F"],   // parent does not exist
+  [1022, 40, "Child 6 of Parent D"]
+];
+
+const options = {
+  autoCommit: true,
+  batchErrors: true,
+  dmlRowCounts: true,
+  bindDefs: [
+    { type: oracledb.NUMBER },
+    { type: oracledb.NUMBER },
+    { type: oracledb.STRING, maxSize: 20 }
+  ]
+};
+
+async function run() {
+  let conn;
+  let result;
+
+  try {
+    conn = await oracledb.getConnection(
+      {
+        user          : dbConfig.user,
+        password      : dbConfig.password,
+        connectString : dbConfig.connectString
+      });
+
+    result = await conn.executeMany(sql, binds, options);
+
+    console.log("Result is:", result);
+
+  } catch (err) {
+    console.error(err);
+  } finally {
+    if (conn) {
+      try {
+        await conn.close();
+      } catch (err) {
+        console.error(err);
+      }
+    }
+  }
+}
+
+run();

examples/em_batcherrors_aa.js

@@ -0,0 +1,93 @@
+/* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved. */
+
+/******************************************************************************
+ *
+ * You may not use the identified files except in compliance with the Apache
+ * License, Version 2.0 (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.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * NAME
+ *   em_dmlreturn1.js
+ *
+ * DESCRIPTION
+ *   executeMany() example of DML RETURNING that returns single values
+ *   Use demo.sql to create the required schema.
+ *
+ *****************************************************************************/
+
+var async = require('async');
+var oracledb = require('oracledb');
+var dbConfig = require('./dbconfig.js');
+
+var doconnect = function(cb) {
+  oracledb.getConnection(dbConfig, cb);
+};
+
+var dorelease = function(conn) {
+  conn.close(function (err) {
+    if (err)
+      console.error(err.message);
+  });
+};
+
+var dotruncate = function(conn, cb) {
+  conn.execute("TRUNCATE TABLE em_tab", function (err) {
+    return cb(err, conn);
+  });
+};
+
+var doinsert = function(conn, cb) {
+  var sql = "INSERT INTO em_tab VALUES (:1, :2) RETURNING ROWID, id, val INTO :3, :4, :5";
+
+  var binds = [
+    [1, "Test 1 (One)"],
+    [2, "Test 2 (Two)"],
+    [3, "Test 3 (Three)"],
+    [4, null],
+    [5, "Test 5 (Five)"]
+  ];
+
+  var options = {
+    bindDefs: [
+      { type: oracledb.NUMBER },
+      { type: oracledb.STRING, maxSize: 20 },
+      { type: oracledb.STRING, maxSize: 18, dir: oracledb.BIND_OUT },
+      { type: oracledb.NUMBER, dir: oracledb.BIND_OUT },
+      { type: oracledb.STRING, maxSize: 25, dir: oracledb.BIND_OUT }
+    ]
+  };
+
+  conn.executeMany(sql, binds, options, function (err, result) {
+    if (err)
+      return cb(err, conn);
+    else {
+      console.log("rowsAffected is:", result.rowsAffected);
+      console.log("Out binds:");
+      for (let i = 0; i < result.outBinds.length; i++) {
+        console.log("-->", result.outBinds[i]);
+      }
+      return cb(null, conn);
+    }
+  });
+};
+
+async.waterfall(
+  [
+    doconnect,
+    dotruncate,
+    doinsert
+  ],
+  function (err, conn) {
+    if (err) { console.error("In waterfall error cb: ==>", err, "<=="); }
+    if (conn)
+      dorelease(conn);
+  });