dnrops
/
node-oracledb
mirror of https://github.com/oracle/node-oracledb
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
node-oracledb/INSTALL.md

56 KiB
Raw Blame History

Installing node-oracledb Version 3

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

Contents

===> *** Note: Go to https://oracle.github.io/node-oracledb/INSTALL.html for production documentation ***

  1. Node-oracledb Overview
  2. Quick Start Node-oracledb Installation
  3. Node-oracledb Installation Instructions
  4. Installing Node-oracledb 1.x
  5. Useful Resources for Node-oracledb
  6. Troubleshooting Node-oracledb Installation Problems

1. Node-oracledb Overview

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

The steps below create a Node.js installation for testing. Adjust the steps for your environment.

This node-oracledb release has been tested with Node.js 6, 8, 10 and 11 on 64-bit Oracle Linux, Windows and macOS. The add-on can also build on some 32-bit Linux, 32-bit Windows, Solaris and AIX environments, but these architectures have not been fully tested. Older versions of node-oracledb may work with older versions of Node.js.

Node-oracledb is an add-on available as C++ and C source code. Pre-built binaries are available as a convenience for common architectures. Note the operating systems and versions of Node.js that the pre-built binaries are compatible with will change as the Node.js project evolves. The binaries are not guaranteed to be available or usable in your environment.

1.1 Changes in node-oracledb version 3.0

Installation of node-oracledb binaries will now use the npm config proxy if it is set. However, due to known npm performance issues, it is recommended to use environment variables like https_proxy instead, since these will be used in preference to the npm configuration.

The node-oracledb installer now supports basic proxy authentication.

On Windows, node-oracledb will now attempt to load the Oracle Client libraries from the node_modules\oracledb\build\Release directory before doing the standard Windows library directory search i.e. of the PATH directories.

See the CHANGELOG and Migrating from Previous node-oracledb Releases for more information about node-oracledb 3.0.

1.2 Changes in node-oracledb version 2.0

In node-oracledb version 2.0, pre-built binaries are now available for some environments.

Building from source code has improved significantly in node-oracledb version 2.0 The Oracle header files, and the node-oracledb environment variables OCI_INC_DIR and OCI_LIB_DIR are no longer required.

The Oracle client libraries must now always be in the default library search path, such as PATH (on Windows), or LD_LIBRARY_PATH (on Linux), or in ~/lib (on macOS). This is because they are dynamically loaded during execution. 'Rpath' linking is no longer performed on Linux or macOS.

Any node-oracledb version 2.0 binary will run with any of the Oracle client version 11.2, 12, or 18 libraries without needing recompilation. Note the available Oracle functionality will vary with different Oracle Client and Database versions.

See the CHANGELOG and Migrating from node-oracledb 1.13 to node-oracledb 2.0 for more information about node-oracledb version 2.0.

2. Quick Start Node-oracledb Installation

  • Install Node.js from nodejs.org.

  • Install node-oracledb using the npm package manager, which is included in Node.js. If you are behind a firewall, you may need to set the environment variable https_proxy first.

    • Many users will be able to use a pre-built node-oracledb binary:

    • If a binary is not available, you will need to compile node-oracledb from source code:

      • Install Python 2.7

      • Install a C Compiler with support for C++ 11 (such as Xcode, GCC 4.8, Visual Studio 2015, or similar)

      • Run npm install oracle/node-oracledb.git#v3.0.0, or add oracle/node-oracledb.git#v3.0.0 to your package.json dependencies. Substitute your desired GitHub tag.

  • Add Oracle 12.2, 12.1, 11.2 or 18 client libraries to your operating system library search path such as PATH on Windows or LD_LIBRARY_PATH on Linux. On macOS move the libraries to ~/lib or /usr/local/lib.

    • If your database is remote, then get the libraries by downloading and unzipping the free Oracle Instant Client "Basic" or "Basic Light" package for your operating system architecture.

      Instant Client on Windows requires an appropriate Visual Studio Redistributable. On Linux, the libaio (sometimes called libaio1) package is needed.

    • Alternatively use the Oracle Client libraries already available in $ORACLE_HOME/lib from a locally installed database such as the free Oracle XE release.

    Oracle Client libraries 18 and 12.2 can connect to Oracle Database 11.2 or greater. Version 12.1 client libraries can connect to Oracle Database 10.2 or greater. Version 11.2 client libraries can connect to Oracle Database 9.2 or greater.

  • Your Node.js applications can now connect to your database. The database can be on the same machine as Node.js, or on a remote machine. Node-oracledb does not install or create a database.

    You will need to know database credentials and the connection string for the database.

After installation, learn how to use node-oracledb from the examples and the documentation.

See Troubleshooting Node-oracledb Installation Problems if you have installation issues.

3. Node-oracledb Installation Instructions

Which Instructions to Follow

Instructions may need to be adjusted for your platform, environment and versions being used.

