README.md

node-oracledb version 0.3

1. About node-oracledb

The Oracle Database Node.js driver powers high performance Node.js applications.

Node-oracledb 0.3 supports basic and advanced Oracle features, including:

• SQL and PL/SQL Execution
• Binding using JavaScript objects or arrays
• Query results as JavaScript objects or array
• Conversion between JavaScript and Oracle types
• Transaction Management
• Connection Pooling
• Database Resident Connection Pooling (DRCP)
• Statement Caching
• Client Result Caching
• End-to-end tracing
• High Availability Features
  • Fast Application Notification (FAN)
  • Runtime Load Balancing (RLB)
  • Transparent Application Failover (TAF)

Node-oracledb 0.3 is a preview release. We are actively working on adding features including LOB support and batch fetching / streaming of large query result sets.

Share your feedback at the Oracle Technology Network Node.js discussion forum so we can incorporate any fixes and "must-haves" into a 1.0 release soon. Issues with node-oracledb can also be reported here.

The driver is maintained by Oracle Corp.

The node-oracledb home page is on the Oracle Technology Network.

Example: Simple SELECT statement implementation in node-oracledb

var oracledb = require('oracledb');

oracledb.getConnection(
  {
    user          : "hr",
    password      : "welcome",
    connectString : "localhost/XE"
  },
  function(err, connection)
  {
    if (err) {
      console.error(err.message);
      return;
    }
    connection.execute(
      "SELECT department_id, department_name "
    + "FROM departments "
    + "WHERE department_id = :did",
      [180],
      function(err, result)
      {
        if (err) {
          console.error(err.message);
          return;
        }
        console.log(result.rows);
      });
  });

With Oracle's sample HR schema, the output is:

[ [ 180, 'Construction' ] ]

There are more examples in the examples directory.

2. Installation

The current release of node-oracledb is available only on GitHub. The basic install steps are:

• Install the small, free Oracle Instant Client libraries, or have a local database such as the free Oracle XE release.
• Clone this repository
• Run npm install

See INSTALL for details.

3. Documentation

See API Documentation

4. Contributing

Node-oracledb is an open source project. See CONTRIBUTING for details.

5. Licence

Copyright (c) 2015, 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.