@ac-moore-inc/oracledb-wrapper v3.0.1

OracleDb Wrapper

An easy to use orabledb wrapper with pagination and large result support.

Created and maintained by the A.C. Moore software engineering team.

Methods

prepareService

Create the connection pools for provided databases

prepareService(config);

Parameters:

config: object

A configuration object containing information related to the database is required to connect. It is utilized by prepareService and close

config Example:

{
    databaseName: {
        'connectString': 'dbconnect',
        'poolMin': 4,
        'poolMax': 200,
        'poolIncrement': 4,
        'poolTimeout': 60,
        'user': 'db_user_name',
        'password': 'db_pass',
        'queueRequests': true,
        'queueTimeout': 0
    },
    other db connections...
}

getConnection

If connection is passed return same connection, otherwise create the connection

getConnection(databaseOrConnection, callback);

Parameters:

databaseOrConnection:

Pass the database name as a string or an existing connection

releaseConn

Releases the database connection

release(connection, info);

Parameters:

connection:

Reference to the established connection

info: string

Debugging information, will be logged if any error is encountered while releasing the connection

close

Closes the database connection pool

close(config, callback);

Parameters:

config:

See prepareService

selectQuery

Executes a select query to the database

executeQuery(options, callback);

Parameters:

options: object

qrydata:

bindvars: object

bindvars object Example:

var bindvars = {
  I_EMPLOYEE_ID: {
      val: employeeId,
      type: oracledb.NUMBER,
      dir: oracledb.BIND_IN
  },
  O_ERROR_MESSAGE: {
      type: oracledb.STRING,
      dir: oracledb.BIND_OUT
  },
  v_Return: {
      type: oracledb.NUMBER,
      dir: oracledb.BIND_OUT
  }
};

bindvars: array

If the bind variables are simple values, they can be passed in an array

bindvars array Example:

var iemployee_id = employeeId
var iemployee_name = employeeName
var bindvars = [iemployee_id., iemployee_name];

executePkg

Executes a package call to the database

executePkg is also capible of executing select and update statements. Unlike selectQuery, executePkg is not optimized to retrieve large sets of data.

executePkg(options, callback);

If connection is passed in the options variable then query considered to be part of transaction and there will be no commit

If connection is not passed in the options variable then query considered to be a standalone query and there will be an autoCommit

Parameters:

options: object

buildBindVariables

Builds bind variables object for package calls.

buildBindVariables(inputStructure, input);

Parameters:

inputStructure: Array

Elements: Field name, Type, Dir, Required(boolean)

Types Mapping:

Dirs Mapping:

inputStructure Example:

let inputStructure = [
  ['employee', 'S', 'I', true],
  ['salary', 'N', 'I', true],
  ['hire_date', 'D', 'I', false]
  ['entry_id', 'N', 'O'],
  ['error_message', 'S', 'O']
];

input: Object

The input object property names must match the field names in inputStructure

input Example:

let input = {
  employee: 'Sally Sales',
  salary: 100000,
  hire_date: '2017-03-17T17:47:08.000Z'
};