node-oracledb

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

Copyright (c) 2015, 2022, Oracle and/or its affiliates.

You may not use the identified files except in compliance with the Apache License, Version 2.0 (the “License.”)

You may obtain a copy of the License at http://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 5.5 documentation has moved to https://node-oracledb.readthedocs.io/en/latest/.

The new documentation layout facilitates better search and navigation of the content. For future node-oracledb releases, the latest updates will only be added to the new node-oracledb documentation.


Manual Sections

This document contains:

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

NODE-ORACLEDB API MANUAL

1. Introduction

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#intro.

1.1 Node-oracledb Architecture

View latest documentation

1.2 Getting Started with Node-oracledb

View latest documentation

1.2.1 Example: A SQL SELECT statement in Node.js

View latest documentation

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

View latest documentation

2. Errors

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/errors.html#errorobj.

2.1 Error Properties

View latest documentation

2.1.1 errorNum

View latest documentation

2.1.2 message

View latest documentation

2.1.3 offset

View latest documentation

2.1.4 stack

View latest documentation

3. Oracledb Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/oracledb.html#oracledbclass.

3.1 Oracledb Constants

View latest documentation

3.1.1 Query outFormat Constants

View latest documentation

3.1.2 Oracle Database Type Constants

View latest documentation

3.1.3 Node-oracledb Type Constants

View latest documentation

3.1.4 Execute Bind Direction Constants

View latest documentation

3.1.5 Privileged Connection Constants

View latest documentation

3.1.6 SQL Statement Type Constants

View latest documentation

3.1.7 Subscription Constants

View latest documentation

3.1.8 Advanced Queuing Constants

View latest documentation

3.1.9 Continuous Query Notification Constants

View latest documentation

3.1.10 Pool Status Constants

View latest documentation

3.1.11 Simple Oracle Document Access (SODA) Constants

View latest documentation

3.1.12 Database Shutdown Constants

View latest documentation

3.1.12 Two-Phase Commit Constants

View latest documentation

3.2 Oracledb Properties

View latest documentation

3.2.1 oracledb.autoCommit

View latest documentation

3.2.2 oracledb.connectionClass

View latest documentation

3.2.3 oracledb.dbObjectAsPojo

View latest documentation

3.2.4 oracledb.edition

View latest documentation

3.2.5 oracledb.errorOnConcurrentExecute

View latest documentation

3.2.6 oracledb.events

View latest documentation

3.2.7 oracledb.extendedMetaData

View latest documentation

3.2.8 oracledb.externalAuth

View latest documentation

3.2.9 oracledb.fetchArraySize

View latest documentation

3.2.10 oracledb.fetchAsBuffer

View latest documentation

3.2.11 oracledb.fetchAsString

View latest documentation

3.2.12 oracledb.lobPrefetchSize

View latest documentation

3.2.13 oracledb.maxRows

View latest documentation

3.2.14 oracledb.oracleClientVersion

View latest documentation

3.2.15 oracledb.oracleClientVersionString

View latest documentation

3.2.16 oracledb.outFormat

View latest documentation

3.2.17 oracledb.poolIncrement

View latest documentation

3.2.18 oracledb.poolMax

View latest documentation

3.2.19 oracledb.poolMaxPerShard

View latest documentation

3.2.20 oracledb.poolMin

View latest documentation

3.2.21 oracledb.poolPingInterval

View latest documentation

3.2.22 oracledb.poolTimeout

View latest documentation

3.2.23 oracledb.prefetchRows

View latest documentation

3.2.24 oracledb.Promise

View latest documentation

3.2.25 oracledb.queueMax

View latest documentation

3.2.26 oracledb.queueRequests

View latest documentation

3.2.27 oracledb.queueTimeout

View latest documentation

3.2.28 oracledb.stmtCacheSize

View latest documentation

3.2.29 oracledb.version

View latest documentation

3.2.30 oracledb.versionString

View latest documentation

3.2.31 oracledb.versionSuffix

View latest documentation

3.3 Oracledb Methods

View latest documentation

3.3.1 oracledb.createPool()

View latest documentation

3.3.1.1 createPool(): Parameters and Attributes

View latest documentation

3.3.1.1.1 accessToken: Attributes

View latest documentation

3.3.1.1.2 accessTokenCallback

View latest documentation

3.3.1.1.3 connectString, connectionString

View latest documentation

3.3.1.1.4 edition

View latest documentation

3.3.1.1.5 enableStatistics