I have ... Follow this ...
Windows. My database is on another machine Node-oracledb Installation on Windows with Instant Client ZIP files
Windows. My database is on the same machine as Node.js Node-oracledb Installation on Windows with a Local Database or Full Client
Apple macOS Node-oracledb Installation on macOS
Linux. My database is on another machine Node-oracledb Installation on Linux with Instant Client RPMs or Node-oracledb Installation on Linux with Instant Client ZIP files
Linux. My database is on the same machine as Node.js Node-oracledb Installation on Linux with a Local Database or Full Client
Linux. I have the full Oracle client (installed via runInstaller) on the same machine as Node.js Node-oracledb Installation on Linux with a Local Database or Full Client
Linux. I want to install Node.js and node-oracledb RPM packages Installing Node.js and Node-oracledb RPMs from yum.oracle.com
AIX on Power Systems Node-oracledb Installation on AIX on Power Systems with Instant Client ZIP files
Solaris x86-64 (64-Bit) Node-oracledb Installation on Oracle Solaris x86-64 (64-Bit) with Instant Client ZIP files
Another OS with Oracle Database 11.2, 12, or 18 client libraries available Update binding.gyp and make any code changes required, sign the OCA, and submit a pull request with your patch.
Source code from GitHub Node-oracledb Installation from Source Code
I don't have internet access Node-oracledb Installation Without Internet Access

3.1 Prerequisites

All installations need:

  • Oracle 18, 12.2, 12.1 or 11.2 client libraries on the machine Node.js is installed on.

    Run node -p "process.arch" and make sure to use 64-bit or 32-bit Oracle client libraries to match the Node.js architecture.

    Oracle client libraries are included in Oracle Instant Client RPMs or ZIPs, a full Oracle Client, or a database on the same machine. You only need one of these installations.

    Oracle's standard client-server network interoperability allows connections between different versions of Oracle Client and Oracle Database. For certified configurations see Oracle Support's Doc ID 207303.1. In summary, Oracle Client 18 and 12.2 can connect to Oracle Database 11.2 or greater. Oracle Client 12.1 can connect to Oracle Database 10.2 or greater. Oracle Client 11.2 can connect to Oracle Database 9.2 or greater. The technical restrictions on creating connections may be more flexible. For example Oracle Client 12.2 can successfully connect to Oracle Database 10.2.

  • An Oracle Database to test node-oracledb.

    After installation of node-oracledb, your Node.js applications will be able to connect to your database. The database can be on the same machine as Node.js, or on a remote machine. Node-oracledb does not install or create a database.

    You will need to know database credentials and the connection string for the database.

If pre-built binaries are not available or desired, you need these additional tools to build from source code:

  • A compiler.

    Use Visual Studio on Windows, GCC on Linux or Xcode on macOS. When building with Node.js 6 onward, the compiler must support C++11. Note the default compiler on Oracle Linux 6 and RHEL 6 does not have the required support. Install GCC 4.8 or later or upgrade to Oracle Linux 7.

  • Python 2.7.

    Python 2.7 is needed by node-gyp, which is invoked by npm. Run python --version to find the version you have.

    If another version of Python occurs first in your binary path then, when you install node-oracledb, then run npm config set python /wherever/python-2.7/bin/python or use the --python option to indicate the correct version. For example: npm install --python=/wherever/python-2.7/bin/python oracledb.

3.2 Node-oracledb Installation on Linux with Instant Client RPMs

Follow these steps if your database is on a remote machine.

Questions and issues can be posted as GitHub Issues.

3.2.1 Install Prerequisites

Review the generic prerequisites.

Pre-built binaries were built on Oracle Linux 6 and will require a compatible glibc.

3.2.2 Install Node.js

Download and extract the Node.js "Linux Binaries" package. For example, if you downloaded version 8.9.4 for 64-bit you could install Node.js into /opt:

cd /opt
tar -Jxf node-v8.9.4-linux-x64.tar.xz

Set PATH to include Node.js:

export PATH=/opt/node-v8.9.4-linux-x64/bin:$PATH

3.2.3 Install the add-on

If you are behind a firewall you may need to set your proxy, for example:

export http_proxy=http://my-proxy.example.com:80/
export https_proxy=http://my-proxy.example.com:80/
To install a pre-built binary:

Install node-oracledb using the npm package manager, which is included in Node.js:

npm install oracledb

Available pre-built node-oracledb binaries can been seen on the releases page. They were built on Oracle Linux 6.

If a pre-built binary is successfully installed but isn't usable because it depends on a different glibc version, uninstall node-oracledb and install again from source code.

To install from source code:

If a pre-built node-oracledb binary is not installable, the binary can be built from source code, see Node-oracledb Installation from Source Code.

3.2.4 Install the free Oracle Instant Client 'Basic' RPM

Download the free Basic RPM from Oracle Technology Network and install it with sudo or as the root user:

sudo yum install oracle-instantclient18.3-basic-18.3.0.0.0-1.x86_64.rpm

This will install the required libaio package, if it is not already present.

If you have a ULN subscription, you can alternatively use yum to install the Basic package after enabling the ol7_x86_64_instantclient or ol6_x86_64_instantclient channel, depending on your version of Linux.

If there is no other Oracle software on the machine that will be impacted, then permanently add Instant Client to the run-time link path. For example, with sudo or as the root user:

sudo sh -c "echo /usr/lib/oracle/18.3/client64/lib > /etc/ld.so.conf.d/oracle-instantclient.conf"
sudo ldconfig

Alternatively, every shell running Node.js will need to have the link path set:

