Rework schema setup in example scripts

Author: Christopher Jones

doc/api.md

@@ -512,9 +512,6 @@ below.  As well as [Async/Await](#asyncawaitoverview) functions,
 node-oracledb can also use [Callbacks](#callbackoverview), and
 [Promises](#promiseoverview).
 
-Scripts to create Oracle's sample schemas can be found at
-[github.com/oracle/db-sample-schemas][4].
-
 Locate your Oracle Database [user name and password][91], and the database
 [connection string](#connectionstrings).  The connection string is
 commonly of the format `hostname/servicename`, using the host name
@@ -577,7 +574,7 @@ async function run() {
 run();
 ```
 
-With Oracle's sample HR schema, the output is:
+With Oracle's sample [HR schema][4], the output is:
 
 ```
 [ { MANAGER_ID: 103, DEPARTMENT_ID: 60, DEPARTMENT_NAME: 'IT' } ]

examples/README.md

@@ -8,7 +8,7 @@ To run the examples:
 
 
 - Edit `dbconfig.js` and set your username, password and the database
-connection string:
+connection string, for example:
 
   ```
   module.exports = {
@@ -23,95 +23,88 @@ connection string:
   `NODE_ORACLEDB_PASSWORD`, which you must set before running
   examples.
 
-- Then run the samples like:
+- Review the samples and then run them like:
 
   ```
   node example.js
   ```
 
-- Some examples require schema objects created by `demo.sql`.  For
-  example, to load them in the HR schema run:
+- After running example, the demonstration objects can be dropped with `demodrop.js`:
 
   ```
-  sqlplus hr/welcome@localhost/orclpdb1 @demo.sql
-  ```
-
-  The demonstration objects can be dropped with `demodrop.sql`:
-
-  ```
-  sqlplus hr/welcome@localhost/orclpdb1 @demodrop.sql
+  node demodrop.js
   ```
 
 ## Example Overview
 
 If this is your first time with node-oracledb, start with
 [`example.js`](example.js).
 
-File Name                   | Description
-----------------------------|----------------------------------------------------------------------------------
-aqoptions.js                | Oracle Advanced Queuing (AQ) example setting options and message attributes
-aqmulti.js                  | Oracle Advanced Queuing (AQ) example passing multiple messages
-aqobject.js                 | Oracle Advanced Queuing (AQ) example passing an Oracle Database object
-aqraw.js                    | Basic Oracle Advanced Queuing (AQ) example passing text messages
-blobhttp.js                 | Simple web app that streams an image
-calltimeout.js              | Shows how to cancel a SQL statement if it doesn't complete in a specified time
-connect.js                  | Basic example for creating a standalone (non-pooled) connection
-connectionpool.js           | Basic example creating a pool of connections
-cqn1.js                     | Basic Continuous Query Notification (CQN) example
-cqn2.js                     | Continuous Query Notification with notification grouping
-date.js                     | Show some DATE and TIMESTAMP behaviors
-dbconfig.js                 | Common file used by examples for setting connection credentials
-dbmsoutputgetline.js        | Show fetching DBMS_OUTPUT by binding buffers
-dbmsoutputpipe.js           | Show fetching DBMS_OUTPUT by using a pipelined table
-demo.sql                    | SQL script to create extra schema objects for the examples
-demodrop.sql                | SQL script to drop the extra schema objects for the examples
-dmlrupd1.js                 | Example of DML RETURNING with a single row match
-dmlrupd2.js                 | Example of DML RETURNING where multiple rows are matched
-em_batcherrors.js           | `executeMany()` example showing handling data errors
-em_dmlreturn1.js            | `executeMany()` example of DML RETURNING that returns single values
-em_dmlreturn2.js            | `executeMany()` example of DML RETURNING that returns multiple values
-em_insert1.js               | Array DML example using `executeMany()` with bind-by-name syntax
-em_insert2.js               | Array DML example using `executeMany()` with bind by position
-em_plsql.js                 | `executeMany()` example calling PL/SQL multiple times with one call
-em_rowcounts.js             | `executeMany()` example showing how to find the number of rows affected by each input row
-endtoend.js                 | Example showing setting tracing attributes
-example.js                  | Basic example showing creating a table, inserting multiple rows, and querying rows
-fetchinfo.js                | Show how numbers and dates can be returned as strings using `fetchAsString` and `fetchInfo`
-impres.js                   | Shows PL/SQL 'Implict Results' returning multiple query results from PL/SQL code.
-insert1.js                  | Basic example creating a table and inserting data.  Shows DDL and DML
-insert2.js                  | Basic example showing auto commit behavior
-lobbinds.js                 | Demonstrates how to bind and query LOBs
-lobinsert1.js               | Shows inserting a file into a CLOB column
-lobinsert2.js               | Inserts text into a CLOB column using the RETURNING INTO method.
-lobinserttemp.js            | Writes data to a Temporary CLOB and then inserts it into the database
-lobplsqltemp.js             | Streams data into a Temporary CLOB and then passes it to PL/SQL
-lobselect.js                | Shows basic, non-streaming CLOB and BLOB queries
-lobstream1.js               | Shows how to stream LOBs to files
-lobstream2.js               | Shows using Stream data events to fetch a CLOB
-metadata.js                 | Shows the metadata available after executing SELECT statements
-plsqlarray.js               | Examples of binding PL/SQL "INDEX BY" tables
-plsqlfunc.js                | How to call a PL/SQL function
-plsqlproc.js                | How to call a PL/SQL procedure
-plsqlrecord.js              | Shows binding of PL/SQL RECORDS
-plsqlvarrayrecord.js        | Shows binding a VARRAY of RECORD in PL/SQL
-raw1.js                     | Shows using a Buffer to insert and select a RAW
-refcursor.js                | Shows using a ResultSet to fetch rows from a REF CURSOR
-refcursortoquerystream.js   | Converts a REF CURSOR returned from `execute()` to a query stream.
-resultset1.js               | Executes a query and uses a ResultSet to fetch rows with `getRow()`
-resultset2.js               | Executes a query and uses a ResultSet to fetch batches of rows with `getRows()`
-resultsettoquerystream.js   | Converts a ResultSet returned from `execute()` into a Readable Stream.
-rowlimit.js                 | Shows ways to limit the number of records fetched by queries
-select1.js                  | Executes a basic query without using a connection pool or ResultSet
-select2.js                  | Executes queries to show array and object output formats
-selectgeometry.js           | Insert and query Oracle Spatial geometries
-selectjson.js               | Shows some JSON features of Oracle Database
-selectjsonblob.js           | Shows how to use a BLOB as a JSON column store
-selectobject.js             | Insert and query a named Oracle database object
-selectstream.js             | Executes a basic query using a Readable Stream
-selectvarray.js             | Shows inserting and selecting from a VARRAY column
-sessionfixup.js             | Shows a pooled connection callback to efficiently set session state
-sessiontagging1.js          | Simple pooled connection tagging for setting session state
-sessiontagging2.js          | More complex example of pooled connection tagging for setting session state
-soda1.js                    | Basic Simple Oracle Document Access (SODA) example
-version.js                  | Shows the node-oracledb version attributes
-webappawait.js              | A simple web application using a connection pool
+File Name                                                 | Description
+----------------------------------------------------------|----------------------------------------------------------------------------------
+[`aqmulti.js`](aqmulti.js)                                | Oracle Advanced Queuing (AQ) example passing multiple messages
+[`aqobject.js`](aqobject.js)                              | Oracle Advanced Queuing (AQ) example passing an Oracle Database object
+[`aqoptions.js`](aqoptions.js)                            | Oracle Advanced Queuing (AQ) example setting options and message attributes
+[`aqraw.js`](aqraw.js)                                    | Basic Oracle Advanced Queuing (AQ) example passing text messages
+[`blobhttp.js`](blobhttp.js)                              | Simple web app that streams an image
+[`calltimeout.js`](calltimeout.js)                        | Shows how to cancel a SQL statement if it doesn't complete in a specified time
+[`connect.js`](connect.js)                                | Basic example for creating a standalone (non-pooled) connection
+[`connectionpool.js`](connectionpool.js)                  | Basic example creating a pool of connections
+[`cqn1.js`](cqn1.js)                                      | Basic Continuous Query Notification (CQN) example
+[`cqn2.js`](cqn2.js)                                      | Continuous Query Notification with notification grouping
+[`date.js`](date.js)                                      | Show some DATE and TIMESTAMP behaviors
+[`dbconfig.js`](dbconfig.js)                              | Common file used by examples for setting connection credentials
+[`dbmsoutputgetline.js`](dbmsoutputgetline.js)            | Show fetching DBMS_OUTPUT by binding buffers
+[`dbmsoutputpipe.js`](dbmsoutputpipe.js)                  | Show fetching DBMS_OUTPUT by using a pipelined table
+[`demodrop.js`](demodrop.js)                              | Drops the schema objects created by the examples
+[`demosetup.js`](demosetup.js)                            | Used to create common schema objects for the examples
+[`dmlrupd1.js`](dmlrupd1.js)                              | Example of DML RETURNING with a single row match
+[`dmlrupd2.js`](dmlrupd2.js)                              | Example of DML RETURNING where multiple rows are matched
+[`em_batcherrors.js`](em_batcherrors.js)                  | `executeMany()` example showing handling data errors
+[`em_dmlreturn1.js`](em_dmlreturn1.js)                    | `executeMany()` example of DML RETURNING that returns single values
+[`em_dmlreturn2.js`](em_dmlreturn2.js)                    | `executeMany()` example of DML RETURNING that returns multiple values
+[`em_insert1.js`](em_insert1.js)                          | Array DML example using `executeMany()` with bind-by-name syntax
+[`em_insert2.js`](em_insert2.js)                          | Array DML example using `executeMany()` with bind by position
+[`em_plsql.js`](em_plsql.js)                              | `executeMany()` example calling PL/SQL multiple times with one call
+[`em_rowcounts.js`](em_rowcounts.js)                      | `executeMany()` example showing how to find the number of rows affected by each input row
+[`endtoend.js`](endtoend.js)                              | Example showing setting tracing attributes
+[`example.js`](example.js)                                | Basic example showing creating a table, inserting multiple rows, and querying rows
+[`fetchinfo.js`](fetchinfo.js)                            | Show how numbers and dates can be returned as strings using `fetchAsString` and `fetchInfo`
+[`impres.js`](impres.js)                                  | Shows PL/SQL 'Implict Results' returning multiple query results from PL/SQL code.
+[`insert1.js`](insert1.js)                                | Basic example creating a table and inserting data.  Shows DDL and DML
+[`insert2.js`](insert2.js)                                | Basic example showing auto commit behavior
+[`lobbinds.js`](lobbinds.js)                              | Demonstrates how to bind and query LOBs
+[`lobinsert1.js`](lobinsert1.js)                          | Shows inserting a file into a CLOB column
+[`lobinsert2.js`](lobinsert2.js)                          | Inserts text into a CLOB column using the RETURNING INTO method.
+[`lobinserttemp.js`](lobinserttemp.js)                    | Writes data to a Temporary CLOB and then inserts it into the database
+[`lobplsqltemp.js`](lobplsqltemp.js)                      | Streams data into a Temporary CLOB and then passes it to PL/SQL
+[`lobselect.js`](lobselect.js)                            | Shows basic, non-streaming CLOB and BLOB queries
+[`lobstream1.js`](lobstream1.js)                          | Shows how to stream LOBs to files
+[`lobstream2.js`](lobstream2.js)                          | Shows using Stream data events to fetch a CLOB
+[`metadata.js`](metadata.js)                              | Shows the metadata available after executing SELECT statements
+[`plsqlarray.js`](plsqlarray.js)                          | Examples of binding PL/SQL "INDEX BY" tables
+[`plsqlfunc.js`](plsqlfunc.js)                            | How to call a PL/SQL function
+[`plsqlproc.js`](plsqlproc.js)                            | How to call a PL/SQL procedure
+[`plsqlrecord.js`](plsqlrecord.js)                        | Shows binding of PL/SQL RECORDS
+[`plsqlvarrayrecord.js`](plsqlvarrayrecord.js)            | Shows binding a VARRAY of RECORD in PL/SQL
+[`raw.js`](raw.js)                                        | Shows using a Buffer to insert and select a RAW
+[`refcursor.js`](refcursor.js)                            | Shows using a ResultSet to fetch rows from a REF CURSOR
+[`refcursortoquerystream.js`](refcursortoquerystream.js)  | Converts a REF CURSOR returned from `execute()` to a query stream.
+[`resultset1.js`](resultset1.js)                          | Executes a query and uses a ResultSet to fetch rows with `getRow()`
+[`resultset2.js`](resultset2.js)                          | Executes a query and uses a ResultSet to fetch batches of rows with `getRows()`
+[`resultsettoquerystream.js`](resultsettoquerystream.js)  | Converts a ResultSet returned from `execute()` into a Readable Stream.
+[`rowlimit.js`](rowlimit.js)                              | Shows ways to limit the number of records fetched by queries
+[`select1.js`](select1.js)                                | Executes a basic query without using a connection pool or ResultSet
+[`select2.js`](select2.js)                                | Executes queries to show array and object output formats
+[`selectgeometry.js`](selectgeometry.js)                  | Insert and query Oracle Spatial geometries
+[`selectjson.js`](selectjson.js)                          | Shows some JSON features of Oracle Database
+[`selectjsonblob.js`](selectjsonblob.js)                  | Shows how to use a BLOB as a JSON column store
+[`selectobject.js`](selectobject.js)                      | Insert and query a named Oracle database object
+[`selectstream.js`](selectstream.js)                      | Executes a basic query using a Readable Stream
+[`selectvarray.js`](selectvarray.js)                      | Shows inserting and selecting from a VARRAY column
+[`sessionfixup.js`](sessionfixup.js)                      | Shows a pooled connection callback to efficiently set session state
+[`sessiontagging1.js`](sessiontagging1.js)                | Simple pooled connection tagging for setting session state
+[`sessiontagging2.js`](sessiontagging2.js)                | More complex example of pooled connection tagging for setting session state
+[`soda1.js`](soda1.js)                                    | Basic Simple Oracle Document Access (SODA) example
+[`version.js`](version.js)                                | Shows the node-oracledb version attributes
+[`webappawait.js`](webappawait.js)                        | A simple web application using a connection pool

examples/aqmulti.js

@@ -77,6 +77,8 @@ async function deq() {
     const queue = await connection.getQueue(queueName);
     queue.deqOptions.visibility = oracledb.AQ_VISIBILITY_IMMEDIATE; // Change the visibility so no explicit commit is required
 
+    console.log('Dequeuing messages');
+
     const messages = await queue.deqMany(5);  // get at most 5 messages
     console.log("Dequeued " + messages.length + " messages");
     for (const msg of messages) {

examples/aqobject.js

@@ -22,7 +22,7 @@
  *   Oracle Advanced Queuing (AQ) example passing an Oracle Database object
  *
  *   Before running this, a queue allowing an Oracle Database object
- *   payloads must be created, see
+ *   payload must be created, see
  *   https://oracle.github.io/node-oracledb/doc/api.html#aqobjexample
  *
  *   This example requires node-oracledb 4 or later.

examples/blobhttp.js

@@ -22,38 +22,33 @@
  *   Listens for an HTTP request and returns an image queried from a BLOB column
  *   Also shows the connection pool's caching using a 'default' pool.
  *
- *   Use demo.sql to create the required table or do:
- *     DROP TABLE mylobs;
- *     CREATE TABLE mylobs (id NUMBER, c CLOB, b BLOB);
- *
- *   Run lobinsert1.js to load an image before running this example.
- *
  *   Start the listener with 'node blobhttp.js' and then use a browser
  *   to load http://localhost:7000/getimage
  *
  *   This example uses Node 8's async/await syntax.
  *
  *****************************************************************************/
 
-var url = require('url');
-var http = require('http');
-var oracledb = require('oracledb');
-var dbConfig = require('./dbconfig.js');
+const url = require('url');
+const http = require('http');
+const oracledb = require('oracledb');
+const dbConfig = require('./dbconfig.js');
+const demoSetup = require('./demosetup.js');
 
-var httpPort = 7000;
+const httpPort = 7000;
 
 // Main entry point.  Creates a connection pool which becomes the
 // 'default' pool, and then creates an HTTP server.
 async function init() {
   try {
-    await oracledb.createPool(
-      {
-        user: dbConfig.user,
-        password: dbConfig.password,
-        connectString: dbConfig.connectString
-      });
+    await oracledb.createPool(dbConfig);
     console.log('Connection pool started');
 
+    // create the demo table
+    const connection = await oracledb.getConnection();
+    await demoSetup.setupLobs(connection, true);
+    await connection.close();
+
     // Create HTTP server and listen on port httpPort
     const server = http.createServer();
     server.on('error', (err) => {
@@ -63,7 +58,7 @@ async function init() {
       handleRequest(request, response);
     });
     await server.listen(httpPort);
-    console.log("Server running.  Try requesting: http://localhost:" + httpPort + "/getimage");
+    console.log("Server is running.  Try loading http://localhost:" + httpPort + "/getimage");
 
   } catch (err) {
     console.error('init() error: ' + err.message);
@@ -84,14 +79,14 @@ async function handleRequest(request, response) {
       connection = await oracledb.getConnection();  // gets a connection from the 'default' connection pool
 
       const result = await connection.execute(
-        "SELECT b FROM mylobs WHERE id = :id",  // get the image
+        "SELECT b FROM no_lobs WHERE id = :id",  // get the image
         { id: 2 }
       );
       if (result.rows.length === 0) {
-        throw new Error("No results.  Did you run lobinsert1.js?");
+        throw new Error("No data selected from table.");
       }
 
-      var lob = result.rows[0][0];
+      const lob = result.rows[0][0];
       if (lob === null) {
         throw new Error("BLOB was NULL");
       }
@@ -117,6 +112,7 @@ async function handleRequest(request, response) {
 
     } catch (err) {
       console.error(err);
+      await closePoolAndExit();
     } finally {
       if (connection) {
         try {
@@ -137,9 +133,9 @@ async function closePoolAndExit() {
   console.log('\nTerminating');
   try {
     // Get the pool from the pool cache and close it when no
-    // connections are in use, or force it closed after 10 seconds
+    // connections are in use, or force it closed after 2 seconds
     // If this hangs, you may need DISABLE_OOB=ON in a sqlnet.ora file
-    await oracledb.getPool().close(10);
+    await oracledb.getPool().close(2);
     console.log('Pool closed');
     process.exit(0);
   } catch(err) {