View latest documentation

3.3.1.1.6 events

View latest documentation

3.3.1.1.7 externalAuth

View latest documentation

3.3.1.1.8 homogeneous

View latest documentation

3.3.1.1.9 password

View latest documentation

3.3.1.1.10 poolAlias

View latest documentation

3.3.1.1.11 poolIncrement

View latest documentation

3.3.1.1.12 poolMax

View latest documentation

3.3.1.1.13 poolMaxPerShard

View latest documentation

3.3.1.1.14 poolMin

View latest documentation

3.3.1.1.15 poolPingInterval

View latest documentation

3.3.1.1.16 poolTimeout

View latest documentation

3.3.1.1.17 queueMax

View latest documentation

3.3.1.1.18 queueRequests

View latest documentation

3.3.1.1.19 queueTimeout

View latest documentation

3.3.1.1.20 sessionCallback

View latest documentation

3.3.1.1.21 sodaMetaDataCache

View latest documentation

3.3.1.1.22 stmtCacheSize

View latest documentation

3.3.1.1.23 user, username

View latest documentation

3.3.1.2 createPool(): Callback Function

View latest documentation

3.3.2 oracledb.getConnection()

View latest documentation

3.3.2.1 getConnection(): Parameters

View latest documentation

3.3.2.1.1 Pool Alias

View latest documentation

3.3.2.1.2 getConnection(): Attributes

View latest documentation

3.3.2.1.2.1 accessToken: Attributes

View latest documentation

3.3.2.1.2.2 connectString, connectionString

View latest documentation

3.3.2.1.2.3 edition

View latest documentation

3.3.2.1.2.4 events

View latest documentation

3.3.2.1.2.5 externalAuth

View latest documentation

3.3.2.1.2.6 matchAny

View latest documentation

3.3.2.1.2.7 newPassword

View latest documentation

3.3.2.1.2.8 poolAlias

View latest documentation

3.3.2.1.2.9 password

View latest documentation

3.3.2.1.2.10 privilege

View latest documentation

3.3.2.1.2.11 shardingKey

View latest documentation

3.3.2.1.2.12 stmtCacheSize

View latest documentation

3.3.2.1.2.13 superShardingKey

View latest documentation

3.3.2.1.2.14 tag

View latest documentation

3.3.2.1.2.15 user, username

View latest documentation

3.3.2.2 getConnection(): Callback Function

View latest documentation

3.3.3 oracledb.getPool()

View latest documentation

3.3.3.1 Parameters

View latest documentation

3.3.3.1.1 alias

View latest documentation

3.3.4 oracledb.initOracleClient()

View latest documentation

3.3.4.1 Parameters

View latest documentation

3.3.4.1.1 options

View latest documentation

3.3.5 oracledb.shutdown()

View latest documentation

3.3.5.1 Parameters

View latest documentation

3.3.5.1.1 connAttr

View latest documentation

3.3.5.1.2 shutdownMode

View latest documentation

3.3.5.2 shutdown(): Callback Function

View latest documentation

3.3.6 oracledb.startup()

View latest documentation

3.3.6.1 Parameters

View latest documentation

3.3.6.1.1 connAttr

View latest documentation

3.3.6.1.2 options

View latest documentation

3.3.6.2 startup(): Callback Function

View latest documentation

4. Connection Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/connection.html#connectionclass.

4.1 Connection Properties

View latest documentation

4.1.1 connection.action

View latest documentation

4.1.2 connection.callTimeout

View latest documentation

4.1.3 connection.clientId

View latest documentation

4.1.4 connection.clientInfo

View latest documentation

4.1.5 connection.currentSchema

View latest documentation

4.1.6 connection.dbOp

View latest documentation

4.1.7 connection.ecId

View latest documentation

4.1.8 connection.module

View latest documentation

4.1.9 connection.oracleServerVersion

View latest documentation

4.1.10 connection.oracleServerVersionString

View latest documentation

4.1.11 connection.stmtCacheSize

View latest documentation

4.1.12 connection.tag

View latest documentation

4.1.13 connection.tpcInternalName

View latest documentation

4.1.14 connection.tpcExternalName

View latest documentation

4.2 Connection Methods

View latest documentation

4.2.1 connection.break()

View latest documentation

4.2.2 connection.changePassword()

View latest documentation

4.2.3 connection.close()

View latest documentation

4.2.4 connection.commit()

View latest documentation

4.2.5 connection.createLob()

View latest documentation

