Node.js node-oracledb version 6.7

About node-oracledb

The node-oracledb driver for Node.js powers high performance Oracle Database applications written in JavaScript or TypeScript.

Node-oracledb is a pure JavaScript module that can connect directly to Oracle Database. Some additional features are available in an optional 'Thick' mode that uses Oracle Client libraries to connect to the database.

Node-oracledb supports basic and advanced features of Oracle Database.

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

See Getting Started with Node-oracledb.

Installation

See Quick Start Node-oracledb 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

Questions can be asked on GitHub Discussions or Slack (link to join Slack). Identified issues can be raised as GitHub Issues.

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

• Open Source: dual-licensed under the Universal Permissive License (UPL) 1.0 and Apache 2.0 licenses

• Maintained by Oracle

• Pure JavaScript 'Thin' mode implementation by default, with an optional 'Thick' mode for advanced functionality

• Async/Await, Promises, Callbacks and Streams

• SQL Execution and PL/SQL Execution

• Batch Statement Execution and Bulk Loading

• Call Timeouts

• Statement Metadata

• Edition-Based Redefinition

• REF CURSORS

• PL/SQL Implicit Results

• Large Objects: CLOBs, BLOBs and NCLOBs as Streams, or Strings and Buffers

• Oracle Database Simple Oracle Document Access (SODA)

• Oracle Database JSON datatype

• NCHAR, NVARCHAR and NCLOB support

• Query results as JavaScript objects or arrays

• Smart mapping between JavaScript and Oracle types with manual override

• Data binding using JavaScript types, objects or arrays

• Query and bind Oracle Database named types and collections

• Transaction Management

• Two-Phase Commits

• Inbuilt Connection Pool with Queuing, Aliasing, Tagging, Draining, Heterogeneous and Homogeneous connections, Proxy connections and Liveness checking

• Database Resident Connection Pooling (DRCP)

• Privileged Connections

• External Authentication

• Token Authentication

• Connection Health Checking

• Oracle Sharding

• Password Changing

• Advanced Queuing (AQ)

• Continuous Query Notification (CQN)

• Array Fetches

• Statement Caching

• Client Result Caching

• End-to-end Tracing, Mid-tier Authentication, and Auditing

• Oracle High Availability Features

  • Application Continuity

  • Fast Application Notification (FAN)

  • Runtime Load Balancing (RLB)

• 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, 2024, Oracle and/or its affiliates. All rights reserved.

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 https://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 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.