About node-oracledb
The node-oracledb add-on for Node.js powers high performance Oracle Database applications. Applications can be written in TypeScript, or directly in JavaScript.
Use node-oracledb 5.5 to connect Node.js 14, or later, to Oracle Database. Older versions of node-oracledb may work with older versions of Node.js.
Node-oracledb supports basic and advanced features of Oracle Database and Oracle Client.
The node-oracledb module is open source and maintained by Oracle Corp. It is stable, well documented, and has a comprehensive test suite.
Getting Started
Installation
Examples
See the examples directory. Start with examples/example.js.
Documentation
See Documentation for the Oracle Database Node.js Add-on and Release Notes.
You can use assistive technology products, such as screen readers, while you work with the documentation. You can also use the keyboard instead of the mouse.
Help
Issues and questions can be raised with the node-oracledb community on GitHub or Slack (link to join Slack).
Tests
To run the test suite see test/README.
Source code
Source code is on github.com/oracle/node-oracledb.
Contributing
Node-oracledb is an open source project. See CONTRIBUTING for details.
Oracle gratefully acknowledges the contributions to node-oracledb that have been made by the community.
Node-oracledb Features:
Install from npm. Find the source code on GitHub
Async/Await, Promises, Callbacks and Streams
Large Objects: CLOBs, BLOBs and NCLOBs as Streams, or Strings and Buffers
Smart mapping between JavaScript and Oracle types with manual override
Oracle High Availability Features
Use of Oracle Network Service infrastructure including encrypted network traffic and security features.
Oracle's standard cross-version interoperability allows easy upgrades and connectivity to different Oracle Database versions.
We are actively working on supporting the best Oracle Database features, and on functionality requests from users involved in the project.
License
Copyright (c) 2015, 2022, Oracle and/or its affiliates. All rights reserved.
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.