4.2.6 connection.execute()

View latest documentation

4.2.6.1 execute(): SQL Statement

View latest documentation

4.2.6.2 execute(): Bind Parameters

View latest documentation

4.2.6.2.1 dir

View latest documentation

4.2.6.2.2 maxArraySize

View latest documentation

4.2.6.2.3 maxSize

View latest documentation

4.2.6.2.4 type

View latest documentation

4.2.6.2.5 val

View latest documentation

The input value or variable to be used for an IN or IN OUT bind variable.

4.2.6.3 execute(): Options

View latest documentation

4.2.6.3.1 autoCommit

View latest documentation

4.2.6.3.2 dbObjectAsPojo

View latest documentation

4.2.6.3.3 extendedMetaData

View latest documentation

4.2.6.3.4 fetchArraySize

View latest documentation

4.2.6.3.5 fetchInfo

View latest documentation

4.2.6.3.6 keepInStmtCache

View latest documentation

4.2.6.3.7 maxRows

View latest documentation

4.2.6.3.8 outFormat

View latest documentation

4.2.6.3.9 prefetchRows

View latest documentation

4.2.6.3.10 resultSet

View latest documentation

4.2.6.4 execute(): Callback Function

View latest documentation

Result Object Properties

View latest documentation

4.2.6.4.1 implicitResults

View latest documentation

4.2.6.4.2 lastRowid

View latest documentation

4.2.6.4.3 metaData

View latest documentation

4.2.6.4.4 outBinds

View latest documentation

4.2.6.4.5 resultSet

View latest documentation

4.2.6.4.6 rows

View latest documentation

4.2.6.4.7 rowsAffected

View latest documentation

4.2.7 connection.executeMany()

View latest documentation

4.2.7.1 executeMany(): SQL Statement

View latest documentation

4.2.7.2 executeMany(): Binds

View latest documentation

4.2.7.3 executeMany(): Options

View latest documentation

4.2.7.3.1 autoCommit

View latest documentation

4.2.7.3.2 batchErrors

View latest documentation

4.2.7.3.3 bindDefs

View latest documentation

4.2.7.3.4 dmlRowCounts

View latest documentation

4.2.7.3.5 keepInStmtCache

View latest documentation

4.2.7.4 executeMany(): Callback Function

View latest documentation

4.2.7.4.1 result.batchErrors

View latest documentation

4.2.7.4.2 result.dmlRowCounts

View latest documentation

4.2.7.4.3 result.outBinds

View latest documentation

4.2.7.4.4 result.rowsAffected

View latest documentation

4.2.8 connection.getDbObjectClass()

View latest documentation

4.2.9 connection.getQueue()

View latest documentation

4.2.10 connection.getSodaDatabase()

View latest documentation

4.2.11 connection.getStatementInfo()

View latest documentation

4.2.12 connection.isHealthy()

View latest documentation

4.2.13 connection.ping()

View latest documentation

4.2.14 connection.queryStream()

View latest documentation

4.2.15 connection.rollback()

View latest documentation

4.2.16 connection.shutdown()

View latest documentation

4.2.16.1 shutdown(): shutdownMode

View latest documentation

4.2.16.2 shutdown(): Callback Function

View latest documentation

4.2.17 connection.subscribe()

View latest documentation

4.2.17.1 subscribe(): Name

View latest documentation

4.2.17.2 subscribe(): Options

View latest documentation

4.2.16.2.1 binds

View latest documentation

4.2.17.2.2 callback

View latest documentation

4.2.17.2.3 clientInitiated

View latest documentation

4.2.17.2.4 groupingClass

View latest documentation

4.2.17.2.5 groupingType

View latest documentation

4.2.17.2.6 groupingValue

View latest documentation

4.2.17.2.7 ipAddress

View latest documentation

4.2.17.2.8 namespace

View latest documentation

4.2.17.2.9 operations

View latest documentation

4.2.17.2.10 port

View latest documentation

4.2.17.2.11 qos

View latest documentation

4.2.17.2.12 sql

View latest documentation

4.2.17.2.13 timeout

View latest documentation

4.2.17.3 subscribe(): Callback Function

View latest documentation

4.2.18 connection.startup()

View latest documentation

4.2.18.1 startup(): options

View latest documentation

4.2.18.1.1.1 force

View latest documentation

4.2.18.1.1.2 pfile

View latest documentation

4.2.18.1.1.3 restrict

View latest documentation

4.2.18.2 startup(): Callback Function

