web_plsql 0.3.2 → 0.5.0

package/examples/apex.js

@@ -1,70 +1,70 @@
-const fs = require('fs');
-const path = require('path');
-const express = require('express');
-const bodyParser = require('body-parser');
-const multipart = require('connect-multiparty');
-const cookieParser = require('cookie-parser');
-const compression = require('compression');
-const morgan = require('morgan');
-
-const oracledb = require('oracledb');
-const webplsql = require('../lib');
-
-/*
-*	Allocate the Oracle database pool
-*/
-
-const connectionPool = oracledb.createPool({
-	user: 'APEX_PUBLIC_USER',
-	password: 'manager',
-	connectString: 'localhost:1521/TEST',
-	poolMin: 10,
-	poolMax: 1000,
-	poolIncrement: 10,
-	queueRequests: false,
-	queueTimeout: 1000
-});
-
-connectionPool.catch(e => {
-	console.error(`Unable to create database pool.\n${e.message}`);
-	process.exit(1);
-});
-
-/*
-*	Start the server
-*/
-
-const PORT = 8000;
-const PATH = '/apex';
-const OPTIONS = {
-	trace: 'on',
-	defaultPage: 'apex',
-	doctable: 'wwv_flow_file_objects$',
-	pathAlias: {
-		alias: 'r',
-		procedure: 'wwv_flow.resolve_friendly_url'
-	},
-	errorStyle: 'debug'
-};
-
-// create express app
-const app = express();
-
-// add middleware
-app.use(multipart());
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: true}));
-app.use(cookieParser());
-app.use(compression());
-app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
-
-// add the oracle pl/sql express middleware
-app.use(PATH + '/:name?', webplsql(connectionPool, OPTIONS));
-
-// serving static files
-const staticFilesPath = path.resolve('/Middleware/apex/images/');
-app.use('/i/', express.static(staticFilesPath));
-
-// listen on port
-console.log(`Listening on http://localhost:${PORT}${PATH}`);
-app.listen(PORT);
+const fs = require('fs');
+const path = require('path');
+const express = require('express');
+const bodyParser = require('body-parser');
+const multipart = require('connect-multiparty');
+const cookieParser = require('cookie-parser');
+const compression = require('compression');
+const morgan = require('morgan');
+
+const oracledb = require('oracledb');
+const webplsql = require('../lib');
+
+/*
+*	Allocate the Oracle database pool
+*/
+
+const connectionPool = oracledb.createPool({
+	user: 'APEX_PUBLIC_USER',
+	password: 'manager',
+	connectString: 'localhost:1521/TEST',
+	poolMin: 10,
+	poolMax: 1000,
+	poolIncrement: 10,
+	queueRequests: false,
+	queueTimeout: 1000
+});
+
+connectionPool.catch(e => {
+	console.error(`Unable to create database pool.\n${e.message}`);
+	process.exit(1);
+});
+
+/*
+*	Start the server
+*/
+
+const PORT = 8000;
+const PATH = '/apex';
+const OPTIONS = {
+	trace: 'on',
+	defaultPage: 'apex',
+	doctable: 'wwv_flow_file_objects$',
+	pathAlias: {
+		alias: 'r',
+		procedure: 'wwv_flow.resolve_friendly_url'
+	},
+	errorStyle: 'debug'
+};
+
+// create express app
+const app = express();
+
+// add middleware
+app.use(multipart());
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({extended: true}));
+app.use(cookieParser());
+app.use(compression());
+app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
+
+// add the oracle pl/sql express middleware
+app.use(PATH + '/:name?', webplsql(connectionPool, OPTIONS));
+
+// serving static files
+const staticFilesPath = path.resolve('/Middleware/apex/images/');
+app.use('/i/', express.static(staticFilesPath));
+
+// listen on port
+console.log(`Listening on http://localhost:${PORT}${PATH}`);
+app.listen(PORT);

package/examples/credentials.js

