node-oracledb version 1.11

Difference from official driver

This fork support queries with UDT(user-defined objects) and nested tables(nested UDT and nested table of UDT also supported). For select statements oracle UDT fetched as javascript object or array(depends on outFormat setting), nested table always fetched as array:

CREATE TYPE my_obj AS OBJECT(
  num NUMBER,
  str VARCHAR2(200)
); 
/
CREATE TYPE my_num_tab AS TABLE OF number;
/
CREATE TABLE my_table(
  obj my_obj,
  tab my_num_tab
)
NESTED TABLE tab STORE AS my_table_tab;
/
insert into my_table values (my_obj(1, 'test'), my_num_tab(1,2,3));

connection.execute("select * from my_table", [], { outFormat: oracledb.OBJECT }, function(err, result) {
  console.dir(result.rows, { depth: null }); // [ { OBJ: { NUM: 1, STR: 'test' }, TAB: [ 1, 2, 3 ] } ]
});

insert\update\delete queries support binding of UDT and nested tables as IN binds. You need to set type to oracledb.UDT and provide additional option udtName - oracle type of column(looks like there is no way to get it automatically), all nested types will be detected automatically:

connection.execute("insert into my_table values(:obj, :tab)",
  {
    obj: {
      type: oracledb.UDT,
      dir: oracledb.BIND_IN,
      val: { num: 6, str: "test"},
      udtName: 'my_obj'
    },
    tab: {
      type: oracledb.UDT,
      dir: oracledb.BIND_IN,
      val: [6,7,8],
      udtName: 'my_num_tab'
    }
  },
  function (err, result) {
    // check inserted data
    connection.execute("select * from my_table", [], { outFormat: oracledb.OBJECT }, function (err, result) {
      console.dir(result, { depth: null }); // [ { OBJ: { NUM: 6, STR: 'test' }, TAB: [ 6, 7, 8 ] } ]
    });
  }
);

See udt.js tests for code examples. Src code located in dpiUdtImpl.cpp. We keep new Udt object per Bind\Define and call jsToOci\ociToJs to convert data between OCI and js.

About node-oracledb

The node-oracledb add-on for Node.js powers high performance Oracle Database applications.

Use node-oracledb to connect Node.js 0.10, 0.12, 4, and 6 to Oracle Database.

The add-on is stable, well documented, and has a comprehensive test suite.

The node-oracledb project is open source and maintained by Oracle Corp. The home page is on the Oracle Technology Network.

Node-oracledb supports:

• Promises, Callbacks and Streams
• SQL and PL/SQL execution
• REF CURSORs
• Large Objects: CLOBs and BLOBs
• Oracle Database 12.1 JSON datatype
• Query results as JavaScript objects or arrays
• Smart mapping between JavaScript and Oracle types with manual override available
• Data binding using JavaScript objects or arrays
• Transaction Management
• Inbuilt Connection Pool with Queueing
• Database Resident Connection Pooling (DRCP)
• External Authentication
• Row Prefetching
• Statement Caching
• Client Result Caching
• End-to-end Tracing, Mid-tier Authentication, and Auditing
• Oracle High Availability Features
  • Fast Application Notification (FAN)
  • Runtime Load Balancing (RLB)
  • Transparent Application Failover (TAF)

Various Oracle Database and Oracle Client versions, can be used. Oracle's cross-version compatibility allows one node-oracledb installation to connect to different database versions.

We are actively working on supporting the best Oracle Database features, and on functionality requests from users involved in the project.

Installation

Prerequisites:

• Python 2.7
• C Compiler with support for C++ 11 (Xcode, gcc, Visual Studio or similar)
• The small, free Oracle Instant Client "basic" and "SDK" packages if your database is remote. Or use the libraries and headers from a locally installed database such as the free Oracle XE release
• Set OCI_LIB_DIR and OCI_INC_DIR during installation if the Oracle libraries and headers are in a non-default location

Run npm install oracledb to install from the NPM registry.

See INSTALL for details.

Examples

There are examples in the examples directory.

A simple query example with callbacks:

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 manager_id < :id",
      [110],  // bind value for :id
      function(err, result)
      {
        if (err) { console.error(err.message); return; }
        console.log(result.rows);
      });
  });

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

[ [ 60, 'IT' ], [ 90, 'Executive' ], [ 100, 'Finance' ] ]

Node Promises can also be used.

Documentation

See Documentation for the Oracle Database Node.js Add-on.

Help

Issues and questions can be raised with the node-oracledb community on GitHub.

Changes

See CHANGELOG.

Tests

To run the test suite see test/README.

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.

License

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