node-oracledb Documentation for the Oracle Database Node.js Add-on

This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.

If you elect to accept the software under the Apache License, Version 2.0, the following applies:

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See LICENSE.txt and THIRD_PARTY_LICENSES.txt.

Note: The node-oracledb documentation has moved to https://node-oracledb.readthedocs.io/en/latest/.

Manual Sections

This document contains:

Node-oracledb API Manual
Node-oracledb User Manual

For installation information, see the Node-oracledb Installation Instructions.

Files

api.md

Latest commit

History

api.md

File metadata and controls

node-oracledb Documentation for the Oracle Database Node.js Add-on

Note: The node-oracledb documentation has moved to https://node-oracledb.readthedocs.io/en/latest/.

Manual Sections

NODE-ORACLEDB API MANUAL

1. Introduction

1.1 Node-oracledb Architecture

1.2 Getting Started with Node-oracledb

1.2.1 Example: A SQL SELECT statement in Node.js

1.2.2 Example: Simple Oracle Document Access (SODA) in Node.js

2. Errors

2.1 Error Properties

2.1.1 errorNum

2.1.2 message

2.1.3 offset

2.1.4 stack

3. Oracledb Class

3.1 Oracledb Constants

3.1.1 Query outFormat Constants

3.1.2 Oracle Database Type Constants

3.1.3 Node-oracledb Type Constants

3.1.4 Execute Bind Direction Constants

3.1.5 Privileged Connection Constants

3.1.6 SQL Statement Type Constants

3.1.7 Subscription Constants

3.1.8 Advanced Queuing Constants

3.1.9 Continuous Query Notification Constants

3.1.10 Pool Status Constants

3.1.11 Simple Oracle Document Access (SODA) Constants

3.1.12 Database Shutdown Constants

3.1.12 Two-Phase Commit Constants

3.2 Oracledb Properties

3.2.1 oracledb.autoCommit

3.2.2 oracledb.connectionClass

3.2.3 oracledb.dbObjectAsPojo

3.2.4 oracledb.edition

3.2.5 oracledb.errorOnConcurrentExecute

3.2.6 oracledb.events

3.2.7 oracledb.extendedMetaData

3.2.8 oracledb.externalAuth

3.2.9 oracledb.fetchArraySize

3.2.10 oracledb.fetchAsBuffer

3.2.11 oracledb.fetchAsString

3.2.12 oracledb.lobPrefetchSize

3.2.13 oracledb.maxRows

3.2.14 oracledb.oracleClientVersion

3.2.15 oracledb.oracleClientVersionString

3.2.16 oracledb.outFormat

3.2.17 oracledb.poolIncrement

3.2.18 oracledb.poolMax

3.2.19 oracledb.poolMaxPerShard

3.2.20 oracledb.poolMin

3.2.21 oracledb.poolPingInterval

3.2.22 oracledb.poolTimeout

3.2.23 oracledb.prefetchRows

3.2.24 oracledb.Promise

3.2.25 oracledb.queueMax

3.2.26 oracledb.queueRequests

3.2.27 oracledb.queueTimeout

3.2.28 oracledb.stmtCacheSize

3.2.29 oracledb.version

3.2.30 oracledb.versionString

3.2.31 oracledb.versionSuffix

3.3 Oracledb Methods

3.3.1 oracledb.createPool()

3.3.1.1 createPool(): Parameters and Attributes

3.3.1.1.1 accessToken: Attributes

3.3.1.1.2 accessTokenCallback

3.3.1.1.3 connectString, connectionString

3.3.1.1.4 edition

3.3.1.1.5 enableStatistics

3.3.1.1.6 events

3.3.1.1.7 externalAuth

3.3.1.1.8 homogeneous

3.3.1.1.9 password

2.1.1 `errorNum`

2.1.2 `message`

2.1.3 `offset`

2.1.4 `stack`

3.1.1 Query `outFormat` Constants

3.2.1 `oracledb.autoCommit`

3.2.2 `oracledb.connectionClass`

3.2.3 `oracledb.dbObjectAsPojo`

3.2.4 `oracledb.edition`

3.2.5 `oracledb.errorOnConcurrentExecute`

3.2.6 `oracledb.events`

3.2.7 `oracledb.extendedMetaData`

3.2.8 `oracledb.externalAuth`

3.2.9 `oracledb.fetchArraySize`

3.2.10 `oracledb.fetchAsBuffer`

3.2.11 `oracledb.fetchAsString`

3.2.12 `oracledb.lobPrefetchSize`

3.2.13 `oracledb.maxRows`

3.2.14 `oracledb.oracleClientVersion`

3.2.15 `oracledb.oracleClientVersionString`

3.2.16 `oracledb.outFormat`

3.2.17 `oracledb.poolIncrement`

3.2.18 `oracledb.poolMax`

3.2.19 `oracledb.poolMaxPerShard`

3.2.20 `oracledb.poolMin`

3.2.21 `oracledb.poolPingInterval`

3.2.22 `oracledb.poolTimeout`

3.2.23 `oracledb.prefetchRows`

3.2.24 `oracledb.Promise`

3.2.25 `oracledb.queueMax`

3.2.26 `oracledb.queueRequests`

3.2.27 `oracledb.queueTimeout`

3.2.28 `oracledb.stmtCacheSize`

3.2.29 `oracledb.version`

3.2.30 `oracledb.versionString`

3.2.31 `oracledb.versionSuffix`

3.3.1 `oracledb.createPool()`

3.3.1.1 `createPool()`: Parameters and Attributes

3.3.1.1.1 `accessToken`: Attributes

3.3.1.1.2 `accessTokenCallback`

3.3.1.1.3 `connectString`, `connectionString`

3.3.1.1.4 `edition`

3.3.1.1.5 `enableStatistics`

3.3.1.1.6 `events`

3.3.1.1.7 `externalAuth`

3.3.1.1.8 `homogeneous`

3.3.1.1.9 `password`

3.3.1.1.10 `poolAlias`

3.3.1.1.11 `poolIncrement`

3.3.1.1.12 `poolMax`

3.3.1.1.13 `poolMaxPerShard`

3.3.1.1.14 `poolMin`

3.3.1.1.15 `poolPingInterval`

3.3.1.1.16 `poolTimeout`

3.3.1.1.17 `queueMax`

3.3.1.1.18 `queueRequests`

3.3.1.1.19 `queueTimeout`

3.3.1.1.20 `sessionCallback`

3.3.1.1.21 `sodaMetaDataCache`

3.3.1.1.22 `stmtCacheSize`

3.3.1.1.23 `user`, `username`

3.3.1.2 `createPool()`: Callback Function

3.3.2 `oracledb.getConnection()`

3.3.2.1 `getConnection()`: Parameters

3.3.2.1.2 `getConnection()`: Attributes

3.3.2.1.2.1 `accessToken`: Attributes

3.3.2.1.2.2 `connectString`, `connectionString`

3.3.2.1.2.3 `edition`

3.3.2.1.2.4 `events`

3.3.2.1.2.5 `externalAuth`

3.3.2.1.2.6 `matchAny`

3.3.2.1.2.7 `newPassword`

3.3.2.1.2.8 `poolAlias`

3.3.2.1.2.9 `password`

3.3.2.1.2.10 `privilege`

3.3.2.1.2.11 `shardingKey`

3.3.2.1.2.12 `stmtCacheSize`

3.3.2.1.2.13 `superShardingKey`

3.3.2.1.2.14 `tag`

3.3.2.1.2.15 `user`, `username`