export LD_LIBRARY_PATH=/usr/lib/oracle/18.3/client64/lib

3.2.5 Optionally create the default Oracle Client configuration directory

If you intend to co-locate optional Oracle configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml with Instant Client, they can be put in a network/admin subdirectory under lib/. With Instant Client 12.2 or earlier, create this:

sudo mkdir -p /usr/lib/oracle/12.2/client64/lib/network/admin

This is the default Oracle configuration directory for applications using this Instant Client.

Alternatively, if you use Oracle client configuration files, they can be put in another, accessible directory. Then set the environment variable TNS_ADMIN to that directory name.

3.2.6 Run an example program

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

Note: Remember to set LD_LIBRARY_PATH or equivalent first.

3.3 Node-oracledb Installation on Linux with Instant Client ZIP files

Follow these steps if your database is on a remote machine.

Questions and issues can be posted as GitHub Issues.

3.3.1 Install Prerequisites

Review the generic prerequisites.

Pre-built binaries were built on Oracle Linux 6 and will require a compatible glibc.

3.3.2 Install Node.js

Download and extract the Node.js "Linux Binaries" package. For example, if you downloaded version 8.9.4 for 64-bit you could install Node.js into /opt:

cd /opt
tar -Jxf node-v8.9.4-linux-x64.tar.xz

Set PATH to include Node.js:

export PATH=/opt/node-v8.9.4-linux-x64/bin:$PATH

3.3.3 Install the add-on

If you are behind a firewall you may need to set your proxy, for example:

export http_proxy=http://my-proxy.example.com:80/
export https_proxy=http://my-proxy.example.com:80/
To install a pre-built binary:

Install node-oracledb using the npm package manager, which is included in Node.js:

npm install oracledb

Available pre-built node-oracledb binaries can been seen on the releases page. They were built on Oracle Linux 6.

If a pre-built binary is successfully installed but isn't usable because it depends on a different glibc version, uninstall node-oracledb and install again from source code.

To install from source code:

If a pre-built node-oracledb binary is not installable, the binary can be built from source code, see Node-oracledb Installation from Source Code.

3.3.4 Install the free Oracle Instant Client 'Basic' ZIP file

Download the free Basic ZIP file from Oracle Technology Network and unzip it into a directory accessible to your application, for example:

unzip instantclient-basic-linux.x64-18.3.0.0.0dbru.zip
mkdir -p /opt/oracle
mv instantclient_18_3 /opt/oracle

You will need the operating system libaio package installed. On some platforms the package is called libaio1.

if there is no other Oracle software on the machine that will be impacted, then permanently add Instant Client to the run-time link path. For example, with sudo or as the root user:

sudo sh -c "echo /opt/oracle/instantclient_18_3 > /etc/ld.so.conf.d/oracle-instantclient.conf"
sudo ldconfig

Alternatively, every shell running Node.js will need to have the link path set:

export LD_LIBRARY_PATH=/opt/oracle/instantclient_18_3:$LD_LIBRARY_PATH

3.3.5 Optionally create the default Oracle Client configuration directory

If you intend to co-locate optional Oracle configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml with Instant Client, they can be put in a network/admin subdirectory. With Instant Client 12.2 or earlier, create this:

sudo mkdir -p /opt/oracle/instantclient_12_2/network/admin

This is the default Oracle configuration directory for applications using this Instant Client.

Alternatively, if you use Oracle client configuration files, they can be put in another, accessible directory. Then set the environment variable TNS_ADMIN to that directory name.

3.3.6 Run an example program

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

Note: Remember to set LD_LIBRARY_PATH or equivalent first.

3.4 Node-oracledb installation on Linux with a Local Database or Full Client

Questions and issues can be posted as GitHub Issues.

3.4.1 Install Prerequisites

Review the generic prerequisites.

The ORACLE_HOME can be either a database home or a full Oracle client installation installed with Oracle's runInstaller.

For easy development, the free Oracle XE version of the database is available on Linux. Applications developed with XE may be immediately used with other editions of the Oracle Database.

3.4.2 Install Node.js

Download and extract the Node.js "Linux Binaries" package. For example, if you downloaded version 8.9.4 for 64-bit you could install Node.js into /opt:

cd /opt
tar -zxf node-v8.9.4-linux-x64.tar.gz

Set PATH to include Node.js:

export PATH=/opt/node-v8.9.4-linux-x64/bin:$PATH

3.4.3 Install the add-on

If you are behind a firewall you may need to set your proxy, for example:

export http_proxy=http://my-proxy.example.com:80/
export https_proxy=http://my-proxy.example.com:80/
To install a pre-built binary:

Install node-oracledb using the npm package manager, which is included in Node.js:

npm install oracledb

Available pre-built node-oracledb binaries can been seen on the releases page.

If a pre-built binary is successfully installed but isn't usable because it depends on a different glibc version, uninstall node-oracledb and install again from source code.

To install from source code:

If a pre-built node-oracledb binary is not installable, the binary can be built from source code, see Node-oracledb Installation from Source Code.

3.4.4 The default Oracle Client configuration directory

Optional Oracle client configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml can be placed in $ORACLE_HOME/network/admin.