View latest documentation

4.2.19 connection.tpcBegin()

View latest documentation

4.2.20 connection.tpcCommit()

View latest documentation

4.2.21 connection.tpcEnd()

View latest documentation

4.2.22 connection.tpcForget()

View latest documentation

4.2.23 connection.tpcPrepare()

View latest documentation

4.2.24 connection.tpcRecover()

View latest documentation

4.2.25 connection.tpcRollback()

View latest documentation

4.2.26 connection.unsubscribe()

View latest documentation

5. AqQueue Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/aq.html#aqqueueclass.

5.1 AqQueue Properties

View latest documentation

5.1.1 aqQueue.name

View latest documentation

5.1.2 aqQueue.deqOptions

View latest documentation

5.1.2.1 AqDeqOptions Class

View latest documentation

5.1.3 aqQueue.enqOptions

View latest documentation

5.1.3.1 AqEnqOptions Class

View latest documentation

5.1.4 aqQueue.payloadType

View latest documentation

5.1.5 aqQueue.payloadTypeClass

View latest documentation

5.1.6 aqQueue.payloadTypeName

View latest documentation

5.2 AqQueue Methods

View latest documentation

5.2.1 aqQueue.deqMany()

View latest documentation

5.2.2 aqQueue.deqOne()

View latest documentation

5.2.2.1 AqMessage Class

View latest documentation

5.2.3 aqQueue.enqMany()

View latest documentation

5.2.4 aqQueue.enqOne()

View latest documentation

6. DbObject Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/dbobject.html#dbobjectclass.

6.1 DbObject Properties

View latest documentation

6.1.1 dbObject.attributes

View latest documentation

6.1.2 dbObject.elementType

View latest documentation

6.1.3 dbObject.elementTypeClass

View latest documentation

6.1.4 dbObject.elementTypeName

View latest documentation

6.1.5 dbObject.fqn

View latest documentation

6.1.6 dbObject.isCollection

View latest documentation

6.1.7 dbObject.length

View latest documentation

6.1.8 dbObject.name

View latest documentation

6.1.9 dbObject.schema

View latest documentation

6.2 DbObject Methods

View latest documentation

6.2.1 DbObject Methods for Collections

View latest documentation

7. Lob Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/lob.html#lobclass.

7.1 Lob Properties

View latest documentation

7.1.1 lob.chunkSize

View latest documentation

7.1.2 lob.length

View latest documentation

7.1.3 lob.pieceSize

View latest documentation

7.1.4 lob.type

View latest documentation

7.2 Lob Methods

View latest documentation

7.2.1 lob.close()

View latest documentation

7.2.2 lob.destroy()

View latest documentation

7.2.3 lob.getData()

View latest documentation

8. Pool Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/pool.html#poolclass.

8.1 Pool Properties

View latest documentation

8.1.1 pool.connectionsInUse

View latest documentation

8.1.2 pool.connectionsOpen

View latest documentation

8.1.3 pool.connectString

View latest documentation

8.1.4 pool.edition

View latest documentation

8.1.5 pool.events

View latest documentation

8.1.6 pool.externalAuth

View latest documentation

8.1.7 pool.enableStatistics

View latest documentation

8.1.8 pool.homogeneous

View latest documentation

8.1.9 pool.poolAlias

View latest documentation

8.1.10 pool.poolIncrement

View latest documentation

8.1.11 pool.poolMax

View latest documentation

8.1.12 pool.poolMaxPerShard

View latest documentation

8.1.13 pool.poolMin

View latest documentation

8.1.14 pool.poolPingInterval

View latest documentation

8.1.15 pool.poolTimeout

View latest documentation

8.1.16 pool.queueMax

View latest documentation

8.1.17 pool.queueRequests

View latest documentation

8.1.18 pool.queueTimeout

View latest documentation

8.1.19 pool.sessionCallback

View latest documentation

8.1.20 pool.sodaMetaDataCache

View latest documentation

8.1.21 pool.status

View latest documentation

8.1.22 pool.stmtCacheSize

View latest documentation

8.1.23 pool.user

View latest documentation

8.2 Pool Methods

View latest documentation

8.2.1 pool.close()

View latest documentation

8.2.2 pool.getConnection()

View latest documentation

8.2.3 pool.getStatistics()

View latest documentation

8.2.4 pool.logStatistics()

View latest documentation

8.2.5 pool.reconfigure()

View latest documentation

8.2.6 pool.setAccessToken()

