Merge pull request #23 from oracle/node-oracledb-v2

Update examples for node-oracledb version 2

Author: gvenzl

javascript/node-oracledb/README.md

@@ -1,14 +1,45 @@
-These are examples for the [node-oracledb 1.13 driver](https://www.npmjs.com/package/oracledb)
+# Node-oracledb Examples
 
-The node-oracledb add-on for Node.js powers high performance Oracle Database applications.
+This directory contains [node-oracledb 2.0](https://www.npmjs.com/package/oracledb) examples.
 
-[node-oracledb installation instructions](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md)
+The node-oracledb add-on for Node.js powers high performance Oracle Database applications.
 
 [Node-oracledb documentation](https://github.com/oracle/node-oracledb/blob/master/doc/api.md)
 
 [Issues and questions](https://github.com/oracle/node-oracledb/issues)
 
-After installing node-oracledb, the demos can be run by editing
-dbconfig.js to set your database credentials, creating the schema
-objects with demo.sql, and then executing each JavaScript file with
-Node.js.
+To run the examples:
+
+- [Install node-oracledb](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md).
+
+
+- Use `demo.sql` to create schema objects used by the samples. For
+ example, to load them in the HR schema run:
+
+ ```
+ sqlplus hr/welcome@localhost/orclpdb @demo.sql
+ ```
+
+- Edit `dbconfig.js` and set your username, password and the database
+connection string:
+
+ ```
+ module.exports = {
+ user: "hr",
+ password: "welcome",
+ connectString:"localhost/orclpdb"
+ };
+
+ ```
+
+- Then run the samples like:
+
+ ```
+ node select1.js
+ ```
+
+The demonstration objects can be dropped with `demodrop.sql`:
+
+ ```
+ sqlplus hr/welcome@localhost/orclpdb @demodrop.sql
+ ```

javascript/node-oracledb/blobhttp.js

@@ -57,10 +57,10 @@ function init() {
 
  // Create HTTP server and listen on port 'httpPort'
  http
- .createServer(function(request, response) {
- handleRequest(request, response);
- })
- .listen(httpPort);
+  .createServer(function(request, response) {
+  handleRequest(request, response);
+  })
+  .listen(httpPort);
 
  console.log("Server running. Try requesting: http://localhost:" + httpPort + "/getimage");
  });
@@ -140,13 +140,13 @@ function handleRequest(request, response) {
 }
 
 process
-.on('SIGTERM', function() {
- console.log("\nTerminating");
- process.exit(0);
-})
-.on('SIGINT', function() {
- console.log("\nTerminating");
- process.exit(0);
-});
+ .on('SIGTERM', function() {
+  console.log("\nTerminating");
+  process.exit(0);
+ })
+ .on('SIGINT', function() {
+  console.log("\nTerminating");
+  process.exit(0);
+ });
 
 init();

javascript/node-oracledb/date.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -50,17 +50,17 @@ var dorelease = function(conn) {
 
 var docleanup = function (conn, cb) {
  conn.execute(
- "BEGIN " +
- " DECLARE" +
- "  e_table_exists EXCEPTION;" +
- "  PRAGMA EXCEPTION_INIT(e_table_exists, -00942);" +
- " BEGIN" +
- "  EXECUTE IMMEDIATE ('DROP TABLE datetest');" +
- " EXCEPTION" +
- "  WHEN e_table_exists" +
- "  THEN NULL;" +
- " END; " +
-  "END;",
+ `BEGIN
+  DECLARE
+ e_table_exists EXCEPTION;
+ PRAGMA EXCEPTION_INIT(e_table_exists, -00942);
+  BEGIN
+ EXECUTE IMMEDIATE ('DROP TABLE datetest');
+  EXCEPTION
+ WHEN e_table_exists
+ THEN NULL;
+  END;
+ END;`,
  function(err) {
  return cb(err, conn);
  });

javascript/node-oracledb/dbconfig.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -34,7 +34,7 @@
  * [//]host_name[:port][/service_name][:server_type][/instance_name]
  *
  * Commonly just the host_name and service_name are needed
- * e.g. "localhost/orcl" or "localhost/XE"
+ * e.g. "localhost/orclpdb" or "localhost/XE"
  *
  * If using a tnsnames.ora file, the file can be in a default
  * location such as $ORACLE_HOME/network/admin/tnsnames.ora or
@@ -76,7 +76,7 @@ module.exports = {
 
  // For information on connection strings see:
  // https://github.com/oracle/node-oracledb/blob/master/doc/api.md#connectionstrings
- connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING || "localhost/orcl",
+ connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING || "localhost/orclpdb",
 
  // Setting externalAuth is optional. It defaults to false. See:
  // https://github.com/oracle/node-oracledb/blob/master/doc/api.md#extauth

javascript/node-oracledb/dbmsoutputgetline.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -65,10 +65,10 @@ var enableDbmsOutput = function (conn, cb) {
 
 var createDbmsOutput = function (conn, cb) {
  conn.execute(
- "BEGIN " +
- "DBMS_OUTPUT.PUT_LINE('Hello, Oracle!');" +
- "DBMS_OUTPUT.PUT_LINE('Hello, Node!');" +
-  "END;",
+ `BEGIN
+  DBMS_OUTPUT.PUT_LINE('Hello, Oracle!');
+  DBMS_OUTPUT.PUT_LINE('Hello, Node!');
+ END;`,
  function(err) { return cb(err, conn); });
 };
 

javascript/node-oracledb/dbmsoutputpipe.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -68,7 +68,8 @@ var doit = function(pool) {
  enableDbmsOutput,
  createDbmsOutput,
  fetchDbmsOutput,
- printDbmsOutput
+ printDbmsOutput,
+ closeRS
  ],
  function (err, conn) {
  if (err) { console.error("In waterfall error cb: ==>", err, "<=="); }
@@ -84,10 +85,10 @@ var enableDbmsOutput = function (conn, cb) {
 
 var createDbmsOutput = function (conn, cb) {
  conn.execute(
- "BEGIN " +
- "DBMS_OUTPUT.PUT_LINE('Hello, Oracle!');" +
- "DBMS_OUTPUT.PUT_LINE('Hello, Node!');" +
-  "END;",
+ `BEGIN
+  DBMS_OUTPUT.PUT_LINE('Hello, Oracle!');
+  DBMS_OUTPUT.PUT_LINE('Hello, Node!');
+ END;`,
  function(err) { return cb(err, conn); });
 };
 
@@ -118,12 +119,18 @@ var fetchRowsFromRS = function(conn, resultSet, numRows, cb) {
  numRows,
  function (err, rows) {
  if (err) {
- return cb(err, conn);
+ return cb(err, conn, resultSet);
  } else if (rows.length > 0) {
  console.log(rows);
  return fetchRowsFromRS(conn, resultSet, numRows, cb);
  } else {
- return cb(null, conn);
+ return cb(null, conn, resultSet);
  }
  });
 };
+
+var closeRS = function(conn, resultSet, cb) {
+ resultSet.close(function(err) {
+ return cb(err, conn);
+ });
+};

javascript/node-oracledb/demo.sql

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -60,7 +60,9 @@ END;
 SHOW ERRORS
 
 -- For plsqlarray.js example for PL/SQL 'INDEX BY' array binds
-DROP TABLE waveheight;
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE waveheight'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
+
 CREATE TABLE waveheight (beach VARCHAR2(50), depth NUMBER);
 
 CREATE OR REPLACE PACKAGE beachpkg IS
@@ -107,24 +109,29 @@ END;
 SHOW ERRORS
 
 -- For selectjson.js example of JSON datatype. Requires Oracle Database 12.1.0.2
-DROP TABLE j_purchaseorder;
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE j_purchaseorder'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
+
 -- Note if your applications always insert valid JSON, you may delete
 -- the IS JSON check to remove its additional validation overhead.
 CREATE TABLE j_purchaseorder (po_document VARCHAR2(4000) CHECK (po_document IS JSON));
 
--- For selectjsonclob.js example of JSON datatype. Requires Oracle Database 12.1.0.2
-DROP TABLE j_purchaseorder_c;
-CREATE TABLE j_purchaseorder_c (po_document CLOB CHECK (po_document IS JSON));
+-- For selectjsonblob.js example of JSON datatype. Requires Oracle Database 12.1.0.2
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE j_purchaseorder_b'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
+CREATE TABLE j_purchaseorder_b (po_document BLOB CHECK (po_document IS JSON)) LOB (po_document) STORE AS (CACHE);
 
 -- For DML RETURNING aka RETURNING INTO examples
-DROP TABLE dmlrupdtab;
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE dmlrupdtab'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
 CREATE TABLE dmlrupdtab (id NUMBER, name VARCHAR2(40));
 INSERT INTO dmlrupdtab VALUES (1001, 'Venkat');
 INSERT INTO dmlrupdtab VALUES (1002, 'Neeharika');
 COMMIT;
 
 -- For LOB examples
-DROP TABLE mylobs;
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE mylobs'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
 CREATE TABLE mylobs (id NUMBER, c CLOB, b BLOB);
 
 -- For lobbinds.js: Procedure to show IN bind support for LOBs
@@ -173,5 +180,6 @@ END;
 SHOW ERRORS
 
 -- For raw1.js
-DROP TABLE myraw;
+BEGIN EXECUTE IMMEDIATE 'DROP TABLE myraw'; EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;
+/
 CREATE TABLE myraw (r RAW(64));

javascript/node-oracledb/demodrop.sql

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -35,7 +35,7 @@ DROP PACKAGE beachpkg;
 
 DROP TABLE j_purchaseorder;
 
-DROP TABLE j_purchaseorder_c;
+DROP TABLE j_purchaseorder_b;
 
 DROP TABLE dmlrupdtab;
 
@@ -49,8 +49,6 @@ DROP TABLE myraw;
 
 DROP TABLE waveheight;
 
-DROP PROCEDURE lob_out;
-
 DROP PROCEDURE lob_in_out;
 
 DROP PROCEDURE lobs_in;

javascript/node-oracledb/dmlrupd1.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -19,7 +19,11 @@
  * dmlrupd1.js
  *
  * DESCRIPTION
- * Example of 'DML Returning' with a single row match
+ * Example of 'DML Returning' with a single row match.
+ * The ROWID of the changed record is returned. This is how to get
+ * the 'last insert id'.
+ * Bind names cannot be reused in the DML section and the RETURNING section.
+ *
  * Use demo.sql to create the required table or do:
  * DROP TABLE dmlrupdtab;
  * CREATE TABLE dmlrupdtab (id NUMBER, name VARCHAR2(40));
@@ -47,12 +51,11 @@ oracledb.getConnection(
  }
 
  connection.execute(
- "UPDATE DMLRUPDTAB SET NAME = :name WHERE ID = :id RETURNING ID, NAME INTO :RID, :RNAME",
+ "UPDATE dmlrupdtab SET name = :name WHERE id = :id RETURNING ROWID INTO :rid",
  {
  id: 1001,
  name: "Krishna",
- rid: { type: oracledb.NUMBER, dir: oracledb.BIND_OUT },
- rname: { type: oracledb.STRING, dir: oracledb.BIND_OUT }
+ rid: { type: oracledb.STRING, dir: oracledb.BIND_OUT }
  },
  { autoCommit: true },
  function(err, result)

javascript/node-oracledb/dmlrupd2.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved. */
 
 /******************************************************************************
  *
@@ -19,7 +19,11 @@
  * dmlrupd2.js
  *
  * DESCRIPTION
- * Example of 'DML Returning' with multiple rows matched
+ * Example of 'DML Returning' with multiple rows matched.
+ * The ROWIDs of the changed records are returned. This is how to get
+ * the 'last insert id'.
+ * Bind names cannot be reused in the DML section and the RETURNING section.
+ *
  * Use demo.sql to create the required table or do:
  * DROP TABLE dmlrupdtab;
  * CREATE TABLE dmlrupdtab (id NUMBER, name VARCHAR2(40));
@@ -47,11 +51,13 @@ oracledb.getConnection(
  }
 
  connection.execute(
- "UPDATE DMLRUPDTAB SET NAME = :name RETURNING ID, NAME INTO :RID, :RNAME",
+ "UPDATE dmlrupdtab SET name = :name WHERE id IN (:id1, :id2) RETURNING id, ROWID INTO :ids, :rids",
  {
+ id1: 1001,
+ id2: 1002,
  name: "Chris",
- rid: { type: oracledb.NUMBER, dir: oracledb.BIND_OUT },
- rname: { type: oracledb.STRING, dir: oracledb.BIND_OUT }
+ ids: { type: oracledb.NUMBER, dir: oracledb.BIND_OUT },
+ rids:  { type: oracledb.STRING, dir: oracledb.BIND_OUT }
  },
  { autoCommit: true },
  function(err, result)