Alternatively, if you use Oracle client configuration files, they can be put in another, accessible directory. Then set the environment variable TNS_ADMIN to that directory name.

3.4.5 Run an example program

Set required Oracle environment variables, such as ORACLE_HOME and LD_LIBRARY_PATH by executing:

source /usr/local/bin/oraenv

Or, if you are using Oracle XE, by executing:

source /u01/app/oracle/product/11.2.0/xe/bin/oracle_env.sh

Make sure the Node.js process has directory and file access permissions for the Oracle libraries and other files. Typically the home directory of the Oracle software owner will need permissions relaxed.

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

3.5 Node-oracledb Installation on macOS

Questions and issues can be posted as GitHub Issues.

3.5.1 Install Prerequisites

Review the generic prerequisites.

The pre-built binaries were built on macOS High Sierra, 10.13.6

Oracle Instant Client libraries are required on macOS. There is no native Oracle Database for macOS but one can easily be run in a Linux virtual machine, see The Easiest Way to Install Oracle Database on Apple Mac OS X.

3.5.2 Install Node.js

Download the Node.js package for macOS 64-bit and install it.

3.5.3 Install the add-on

If you are behind a firewall you may need to set your proxy, for example:

export http_proxy=http://my-proxy.example.com:80/
export https_proxy=http://my-proxy.example.com:80/
To install a pre-built binary:

Install node-oracledb using the npm package manager, which is included in Node.js:

npm install oracledb

Available pre-built node-oracledb binaries can been seen on the releases page.

To install from source code:

If a pre-built node-oracledb binary is not installable, the binary can be built from source code, see Node-oracledb Installation from Source Code.

3.5.4 Install the free Oracle Instant Client 'Basic' ZIP file

Download the free Basic 64-bit ZIP from Oracle Technology Network and unzip it, for example:

mkdir -p /opt/oracle
unzip instantclient-basic-macos.x64-12.2.0.1.0.zip

Create a symbolic link for the 'client shared library' in the user default library path such as in ~/lib or /usr/local/lib. For example:

mkdir ~/lib
ln -s instantclient_12_2/libclntsh.dylib ~/lib/

Alternatively, copy the required OCI libraries, for example:

mkdir ~/lib
cp instantclient_12_2/{libclntsh.dylib.12.1,libclntshcore.dylib.12.1,libons.dylib,libnnz12.dylib,libociei.dylib} ~/lib/

For Instant Client 11.2, the OCI libraries must be copied. For example:

mkdir ~/lib
cp /opt/oracle/instantclient_11_2/{libclntsh.dylib.11.1,libnnz11.dylib,libociei.dylib} ~/lib/

3.5.5 Optionally create the default Oracle Client configuration directory

If you intend to co-locate optional Oracle configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml with Instant Client, they can be put in a network/admin subdirectory. With Instant Client 12.2 or earlier, create this:

sudo mkdir -p /opt/oracle/instantclient_12_2/network/admin

This is the default Oracle configuration directory for applications using this Instant Client.

Alternatively, if you use Oracle client configuration files, they can be put in another, accessible directory. Then set the environment variable TNS_ADMIN to that directory name.

3.5.6 Run an example program

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

3.6 Node-oracledb Installation on Windows with Instant Client ZIP files

Follow these steps if your database is on a remote machine.

Questions and issues can be posted as GitHub Issues.

3.6.1 Install Prerequisites

Review the generic prerequisites.

The pre-built binaries were built with Visual Studio 2015 and require the matching redistributable.

You may need Administrator privileges to set environment variables or install software.

3.6.2 Install Node.js

Install the 64-bit Node.js MSI (e.g. node-v6.11.0-x64.msi) from nodejs.org. Make sure the option to add the Node and npm directories to the path is selected.

3.6.3 Install the add-on

Open a terminal window.

If you are behind a firewall you may need to set your proxy, for example:

set http_proxy=http://my-proxy.example.com:80/
set https_proxy=http://my-proxy.example.com:80/
To install a pre-built binary:

Install node-oracledb using the npm package manager, which is included in Node.js:

npm install oracledb

Available pre-built node-oracledb binaries can been seen on the releases page.

To install from source code:

If a pre-built node-oracledb binary is not installable, the binary can be built from source code, see Node-oracledb Installation from Source Code.

3.6.4 Install the free Oracle Instant Client ZIP

Download the free 64-bit Instant Client Basic ZIP file from Oracle Technology Network. (The 32-bit Instant Client is here).

  • Extract instantclient-basic-windows.x64-18.3.0.0.0dbru.zip

  • Add its directory to PATH. For example on Windows 7, update PATH in Control Panel -> System -> Advanced System Settings -> Advanced -> Environment Variables -> System variables -> PATH and add your path, such as C:\oracle\instantclient_18_3.

    If you have multiple versions of Oracle libraries installed, make sure the desired version occurs first in PATH before you run Node.js.

    Alternatively move the unzipped Instant Client files to node_modules\oracledb\build\Release so the DLLs and other files are in the same directory as the oracledb.node binary. If you do this, then PATH does not need to be set.

3.6.5 Optionally create the default Oracle Client configuration directory

If you intend to co-locate optional Oracle configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml with Instant Client, they can be put in a C:\oracle\instantclient_18_3\network\admin subdirectory. Create this if needed.