View latest documentation

9. PoolStatistics Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/statistics.html#poolstatisticsclass.

9.1 PoolStatistics Methods

View latest documentation

9.1.1 poolstatistics.logStatistics()

View latest documentation

10. ResultSet Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/resultset.html#resultsetclass.

10.1 ResultSet Properties

View latest documentation

10.1.1 resultset.metaData

View latest documentation

10.2 ResultSet Methods

View latest documentation

10.2.1 resultset.close()

View latest documentation

10.2.2 resultset.getRow()

View latest documentation

10.2.3 resultset.getRows()

View latest documentation

10.2.4 resultset.toQueryStream()

View latest documentation

11. SodaCollection Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/sodacollection.html#sodacollectionclass.

11.1 SodaCollection Properties

View latest documentation

11.1.1 sodaCollection.metaData

View latest documentation

11.1.2 sodaCollection.name

View latest documentation

11.2 SodaCollection Methods

View latest documentation

11.2.1 sodaCollection.createIndex()

View latest documentation

11.2.1.1 createIndex() Parameters

View latest documentation

11.2.1.1.1 indexSpec

View latest documentation

11.2.1.2 createIndex(): Callback Function

View latest documentation

10.2.2 sodaCollection.drop()

View latest documentation

11.2.2.1 drop(): Callback Function

View latest documentation

11.2.3 sodaCollection.dropIndex()

View latest documentation

11.2.3.1 dropIndex(): Parameters

View latest documentation

11.2.3.1.1 indexName

View latest documentation

11.2.3.1.2 options

View latest documentation

11.2.3.2 dropIndex() Callback Function

View latest documentation

11.2.4 sodaCollection.find()

View latest documentation

11.2.4.1 SodaOperation Class

View latest documentation

11.2.4.1.1 Non-terminal SodaOperation Methods

View latest documentation

11.2.4.1.1.1 sodaOperation.fetchArraySize()

View latest documentation

11.2.4.1.1.2 sodaOperation.filter()

View latest documentation

11.2.4.1.1.3 sodaOperation.hint()

View latest documentation

11.2.4.1.1.4 sodaOperation.key()

View latest documentation

11.2.4.1.1.5 sodaOperation.keys()

View latest documentation

11.2.4.1.1.6 sodaOperation.limit()

View latest documentation

11.2.4.1.1.7 sodaOperation.skip()

View latest documentation

11.2.4.1.1.8 sodaOperation.version()

View latest documentation

11.2.4.1.2 Terminal SodaOperation Methods

View latest documentation

11.2.4.1.2.1 sodaOperation.count()

View latest documentation

11.2.4.1.2.2 sodaOperation.getCursor()

View latest documentation

11.2.4.1.2.3 sodaOperation.getDocuments()

View latest documentation

11.2.4.1.2.4 sodaOperation.getOne()

View latest documentation

11.2.4.1.2.5 sodaOperation.remove()

View latest documentation

11.2.4.1.2.6 sodaOperation.replaceOne()

View latest documentation

11.2.4.1.2.7 sodaOperation.replaceOneAndGet()

View latest documentation

11.2.5 sodaCollection.getDataGuide()

View latest documentation

11.2.6 sodaCollection.insertMany()

View latest documentation

11.2.7 sodaCollection.insertManyAndGet()

View latest documentation

11.2.8 sodaCollection.insertOne()

View latest documentation

11.2.8.1 insertOne(): Parameters

View latest documentation

11.2.8.1.1 newDocumentContent, newSodaDocument

View latest documentation

11.2.8.2 insertOne() Callback Function

View latest documentation

11.2.9 sodaCollection.insertOneAndGet()

View latest documentation

11.2.9.1 insertOneAndGet(): Parameters

View latest documentation

11.2.9.1.1 newDocumentContent, newSodaDocument

View latest documentation

11.2.9.2 insertOneAndGet() Callback Function

View latest documentation

11.2.10 sodaCollection.save()

View latest documentation

11.2.11 sodaCollection.saveAndGet()

View latest documentation

11.2.12 sodaCollection.truncate()

View latest documentation

11.2.12.1 truncate() Callback Function

View latest documentation

11. SodaDatabase Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/sodadb.html#sodadatabaseclass.

12.1 SodaDatabase Methods

View latest documentation

12.1.1 sodaDatabase.createCollection()

View latest documentation

12.1.1.1 createCollection(): collectionName

View latest documentation

12.1.1.2 createCollection(): options