@@ -1,22 +1,22 @@
-/*
- *   Holds the credentials used to connect to the database.
- */
-
-module.exports = {
-  user          : process.env.NODE_ORACLEDB_USER || 'sample',
-
-  // Get the password from the environment variable
-  // NODE_ORACLEDB_PASSWORD.  The password could also be a hard coded
-  // string (not recommended), or it could be prompted for.
-  // Alternatively use External Authentication so that no password is
-  // needed.
-  password      : process.env.NODE_ORACLEDB_PASSWORD || 'sample',
-
-  // For information on connection strings see:
-  // https://oracle.github.io/node-oracledb/doc/api.html#connectionstrings
-  connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING || 'localhost:1521/test',
-
-  // Setting externalAuth is optional.  It defaults to false.  See:
-  // https://oracle.github.io/node-oracledb/doc/api.html#extauth
-  externalAuth  : process.env.NODE_ORACLEDB_EXTERNALAUTH ? true : false
-};
+/*
+ *   Holds the credentials used to connect to the database.
+ */
+
+module.exports = {
+  user          : process.env.NODE_ORACLEDB_USER || 'sample',
+
+  // Get the password from the environment variable
+  // NODE_ORACLEDB_PASSWORD.  The password could also be a hard coded
+  // string (not recommended), or it could be prompted for.
+  // Alternatively use External Authentication so that no password is
+  // needed.
+  password      : process.env.NODE_ORACLEDB_PASSWORD || 'sample',
+
+  // For information on connection strings see:
+  // https://oracle.github.io/node-oracledb/doc/api.html#connectionstrings
+  connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING || 'localhost:1521/test',
+
+  // Setting externalAuth is optional.  It defaults to false.  See:
+  // https://oracle.github.io/node-oracledb/doc/api.html#extauth
+  externalAuth  : process.env.NODE_ORACLEDB_EXTERNALAUTH ? true : false
+};

package/examples/oracledb_example.js

@@ -1,30 +1,30 @@
-const oracledb = require('oracledb');
-const dbConfig = require('./credentials.js');
-
-async function run() {
-	let connection;
-
-	try {
-		// Connect to database
-		connection = await oracledb.getConnection(dbConfig);
-
-		// Select some data
-		binds = {};
-		result = await connection.execute('SELECT sysdate FROM dual', binds, {});
-		console.log('metadata: ', result.metaData);
-		console.log('results: ');
-		console.log(result.rows);
-	} catch (err) {
-		console.error(err);
-	} finally {
-		if (connection) {
-			try {
-				await connection.close();
-			} catch (err) {
-				console.error(err);
-			}
-		}
-	}
-}
-
-run();
+const oracledb = require('oracledb');
+const dbConfig = require('./credentials.js');
+
+async function run() {
+	let connection;
+
+	try {
+		// Connect to database
+		connection = await oracledb.getConnection(dbConfig);
+
+		// Select some data
+		binds = {};
+		result = await connection.execute('SELECT sysdate FROM dual', binds, {});
+		console.log('metadata: ', result.metaData);
+		console.log('results: ');
+		console.log(result.rows);
+	} catch (err) {
+		console.error(err);
+	} finally {
+		if (connection) {
+			try {
+				await connection.close();
+			} catch (err) {
+				console.error(err);
+			}
+		}
+	}
+}
+
+run();

package/examples/sample.js