This is the default Oracle configuration directory for applications using this Instant Client.

Alternatively, configuration files can be put in another directory. Then set the environment variable TNS_ADMIN to that directory name.

3.6.6 Install the Visual Studio Redistributables

The PATH variable needs to include the appropriate VS Redistributable:

You can also find out the version required by locating the library OCI.DLL and running:

dumpbin /dependents oci.dll

If you see MSVCR120.dll then you need the VS 2013 Redistributable. If you see MSVCR100.dll then you need the VS 2010 Redistributable. If you see MSVCR80.dll then you need the VS 2005 Redistributable.

3.6.7 Run an example program

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

3.7 Node-oracledb Installation on Windows with a Local Database or Full Client

Questions and issues can be posted as GitHub Issues.

3.7.1 Install Prerequisites

Review the generic prerequisites.

The pre-built binaries were built with Visual Studio 2015 and require the matching redistributable.

The Oracle software can be either a database home or a full Oracle client installation. Make sure that PATH contains the correct binary directory, for example C:\oracle\product\12.2.0\dbhome_1\bin.

For easy development, the free Oracle XE version of the database is available on Linux. Applications developed with XE may be immediately used with other editions of the Oracle Database.

You may need Administrator privileges to set environment variables or install software.

3.7.2 Install Node.js

Install the 64-bit Node.js MSI (e.g. node-v6.11.0-x64.msi) from nodejs.org. Make sure the option to add the Node and npm directories to the path is selected.

3.7.3 Install the add-on

Open a terminal window.

If you are behind a firewall you may need to set your proxy, for example:

set http_proxy=http://my-proxy.example.com:80/
set https_proxy=http://my-proxy.example.com:80/
To install a pre-built binary:

Install node-oracledb using the npm package manager, which is included in Node.js:

npm install oracledb

Available pre-built node-oracledb binaries can been seen on the releases page.

To install from source code:

If a pre-built node-oracledb binary is not installable, the binary can be built from source code, see Node-oracledb Installation from Source Code.

3.7.4 The default Oracle Client configuration directory

Optional Oracle client configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml can be placed in $ORACLE_HOME\network\admin.

Alternatively, if you use Oracle client configuration files, they can be put in another, accessible directory. Then set the environment variable TNS_ADMIN to that directory name.

3.7.5 Run an example program

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

3.8 Copying node-oracledb Binaries on Windows

Node-oracledb binaries can be copied between compatible Windows systems.

After node-oracledb has been built or installed on the source computer, copy the node_modules\oracledb directory to the destination computer's node_module directory.

Both computers must have the same version and architecture (32-bit or 64-bit) of Node.js.

Oracle client libraries of the same architecture as Node.js should be in the destination computer's PATH. They may alternatively be in the directory node_modules\oracledb\build\Release where the oracledb.node binary is located. Note the Oracle client library versions do not have to be the same on different computers, but node-oracledb behavior and features may then differ.

The destination computer's PATH needs to include Visual Studio Redistributables. If you have Oracle client 18 or 12.2, install the Visual Studio 2013 Redistributable. For Oracle client 12.1 install the Visual Studio 2010 Redistributable. For Oracle client 11.2 install the Visual Studio 2005 Redistributable.

You can also find out the Redistributable required by locating the library OCI.DLL on the source computer and running:

dumpbin /dependents oci.dll

If you see MSVCR120.dll then you need the VS 2013 Redistributable. If you see MSVCR100.dll then you need the VS 2010 Redistributable. If you see MSVCR80.dll then you need the VS 2005 Redistributable.

3.9 Node-oracledb Installation on AIX on Power Systems with Instant Client ZIP files

Questions and issues can be posted as GitHub Issues.

3.9.1 Install Prerequisites

Review the generic prerequisites.

The GCC compiler is needed. GCC 4.8 (or later) is needed to install because compiling for Node.js 6 (or later) requires a C++11 compatible compiler.

Use GNU Make 4.1-1 or above.

Python 2.7 is needed by node-gyp.

3.9.2 Install Node.js

Download Node.js for AIX on Power Systems. For example, if you downloaded version 6.11.0 you could install Node.js into /opt:

cd /opt
gunzip -c node-v6.11.0-aix-ppc64.tar.gz | tar -xvf -

Set PATH to include Node.js:

export PATH=/opt/node-v6.11.0-aix-ppc64/bin:$PATH

3.9.3 Install the add-on

If you are behind a firewall you may need to set your proxy, for example:

export http_proxy=http://my-proxy.example.com:80/
export https_proxy=http://my-proxy.example.com:80/

Set the compiler to GCC:

export CC=gcc

Locate the GitHub tag of the desired node-oracledb version, for example v3.0.0, and use the npm package manager (which is included in Node.js) to install it.

If you have the git utility, you can install with:

npm install oracle/node-oracledb.git#v3.0.0

Otherwise install using:

npm install https://github.com/oracle/node-oracledb/releases/download/v3.0.0/oracledb-src-3.0.0.tgz

3.9.4 Install the free Oracle Instant Client 'Basic' ZIP file

Download the Basic ZIP file from Oracle Technology Network and extract it into a directory that is accessible to your application, for example /opt/oracle:

unzip instantclient-basic-aix.ppc64-12.2.0.1.0.zip
mkdir -p /opt/oracle
mv instantclient_12_2 /opt/oracle

To run applications, you will need to set the link path:

export LIBPATH=/opt/oracle/instantclient_12_2:$LIBPATH

3.9.5 Optionally create the default Oracle Client configuration directory

If you intend to co-locate optional Oracle configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml with Instant Client, they can be put in a network/admin subdirectory. Create this if needed. For example:

sudo mkdir -p /opt/oracle/instantclient_12_2/network/admin

This is the default Oracle configuration directory for applications using this Instant Client.

Alternatively, if you use Oracle client configuration files, they can be put in another, accessible directory. Then set the environment variable TNS_ADMIN to that directory name.

3.9.6 Run an example program

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

3.10 Node-oracledb Installation on Oracle Solaris x86-64 (64-Bit) with Instant Client ZIP files

Questions and issues can be posted as GitHub Issues.

3.10.1 Install Prerequisites

Review the generic prerequisites.

3.10.2 Install Node.js

Download the Node.js source code.

Compile and build the Node.js engine into a directory of your choice, such as /opt/node:

./configure --dest-cpu=x64 --dest-os=solaris --prefix=/opt/node
make
make install

Note: if warnings are shown for objdump and dtrace, then set PATH to include these binaries. This is most likely /usr/gnu/bin and /usr/bin, respectively.

Set PATH to include the Node.js and Node-gyp binaries

export PATH=/opt/node/bin:/opt/node/lib/node_modules/npm/bin/node-gyp-bin:$PATH

3.10.3 Install the add-on

If you are behind a firewall you may need to set your proxy, for example:

export http_proxy=http://my-proxy.example.com:80/
export https_proxy=http://my-proxy.example.com:80/

Use the GNU gmake utility:

export MAKE=gmake

Locate the GitHub tag of the desired node-oracledb version, for example v3.0.0, and use the npm package manager (which is included in Node.js) to install it.

If you have the git utility, you can install with:

npm install oracle/node-oracledb.git#v3.0.0

Otherwise install using:

npm install https://github.com/oracle/node-oracledb/releases/download/v3.0.0/oracledb-src-3.0.0.tgz

3.10.4 Install the free Oracle Instant Client 'Basic' ZIP file

Download the Basic ZIP file from Oracle Technology Network and extract it into a directory that is accessible to your application, for example /opt/oracle:

cd /opt/oracle
unzip instantclient-basic-solaris.x64-12.2.0.1.0.zip

To run applications, you will need to set the link path:

export LD_LIBRARY_PATH_64=/opt/oracle/instantclient_12_2:$LD_LIBRARY_PATH_64

3.10.5 Optionally create the default Oracle Client configuration directory

If you intend to co-locate optional Oracle configuration files such as tnsnames.ora, sqlnet.ora, ldap.ora, or oraaccess.xml with Instant Client, they can be put in a network/admin subdirectory. Create this if needed. For example:

mkdir -p /opt/oracle/instantclient_12_2/network/admin

This is the default Oracle configuration directory for applications using this Instant Client.

Alternatively, if you use Oracle client configuration files, they can be put in another, accessible directory. Then set the environment variable TNS_ADMIN to that directory name.

3.10.6 Run an example program

Download the example programs from GitHub.

Edit dbconfig.js and set the database credentials to your environment, for example:

module.exports = {
  user          : "hr",
  password      : "welcome",
  connectString : "localhost/XE"
};

Run one of the examples:

node example.js

3.11 Node-oracledb Installation from Source Code

Node-oracledb can be compiled from the source code on GitHub. Some build tools are required.

Install Python 2.7, which is required for the node-gyp utility:

  • If another version of Python occurs first in your binary path then run npm config set python /wherever/python-2.7/bin/python or use the --python option to indicate the correct version. For example: npm install --python=/whereever/python-2.7/bin/python oracledb.

  • On Windows, install the Python 2.7 MSI and select the customization option to "Add python.exe to Path".

Install a C++11 compatible compiler:

  • On Linux you need GCC 4.8 (or later) because compiling for Node.js 6 (or later) requires a C++11 compatible compiler. The default compiler on Oracle Linux 6 and RHEL 6 does not have the required C++11 support. Install GCC 4.8 or later or upgrade to Oracle Linux 7.

  • On macOS install Xcode from the Mac App store.

  • On Windows, install a C/C++ build environment such as Microsoft Visual Studio 2015. Compilers supported by Oracle libraries are found in Oracle documentation for each version, for example Oracle Database Client Installation Guide for Microsoft Windows. Some users report that the npm windows-build-tools package has the necessary tools to build node-oracledb from source code.

The directories with the python and npm executables should be in your PATH environment variable. On Windows you can use vcvars64.bat (or vcvars.bat if you building with 32-bit binaries) to set the environment. Alternatively you can open the 'Developer Command Prompt for Visual Studio' which has environment variables already configured.

3.11.1 Installing using GitHub branches and tags

Node-oracledb can be installed from GitHub tags and branches. In general, use the most recent release tag.

The git utility is required for this method.