View latest documentation

12.1.1.2.1 metaData

View latest documentation

12.1.1.2.2 mode

View latest documentation

12.1.1.3 createCollection(): Callback Function

View latest documentation

12.1.2 sodaDatabase.createDocument()

View latest documentation

12.1.2.1 createDocument(): content

View latest documentation

12.1.2.2 createDocument(): options

View latest documentation

12.1.2.2.1 key

View latest documentation

12.1.2.2.2 mediaType

View latest documentation

12.1.3 sodaDatabase.getCollectionNames()

View latest documentation

12.1.3.1 getCollectionNames(): Parameters

View latest documentation

12.1.3.1.1 options

View latest documentation

12.1.3.2 getCollectionNames(): Callback Function

View latest documentation

12.1.4 sodaDatabase.openCollection()

View latest documentation

12.1.4.1 openCollection(): Parameters

View latest documentation

12.1.4.1.1 collectionName

View latest documentation

12.1.4.2 openCollection(): Callback Function

View latest documentation

13. SodaDocument Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/sodadocument.html#sodadocumentclass.

13.1 SodaDocument Properties

View latest documentation

13.2 SodaDocument Methods

View latest documentation

13.2.1 sodaDocument.getContent()

View latest documentation

13.2.2 sodaDocument.getContentAsBuffer()

View latest documentation

13.2.3 sodaDocument.getContentAsString()

View latest documentation

14. SodaDocumentCursor Class

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/api_manual/sodacursor.html#sodadocumentcursorclass.

14.1 SodaDocumentCursor Methods

View latest documentation

14.1.1 sodaDocumentCursor.close()

View latest documentation

13.1.2 sodaDocumentCursor.getNext()

View latest documentation

NODE-ORACLEDB USER MANUAL

15. Initializing Node-oracledb

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/initialization.html#initnodeoracledb.

15.1 Setting the Oracle Client Library Directory

View latest documentation

15.1.1 Setting the Oracle Client Directory on Windows

View latest documentation

15.1.2 Setting the Oracle Client Directory on macOS

View latest documentation

View latest documentation

15.1.4 Calling initOracleClient() to set the Oracle Client Directory

View latest documentation

15.2 Optional Oracle Net Configuration

View latest documentation

15.3 Optional Oracle Client Configuration

View latest documentation

15.4 Oracle Environment Variables

View latest documentation

15.5 Other Node-oracledb Initialization

View latest documentation

16. Connection Handling

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#connectionhandling.

16.1 Connection Strings

View latest documentation

16.1.1 Easy Connect Syntax for Connection Strings

View latest documentation

16.1.2 Embedded Connect Descriptor Strings

View latest documentation

16.1.3 Net Service Names for Connection Strings

View latest documentation

16.1.4 JDBC and Oracle SQL Developer Connection Strings

View latest documentation

16.2 Connections, Threads, and Parallelism

View latest documentation

16.2.1 Connections and Worker Threads

View latest documentation

16.2.2 Parallelism on Each Connection

View latest documentation

16.3 Connection Pooling

View latest documentation

16.3.1 Connection Pool Sizing

View latest documentation

16.3.2 Connection Pool Closing and Draining

View latest documentation

16.3.3 Connection Pool Cache

View latest documentation

16.3.4 Connection Pool Queue

View latest documentation

16.3.5 Connection Pool Monitoring

View latest documentation

Pool Statistics

View latest documentation

16.3.6 Connection Pool Pinging

View latest documentation

16.3.7 Connection Tagging and Session State

View latest documentation

16.3.7.1 Node.js Session Callback

View latest documentation

16.3.7.2 Node.js Session Tagging Callback

View latest documentation

16.3.7.3 PL/SQL Session Tagging Callback

View latest documentation

16.3.8 Heterogeneous Connection Pools and Pool Proxy Authentication

View latest documentation

16.4 External Authentication

View latest documentation

16.5 Token-Based Authentication

View latest documentation

16.5.1 OAuth 2.0 Token-Based Authentication

View latest documentation

16.5.1.1 OAuth 2.0 Token Generation

View latest documentation

16.5.1.2 OAuth 2.0 Standalone Connections

View latest documentation

16.5.1.3 OAuth 2.0 Connection Pooling

View latest documentation

16.5.1.4 OAuth 2.0 Connection Strings

View latest documentation

16.5.2 IAM Token-Based Authentication

View latest documentation

16.5.2.1 IAM Token Generation

View latest documentation

16.5.2.2 IAM Token and Private Key Extraction

View latest documentation

16.5.2.3 IAM Standalone Connections

View latest documentation

16.5.2.4 IAM Connection Pooling

View latest documentation

16.5.2.5 IAM Connection Strings

View latest documentation

16.6 Database Resident Connection Pooling (DRCP)

View latest documentation

16.7 Privileged Connections

View latest documentation

16.8 Securely Encrypting Network Traffic to Oracle Database

View latest documentation

16.9 Changing Passwords and Connecting with an Expired Password

View latest documentation

16.10 Connections and High Availability

View latest documentation

16.10.1 Preventing Premature Connection Closing

View latest documentation

16.10.2 Fast Application Notification (FAN)

View latest documentation

16.10.3 Runtime Load Balancing (RLB)

View latest documentation

16.10.4 Application Continuity

View latest documentation

16.10.5 Database Call Timeouts

View latest documentation

16.11 Connecting to Oracle Real Application Clusters (RAC)

View latest documentation

16.12 Connecting to Oracle Cloud Autonomous Databases

View latest documentation

16.12.1 TLS Connections to Oracle Cloud Autonomous Database

View latest documentation

16.12.2 Mutal TLS connections to Oracle Cloud Autonomous Database

View latest documentation

16.13 Connecting to Sharded Databases

View latest documentation

17. SQL Execution

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/sql_execution.html#sqlexecution.

17.1 SELECT Statements

View latest documentation

17.1.1 Fetching Rows with Direct Fetches

View latest documentation

17.1.2 Fetching Rows with Result Sets

View latest documentation

17.1.3 Query Streaming

View latest documentation

17.1.4 Query Output Formats

View latest documentation

17.1.5 Fetching Nested Cursors

View latest documentation

17.1.6 Query Column Metadata

View latest documentation

17.1.7 Query Result Type Mapping

View latest documentation

17.1.7.1 Fetching CHAR, VARCHAR2, NCHAR and NVARCHAR

View latest documentation

17.1.7.2 Fetching Numbers

View latest documentation

17.1.7.3 Fetching Dates and Timestamps

View latest documentation

17.1.7.4 Fetching Numbers and Dates as String

View latest documentation

17.1.7.5 Fetching BLOB, CLOB and NCLOB

View latest documentation

17.1.7.6 Fetching LONG and LONG RAW

View latest documentation

17.1.7.7 Fetching ROWID and UROWID

View latest documentation

17.1.7.8 Fetching XMLType

View latest documentation

17.1.7.9 Fetching RAW

View latest documentation

17.1.7.10 Fetching Oracle Database Objects and Collections

View latest documentation

17.1.8 Limiting Rows and Creating Paged Datasets

View latest documentation

17.1.9 Auto-Increment Columns

View latest documentation

17.2 Cursor Management

View latest documentation

18. PL/SQL Execution

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/plsql_execution.html#plsqlexecution.

18.1 PL/SQL Stored Procedures

View latest documentation

18.2 PL/SQL Stored Functions

View latest documentation

18.3 PL/SQL Anonymous PL/SQL Blocks

View latest documentation

18.4 Using DBMS_OUTPUT

View latest documentation

18.5 Edition-Based Redefinition

View latest documentation

18.6 Implicit Results

View latest documentation

18.7 Creating PL/SQL Procedures and Functions

View latest documentation

18.7.1 PL/SQL Compilation Warnings

View latest documentation

19. Working with CLOB, NCLOB and BLOB Data

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/lob_data.html#lobhandling.

19.1 Simple Insertion of LOBs

View latest documentation

19.2 Simple LOB Queries and PL/SQL OUT Binds

View latest documentation

19.3 Streaming Lobs

View latest documentation

19.4 Using RETURNING INTO to Insert into LOBs

View latest documentation

19.5 Getting LOBs as Streams from Oracle Database

View latest documentation

19.6 Using createLob() for PL/SQL IN Binds

View latest documentation

19.7 Closing Lobs

View latest documentation

20. Oracle Database JSON Data Type

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/json_data_type.html#jsondatatype.

21. Working with XMLType

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/xml_data_type.html#xmltype.

22. Bind Parameters for Prepared Statements

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/bind.html#bind.

22.1 IN Bind Parameters

View latest documentation

22.2 OUT and IN OUT Bind Parameters

View latest documentation

22.3 DML RETURNING Bind Parameters

View latest documentation

22.4 REF CURSOR Bind Parameters

View latest documentation

22.5 LOB Bind Parameters

View latest documentation

22.6 Binding Multiple Values to a SQL WHERE IN Clause

View latest documentation

22.7 Binding in a LIKE or REGEXP_LIKE Clause

View latest documentation

22.8 Binding Column and Table Names in Queries

View latest documentation

23. Oracle Database Objects and Collections

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/objects.html#objects.

23.1 Inserting Objects

View latest documentation

23.2 Fetching Objects

View latest documentation

23.3 PL/SQL Collection Types

View latest documentation

23.3.1 PL/SQL Collection Associative Arrays (Index-by)

View latest documentation

23.3.2 PL/SQL Collection VARRAY Types

View latest documentation

23.3.3 PL/SQL Collection Nested Tables

View latest documentation

23.4 PL/SQL RECORD Types

View latest documentation

23.5 Inserting or Passing Multiple Objects of the Same Type

View latest documentation

23.6 Oracle Database Object Type Limitations

View latest documentation

24. Batch Statement Execution and Bulk Loading

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/batch_statement.html#batchexecution.

Handling Data Errors with executeMany()

View latest documentation

Binding Objects with executeMany()

View latest documentation

25. Transaction Management

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/txn_management.html#transactionmgt.

26. Continuous Query Notification (CQN)

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/cqn.html#cqn.

27. Oracle Advanced Queuing (AQ)

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/aq.html#aq.

27.1 Sending Simple AQ Messages

View latest documentation

27.2 Sending Oracle Database Object AQ Messages

View latest documentation

27.3 Changing AQ options

View latest documentation

27.4 Enqueuing and Dequeuing Multiple Messages

View latest documentation

27.5 Advanced Queuing Notifications

View latest documentation

27.6 Recipient Lists

View latest documentation

28. Globalization and National Language Support (NLS)

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/globalization.html#nls.

29. End-to-end Tracing, Mid-tier Authentication, and Auditing

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/tracing.html#endtoend.

The Add-on Name

View latest documentation

30. Simple Oracle Document Access (SODA)

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/soda.html#sodaoverview.

30.1 Node-oracledb SODA Requirements

View latest documentation

30.2 Creating and Dropping SODA Collections

View latest documentation

30.3 Creating and Accessing SODA documents

View latest documentation

30.4 SODA Query-by-Example Searches for JSON Documents

View latest documentation

30.5 SODA Text Searches

View latest documentation

30.6 SODA Client-Assigned Keys and Collection Metadata

View latest documentation

30.7 JSON Data Guides in SODA

View latest documentation

30.8 Using the SODA Metadata Cache

View latest documentation

31. Database Start Up and Shut Down

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/startup.html#startupshutdown.

31.1 Simple Database Start Up and Shut Down

View latest documentation

31.2 Flexible Database Start Up and Shut Down

View latest documentation

31.3 Oracle Multitenant Pluggable and Container Databases

View latest documentation

32. Node-oracledb Tuning

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/tuning.html#tuning.

32.1 Tuning Fetch Performance

View latest documentation

32.2 Database Round-trips

View latest documentation

32.3. Statement Caching

View latest documentation

32.4 Client Result Caching (CRC)

View latest documentation

33. Tracing SQL and PL/SQL Statements

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/tracingsql.html#tracingsql.

34. Two-Phase Commits (TPC)

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/two_phase_commit.html#twopc.

35. Node.js Programming Styles and node-oracledb

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/pgmstyle.html#programstyles.

35.1 Callbacks and node-oracledb

View latest documentation

35.2 Promises and node-oracledb

View latest documentation

35.2.1 Custom Promise Libraries

View latest documentation

35.3 Async/Await and node-oracledb

View latest documentation

36. Migrating from Previous node-oracledb Releases

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/migrate.html#migrate.

36.1 Migrating from node-oracledb 3.1 to node-oracledb 4.0

View latest documentation

36.2 Migrating from node-oracledb 4.0 to node-oracledb 4.1

View latest documentation

36.3 Migrating from node-oracledb 4.1 to node-oracledb 4.2

View latest documentation

36.4 Migrating from node-oracledb 4.2 to node-oracledb 5.0

View latest documentation

36.5 Migrating from node-oracledb 5.1 to node-oracledb 5.2

View latest documentation

37. Useful Resources for Node-oracledb

The documentation has moved to https://node-oracledb.readthedocs.io/en/latest/user_guide/resources.html#otherresources.