@@ -1,84 +1,101 @@
-const fs = require('fs');
-const path = require('path');
-const express = require('express');
-const bodyParser = require('body-parser');
-const multipart = require('connect-multiparty');
-const cookieParser = require('cookie-parser');
-const compression = require('compression');
-const morgan = require('morgan');
-
-const oracledb = require('oracledb');
-const webplsql = require('../lib');
-
-
-/*
-*	Holds the credentials used by node-oracledb examples to connect
-*	to the database.  Production applications should consider using
-*	External Authentication to avoid hard coded credentials.
-*/
-const dbConfig = require('./credentials.js');
-
-/*
-*	Allocate the Oracle database pool
-*/
-
-const connectionPool = oracledb.createPool({
-	user: dbConfig.user,					// The database user name.
-	password: dbConfig.password,			// The password of the database user.
-	connectString: dbConfig.connectString,	// The Oracle database instance to connect to. The string can be an Easy Connect string, or a Net Service Name from a tnsnames.ora file, or the name of a local Oracle database instance.
-	poolMin: 10,							// The minimum number of connections a connection pool maintains, even when there is no activity to the target database.
-	poolMax: 1000,							// The maximum number of connections to which a connection pool can grow.
-	poolIncrement: 10,						// The number of connections that are opened whenever a connection request exceeds the number of currently open connections.
-	queueRequests: false,					// If this property is false and a request for a connection is made from a pool where the number of “checked out” connections has reached poolMax, then an ORA-24418 error indicating that further sessions cannot be opened will be returned.
-	queueTimeout: 1000						// The number of milliseconds after which connection requests waiting in the connection request queue are terminated. If queueTimeout is 0, then queued connection requests are never terminated.
-});
-
-connectionPool.catch(e => {
-	console.error(`Unable to create database pool.\n${e.message}`);
-	process.exit(1);
-});
-
-/*
-*	Start the server
-*/
-
-const PORT = 8000;
-const PATH = '/base';
-const OPTIONS = {
-	trace: 'on',
-	defaultPage: 'sample.pageIndex',
-	doctable: 'docTable',
-	pathAlias: {
-		alias: 'myalias',
-		procedure: 'sample.pagePathAlias'
-	},
-	errorStyle: 'debug'
-};
-
-// Welcome message
-console.log(`Welcome to web_plsql version ${webplsql.version}!`);
-
-// create express app
-const app = express();
-
-// add middleware
-app.use(multipart());
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: true}));
-app.use(cookieParser());
-app.use(compression());
-app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
-
-// add express status monitor
-app.use(require('express-status-monitor')());
-console.log(`Express status monitor is listening on http://localhost:${PORT}/status`);
-
-// add the oracle pl/sql express middleware
-app.use(PATH + '/:name?', webplsql(connectionPool, OPTIONS));
-
-// serving static files
-app.use('/static', express.static(path.join(process.cwd(), 'examples/static')));
-
-// listen on port
-console.log(`Sample app is listening on http://localhost:${PORT}${PATH}`);
-app.listen(PORT);
+const fs = require('fs');
+const path = require('path');
+const express = require('express');
+const bodyParser = require('body-parser');
+const multipart = require('connect-multiparty');
+const cookieParser = require('cookie-parser');
+const compression = require('compression');
+const morgan = require('morgan');
+
+const oracledb = require('oracledb');
+const webplsql = require('../lib');
+
+
+/*
+*	Holds the credentials used by node-oracledb examples to connect
+*	to the database.  Production applications should consider using
+*	External Authentication to avoid hard coded credentials.
+*/
+const dbConfig = require('./credentials.js');
+
+/*
+*	Allocate the Oracle database pool
+*/
+
+const connectionPool = oracledb.createPool({
+	user: dbConfig.user,					// The database user name.
+	password: dbConfig.password,			// The password of the database user.
+	connectString: dbConfig.connectString,	// The Oracle database instance to connect to. The string can be an Easy Connect string, or a Net Service Name from a tnsnames.ora file, or the name of a local Oracle database instance.
+	poolMin: 10,							// The minimum number of connections a connection pool maintains, even when there is no activity to the target database.
+	poolMax: 1000,							// The maximum number of connections to which a connection pool can grow.
+	poolIncrement: 10,						// The number of connections that are opened whenever a connection request exceeds the number of currently open connections.
+	queueRequests: false,					// If this property is false and a request for a connection is made from a pool where the number of “checked out” connections has reached poolMax, then an ORA-24418 error indicating that further sessions cannot be opened will be returned.
+	queueTimeout: 1000						// The number of milliseconds after which connection requests waiting in the connection request queue are terminated. If queueTimeout is 0, then queued connection requests are never terminated.
+});
+
+connectionPool.catch(e => {
+	console.error(`Unable to create database pool.\n${e.message}`);
+	process.exit(1);
+});
+
+/*
+*	Start the server
+*/
+
+const PORT = 8000;
+const PATH = '/base';
+const OPTIONS = {
+	trace: 'on',
+	defaultPage: 'sample.pageIndex',
+	doctable: 'docTable',
+	pathAlias: {
+		alias: 'myalias',
+		procedure: 'sample.pagePathAlias'
+	},
+	errorStyle: 'debug'
+};
+
+// Welcome message
+console.log(`Welcome to web_plsql version ${webplsql.version}!`);
+
+// create express app
+const app = express();
+
+// add middleware
+app.use(multipart());
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({extended: true}));
+app.use(cookieParser());
+app.use(compression());
+app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
+
+// add express status monitor
+app.use(require('express-status-monitor')());
+console.log(`Express status monitor is listening on http://localhost:${PORT}/status`);
+
+// add the oracle pl/sql express middleware
+app.use(PATH + '/:name?', webplsql(connectionPool, OPTIONS));
+
+// serving static files
+app.use('/static', express.static(path.join(process.cwd(), 'examples/static')));
+
+// shutdown
+process.on('SIGTERM', shutDown);
+process.on('SIGINT', shutDown);
+
+// listen on port
+console.log(`Sample app is listening on http://localhost:${PORT}${PATH}`);
+const server = app.listen(PORT);
+
+function shutDown() {
+	console.log('Received kill signal, shutting down gracefully');
+	server.close(() => {
+		console.log('Closed out remaining connections');
+		process.exit(0);
+	});
+
+	setTimeout(() => {
+		console.error('Could not close connections in time, forcefully shutting down');
+		process.exit(1);
+	}, 10000);
+}