Build node-oracledb from source code by changing the package specifier so that npm downloads from GitHub instead of from npmjs.com. For example, to install the code from the GitHub tag 'v3.0.0', add oracle/node-oracledb#v3.0.0 to your package.json dependencies, or use the command:

npm install oracle/node-oracledb#v3.0.0

This will download, compile and install node-oracledb.

Use the general Node-oracledb Installation Instructions for your operating system to see how to set up Oracle client libraries, create client configuration directories, and run the samples.

Users without git, or with older versions of npm such as included in Node.js 6, may alternatively need to use pre-bundled source code:

npm install https://github.com/oracle/node-oracledb/releases/download/v3.0.0/oracledb-src-3.0.0.tgz

Note it may take some time before compilation begins due to the slow download of source code from GitHub.

3.11.2 Installing GitHub clones and zip files

If you clone node-oracledb or download a zip from GitHub to build node-oracledb from source code, you need to make sure the ODPI-C submodule is also included. Otherwise the build will fail with an error like 'dpi.h' file not found.

  • If you download a node-oracledb ZIP file from GitHub, you must separately download the ODPI-C submodule code and extract it into the odpi directory.

  • If you clone the GitHub repository, you need to additionally run:

    git submodule init
git submodule update

Then build node-oracledb from source code using the Node-oracledb Installation Instructions for your operating system. Substitute the command npm install your-dir-path/node-oracledb when installing.

3.12 Node-oracledb Installation Without Internet Access

There are several ways to install node-oracledb on computers that do not have internet access, or have no access to either the npm registry or github.com.

3.12.1 Installing on an Intermediary Machine

On an identical machine that has access to the internet, install node-oracle following the Node-oracledb Installation Instructions for that operating system.

Then copy node_modules/oracledb and Oracle client libraries to the offline computer. Windows users should see Copying node-oracledb Binaries on Windows and make sure the correct Visual Studio Redistributable is also installed.

3.12.2 Manually Extracting Pre-built Binaries

If pre-built node-oracledb binaries are available for your version of Node.js and operating system, you can install manually:

  • On a computer that has access to github.com, navigate to a release on the GitHub Release page.

    Download the release's main node-oracledb package, for example oracledb-3.0.0.tgz.

    Also download the appropriate binary package, for example oracledb-v3.0.0-node-abi57-darwin-x64.gz. To determine the correct binary package, find your Node.js module version, platform and architecture using:

    • node -p 'process.versions.modules'
    • node -p 'process.platform'
    • node -p 'process.arch'

    For example, when installing node-oracledb 3.0.0 on macOS with Node.js 8, these commands will show the module version is '57', the platform is 'darwin' and the architecture is 'x64'. The package to download is oracledb-v3.0.0-node-abi57-darwin-x64.gz

    If an appropriate package is not available, follow the Node-oracledb Installation Instructions for your operating system and build node-oracledb from source code.

  • Use an operating system utility to extract the main package to node_modules/oracledb. For example:

    mkdir node_modules/oracledb
cd node_modules/oracledb
tar -xzf oracledb-3.0.0.tgz

    The node_modules directory will contain:

    node_modules/
|-- oracledb
     |-- CHANGELOG.md
     |-- LICENSE.md
     |-- README.md
     |-- binding.gyp
     |-- index.js
     |-- lib
     |   |-- connection.js
     |   |-- lob.js
     |   |-- oracledb.js
     |   |-- pool.js
     |   |-- querystream.js
     |   |-- resultset.js
     |   |-- util.js
     |-- odpi
     |   |-- . . .
     |-- package
     |   |-- extractpackage.js
     |   |-- oracledbinstall.js
     |   |-- util.js
     |-- package.json
     |-- src
         |-- . . .

  • Locate node_modules/oracledb/package/extractpackage.js and use it to unarchive the binary package, for example:

    node extractpackage.js path=oracledb-v3.0.0-node-abi57-darwin-x64.gz

  • Create the subdirectory node_modules/oracledb/build/Release and move the extracted oracledb.node binary to node_modules/oracledb/build/Release/oracledb.node

  • Then copy node_modules/oracledb and Oracle client libraries to the offline computer. Windows users should see Copying node-oracledb Binaries on Windows and make sure the correct Visual Studio Redistributable is also installed.

3.12.3 Installing node-oracledb without GitHub Access

Some companies block access to github.com so npm install oracledb will fail to download binaries, as will installing source code from GitHub with npm install oracle/node-oracledb.git#v3.0.0.

There are two suggested methods for generic installation. Oracle Linux users can also install Node.js and Node-oracledb RPMs.

3.12.3.1 Use the oracle.com GitHub mirror

Oracle has a mirror of the GitHub repository source code that can be cloned with:

git clone git://oss.oracle.com/git/oracle/node-oracledb.git/

Binaries are not cloned. Follow the general instructions in Node-oracledb Installation from Source Code but install by running npm install path-to-your-clone-directory from outside the clone directory.

3.12.3.2 Use the source code in the npm package

Alternatively you can compile the source code that is included in the npm package:

  • Download the node-oracledb package from npm, for example https://registry.npmjs.com/oracledb/-/oracledb-3.0.0.tgz

  • Create a directory such as oracledb_build and extract the package inside it:

    mkdir oracledb_build
