Global

Type Definitions

OracleConnectionOptions

Oracle specific extension of the typedefs.SQLERConnectionOptions from the sqler module.

Properties:
Name Type Attributes Description
driverOptions OracleDriverOptions <optional>

The oracledb module specific options.

Source:
Type:
  • Object

OracleDriverOptions

Oracle specific driver options

Properties:
Name Type Attributes Default Description
global Object <optional>

An object that will contain properties set on the global oracledb module class. When a value is a string surrounded by ${}, it will be assumed to be a constant property that resides on the oracledb module and will be interpolated accordingly. For example driverOptions.global.someProp = '${ORACLEDB_CONSTANT}' will be interpolated as oracledb.someProp = oracledb.ORACLEDB_CONSTANT.

pool Object <optional>

The pool conf options that will be passed into oracledb.createPool({ conf }). Using any of the generic pool.someOption will override the conf options set on driverOptions.pool. When a value is a string surrounded by ${}, it will be assumed to be a constant property that resides on the oracledb module and will be interpolated accordingly. For example driverOptions.pool.someProp = '${ORACLEDB_CONSTANT}' will be interpolated as pool.someProp = oracledb.ORACLEDB_CONSTANT.

pingOnInit Boolean <optional>
true

A truthy flag that indicates if a ping will be performed after the connection pool is created when OracleDialect.init is called.

useTNS Boolean <optional>

Truthy to build a TNS sql*net connection string

stmtCacheSize Number <optional>
numberOfSQLFiles * 3

The statement size that oracledb uses

Source:
Type:
  • Object

OracleExecDriverOptions

Oracle specific extension of the execution options

Properties:
Name Type Attributes Description
pool DBDriver.Pool <optional>

The pool attribute options passed into oracledbPool.getConnection(). When a value is a string surrounded by ${}, it will be assumed to be a constant property that resides on the oracledb module and will be interpolated accordingly. For example driverOptions.pool.someProp = '${ORACLEDB_CONSTANT}' will be interpolated as pool.someProp = oracledb.ORACLEDB_CONSTANT.

exec DBDriver.ExecuteOptions | DBDriver.ExecuteManyOptions <optional>

The execution options passed into oracledbConnection.execute(). NOTE: driverOptions.autoCommit is ignored in favor of the universal autoCommit set directly on the typedefs.SQLERExecOptions. When a value is a string surrounded by ${}, it will be assumed to be a constant property that resides on the oracledb module and will be interpolated accordingly. For example driverOptions.exec.someProp = '${ORACLEDB_CONSTANT}' will be interpolated as oracledbExecOpts.someProp = oracledb.ORACLEDB_CONSTANT. When streaming writes using execOpts.stream, all executions are batched into oracledb.Connection.executeMany using execOpts.stream value as the batch size. Therefore, a valid exec.bindDefs should be included as defined within the oracldb documentation when DML RETURNING.

Source:
Type:
  • Object

OracleExecOptions

Oracle specific extension of the typedefs.SQLERExecOptions from the sqler module. When a property of binds contains an object it will be interpolated for property values on the oracledb module. For example, binds.name = { dir: '${BIND_OUT}', type: '${STRING}', maxSize: 40 } will be interpolated as binds.name = { dir: oracledb.BIND_OUT, type: oracledb.STRING, maxSize: 40 }.

Properties:
Name Type Attributes Description
driverOptions OracleExecDriverOptions <optional>

The oracledb module specific execution options.

Source:
Type:
  • Object

OracleTransactionObject

Transactions are wrapped in a parent transaction object so private properties can be added (e.g. prepared statements)

Properties:
Name Type Description
tx typedefs.SQLERTransaction

The transaction

conn DBDriver.Connection

The connection

unprepares Map.<String, function()>

Map of prepared statement names (key) and no-argument async functions that will be called as a pre-operation call prior to commit or rollback (value)

Source:
Type:
  • Object

3.0.0 (2021-08-26)

Full Changelog

Features:

Fixes: