Repository files navigation

The node-oracledb add-on for Node.js powers high performance Oracle Databaseapplications. Applications can be written in TypeScript, or directly inJavaScript.

Use node-oracledb 6.10.0 to connect Node.js 14.17, or later, to OracleDatabase. Older versions of node-oracledb may work with older versions ofNode.js.

Node-oracledb supports basic and advanced features of Oracle Databaseand Oracle Client. See thehomepage for a list.

The node-oracledb module is open source and maintained by Oracle Corp.It is stable, well documented, and has a comprehensive test suite.

Runnpm install oracledb

SeeGetting Started with Node-oracledb andQuick Start Node-oracledb Installation.

• Node.js versions 14.17 and later.

  Pre-built packages are available onnpm and other mirror repositories.

  Source code is also available.

  Previous versions of node-oracledb supported older Node.js versions.

• Oracle Client libraries areoptional starting from node-oracledb 6.0.Older versions of node-oracledb require Oracle Client libraries.

  Thin mode: By default node-oracledb (from version 6.0 onwards) runs in a'Thin' mode which connects directly to Oracle Database.

  Thick mode: Some advanced Oracle Database functionality is currently onlyavailable when optional Oracle Client libraries are loaded bynode-oracledb. Libraries are available in the freeOracle InstantClient packages. Node-oracledb can use Oracle Clientlibraries 11.2 through 23ai.

• Oracle Database

  Thin mode: Oracle Database 12.1 (or later) is required.

  Thick mode: Oracle Database 9.2 (or later) is required, depending on theOracle Client library version. Oracle Database's standard client-serverversion interoperability allows connection to both older and newerdatabases. For example when node-oracledb uses Oracle Client 19c libraries,then it can connect to Oracle Database 11.2 or later.

SeeDocumentation for the Oracle Database Node.js Add-on and thereleasenotes.

See theexamples directory. Start withexamples/example.js.

Questions about node-oracledb can be posted onGitHub orSlack (linkto join Slack).

To run the test suite, seetest/README.

This project welcomes contributions from the community. Before submitting apull request, pleasereview our contribution guide.

Please consult thesecurity guide for our responsible securityvulnerability disclosure process.

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

This software is dual-licensed to you under the Universal Permissive License(UPL) 1.0 as shown athttps://oss.oracle.com/licenses/upl and Apache License2.0 as shown athttp://www.apache.org/licenses/LICENSE-2.0. You may chooseeither 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, softwaredistributed 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 andlimitations under the License.