mv oracledb-3.0.0.tgz oracledb_build
cd oracledb_build
tar -xzf oracledb-3.0.0.tgz

    The directory contents will be the same as shown in the previous section.

  • Edit package.json and delete the line that invokes the binary download script:

    "install": "node package/oracledbinstall.js",

  • Either add a dependency on nan to package.json, or manually install it:

    npm install nan

  • Follow the general instructions in Node-oracledb Installation from Source Code but install by running

    npm install ./oracledb_build

    from outside the directory.

3.12.4 Hosting Your Own Binary Packages

You can create your own node-oracledb packages and host them on your web server for any architecture and version that node-oracledb will build with.

The maintainer scripts in /package can be used to build desired packages. See package/README for details.

3.13 Installing Node.js and Node-oracledb RPMs from yum.oracle.com

Node.js Linux RPM packages are available on yum.oracle.com.

As an example, to install Node 8 on Oracle Linux 7, run these commands as the root user:

cd /etc/yum.repos.d
mv public-yum-ol7.repo public-yum-ol7.repo.bak
wget http://yum.oracle.com/public-yum-ol7.repo
yum install yum-utils
yum-config-manager --enable ol7_developer_nodejs8
yum install nodejs

Download the Oracle Instant Client Basic package from Instant Client Downloads for Linux x86-64 (64-bit) and install it:

yum install oracle-instantclient18.3-basic-18.3.0.0.0-1.x86_64.rpm
echo /usr/lib/oracle/18.3/client64/lib > /etc/ld.so.conf.d/oracle-instantclient.conf
sudo ldconfig

Install the node-oracledb package, for example:

yum install node-oracledb-18c-node10-3.0.0

Since node-oracledb is installed globally, set NODE_PATH before running applications. You can find the global module directory by running npm root -g.

export NODE_PATH=$(npm root -g)
node myapp.js

4. Installing Node-oracledb 1.x

If you need to install the previous node-oracledb 1.x add-on, refer to the steps in the version 1.x INSTALL guide. To get an old add-on you must explicitly use its version when installing:

npm install oracledb@1.13.1

This version always requires compilation.

5. Useful Resources for Node-oracledb

Node-oracledb can be installed on the pre-built Database App Development VM for VirtualBox, which has Oracle Database 12c pre-installed on Oracle Linux.

If you want to use your own database, installing the free Oracle Database 11.2 'XE' Express Edition is quick and easy. Other database editions may be downloaded here or used with Docker.

If you want to install Oracle Linux yourself, it is free from here.

Oracle's free LiveSQL site is a great place to learn SQL and test statements without needing your own database. Any questions about SQL or PL/SQL can be asked at AskTom.

6. Troubleshooting Node-oracledb Installation Problems

Read the Node-oracledb Installation Instructions.

Google anything that looks like an error.

If npm install oracledb fails:

  • Did you get an HTTPS 404 failure? A pre-built node-oracledb binary package is probably not available on https://github.com/oracle/node-oracledb/releases for your Node.js version or operatiing system. Change your Node.js version or compile node-oracledb from source code.

  • Was there a network connection error? Do you need to set http_proxy and/or https_proxy?

  • Use npm install --verbose oracledb. Review your output and logs. Try to install in a different way. Try some potential solutions. Before installing on Windows also do set NODE_ORACLEDB_TRACE_INSTALL=TRUE. On Linux and macOS use export NODE_ORACLEDB_TRACE_INSTALL=TRUE.

  • When compiling node-oracledb from source, does your compiler have C++11 support, e.g. use VS 2015 or GCC 4.8.

  • When compiling node-oracledb from source, do you have Python 2.7? Run python --version.

  • Do you have an old version of node-gyp installed? Try updating it. Also try deleting $HOME/.node-gyp or equivalent.

  • Try running npm cache clean -f and deleting the node_modules/oracledb directory.

If require('oracledb') fails:

  • If you got NJS-045: cannot load the oracledb add-on binary for Node.js or DPI-1047: Oracle Client library cannot be loaded, then review any messages and the installation instructions.

  • Does your Node.js architecture (32-bit or 64-bit) match the Oracle client library architecture? Run node -p 'process.arch' and compare with, for example, dumpbin /headers oci.dll (on Windows), file libclntsh.dylib (macOS) or file libclntsh.so.* (Linux).

  • On Windows, do you have the correct VS Redistributable? Review the Windows install instructions.

  • On Windows, check the PATH environment variable includes the Oracle client libraries. Ensure that you have restarted your command prompt after you modified any environment variables.

  • Do you need system privileges to set, or preserve, variables like PATH, e.g. an elevated command prompt on Windows, or sudo -E on Linux?

  • Do you have multiple copies of Oracle libraries installed? Is the expected version first in PATH (on Windows) or LD_LIBRARY_PATH (on Linux)?

  • On macOS, did you install Oracle Instant Client in ~/lib or /usr/local/lib?

  • Do you have multiple copies of Node.js installed? Did the correct npm and node-gyp get invoked?

  • Did you get Error: Module version mismatch or Error: Module did not self-register? You must rebuild node-oracledb when you upgrade Node.js.

Issues and questions about node-oracledb can be posted on GitHub or Slack (link to join Slack).