package/examples/sql/doc_table.sql

@@ -1,13 +1,13 @@
-DROP TABLE docTable;
-
-CREATE TABLE docTable
-(
-	NAME			VARCHAR(128) UNIQUE NOT NULL,
-	MIME_TYPE		VARCHAR(128),
-	DOC_SIZE		NUMBER,
-	DAD_CHARSET		VARCHAR(128),
-	LAST_UPDATED	DATE,
-	CONTENT_TYPE	VARCHAR(128),
-	CONTENT			LONG RAW,
-	BLOB_CONTENT	BLOB
-);
+DROP TABLE docTable;
+
+CREATE TABLE docTable
+(
+	NAME			VARCHAR(128) UNIQUE NOT NULL,
+	MIME_TYPE		VARCHAR(128),
+	DOC_SIZE		NUMBER,
+	DAD_CHARSET		VARCHAR(128),
+	LAST_UPDATED	DATE,
+	CONTENT_TYPE	VARCHAR(128),
+	CONTENT			LONG RAW,
+	BLOB_CONTENT	BLOB
+);

package/examples/sql/install.sql

@@ -1,31 +1,31 @@
--- set the username
-define SAMPLE_USER=sample
-
--- create user
-CREATE USER &&SAMPLE_USER IDENTIFIED BY &&SAMPLE_USER;
-
--- assign privileges
-GRANT create session TO &&SAMPLE_USER;
-GRANT unlimited tablespace TO &&SAMPLE_USER;
-GRANT create table TO &&SAMPLE_USER;
-GRANT create view TO &&SAMPLE_USER;
-GRANT create sequence TO &&SAMPLE_USER;
-GRANT create procedure TO &&SAMPLE_USER;
-GRANT execute on dbms_lob TO &&SAMPLE_USER;
-GRANT execute on dbms_output TO &&SAMPLE_USER;
-GRANT execute on dbms_lock TO &&SAMPLE_USER;
-
--- change schema
-ALTER SESSION SET CURRENT_SCHEMA=&&SAMPLE_USER;
-
--- install document table
-@doc_table.sql
-
--- install demo
-@sample.pks
-show errors
-@sample.pkb
-show errors
-
--- show errors
-select * from user_errors;
+-- set the username
+define SAMPLE_USER=sample
+
+-- create user
+CREATE USER &&SAMPLE_USER IDENTIFIED BY &&SAMPLE_USER;
+
+-- assign privileges
+GRANT create session TO &&SAMPLE_USER;
+GRANT unlimited tablespace TO &&SAMPLE_USER;
+GRANT create table TO &&SAMPLE_USER;
+GRANT create view TO &&SAMPLE_USER;
+GRANT create sequence TO &&SAMPLE_USER;
+GRANT create procedure TO &&SAMPLE_USER;
+GRANT execute on dbms_lob TO &&SAMPLE_USER;
+GRANT execute on dbms_output TO &&SAMPLE_USER;
+GRANT execute on dbms_lock TO &&SAMPLE_USER;
+
+-- change schema
+ALTER SESSION SET CURRENT_SCHEMA=&&SAMPLE_USER;
+
+-- install document table
+@doc_table.sql
+
+-- install demo
+@sample.pks
+show errors
+@sample.pkb
+show errors
+
+-- show errors
+select * from user_errors;