Copyright (c) 2015, 2019, 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.
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 8, 10 and 12 on 64-bit Oracle Linux, Windows and macOS. Note Node.js 8.16, Node.js 10.16, or later is required. 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 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.
Node-oracledb 4.0 was refactored to use N-API version 4. On each operating system, a node-oracledb binary will work with a number of Node.js versions from Node.js 8.16 and Node.js 10.16 onward, dependent on N-API compatibility. This means that when upgrading Node.js, you may not need to reinstall node-oracledb.
If compiling from source code, the compiler no longer needs C++11 compatibility. The node-oracledb source code is now pure C.
See Installing Older Versions of Node-oracledb for information about older versions.
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 proxy with
npm config set proxy http://myproxy.example.com:80/.
Many users will be able to use a pre-built node-oracledb binary:
Add oracledb to your package.json dependencies or run npm install
oracledb. This installs from the npm registry.
Windows users will require the Visual Studio 2017 Redistributable.
If a binary is not available, you will need to compile node-oracledb from source code:
Install Python 2.7
Install a C Compiler such as Xcode, GCC, Visual Studio 2017, or similar.
Run npm install oracle/node-oracledb.git#v4.0.1, or add
oracle/node-oracledb.git#v4.0.1 to your package.json
dependencies. Substitute your desired GitHub tag.
Add Oracle 19, 18, 12, or 11.2 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 19, 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.
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 that uses RPM packages. My database is on another machine | Node-oracledb Installation on Linux with Instant Client RPMs |
| Linux that uses Debian packages. My database is on another machine | 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 19, 18, 12, or 11.2 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 |
All installations need:
Oracle 19, 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 19, 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.
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.
Follow these steps if your database is on a remote machine and your Linux distribution uses RPM packages. Also see Installing Node.js and Node-oracledb RPMs from yum.oracle.com.
Questions and issues can be posted as GitHub Issues.
Review the generic prerequisites.
Pre-built binaries were built on Oracle Linux 6 and will require a compatible glibc.
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
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Install node-oracledb using the npm package manager, which is
included in Node.js:
npm install oracledb
The pre-built binaries 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.
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.
Download the free Basic RPM from yum.oracle.com. There are channels for Oracle Linux 6 and Oracle Linux 7. The package contents are identical in both channels. Alternatively, multiple versions of Instant Client RPMs are available from Oracle Technology Network.
Install Instant Client Basic with sudo or as the root user, either directly from yum.oracle.com:
sudo yum -y install oracle-release-el7
sudo yum -y install oracle-instantclient19.3-basic
Or from a downloaded file:
sudo yum install oracle-instantclient19.3-basic-19.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.
For Instant Client 19, the system library search path is automatically configured during installation.
For older versions, 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, for version 18 and earlier, every shell running Node.js will need to have the link path set:
export LD_LIBRARY_PATH=/usr/lib/oracle/18.3/client64/lib
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.
Download the example programs from GitHub.
Edit dbconfig.js and set the database credentials to your
environment, for example:
module.exports = {
user : "hr",
password : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
Note: Remember to set LD_LIBRARY_PATH or equivalent first.
Follow these steps if your database is on a remote machine and your Linux distribution uses the Debian package format, for example if you are using Ubuntu. These steps can also be used if you prefer not to install RPMs.
Questions and issues can be posted as GitHub Issues.
Review the generic prerequisites.
Pre-built binaries were built on Oracle Linux 6 and will require a compatible glibc.
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
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Install node-oracledb using the npm package manager, which is
included in Node.js:
npm install oracledb
The pre-built binaries 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.
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.
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-19.3.0.0.0dbru.zip
mkdir -p /opt/oracle
mv instantclient_19_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_19_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_19_3:$LD_LIBRARY_PATH
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.
Download the example programs from GitHub.
Edit dbconfig.js and set the database credentials to your
environment, for example:
module.exports = {
user : "hr",
password : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
Note: Remember to set LD_LIBRARY_PATH or equivalent first.
Questions and issues can be posted as GitHub Issues.
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.
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
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Install node-oracledb using the npm package manager, which is
included in Node.js:
npm install oracledb
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.
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.
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.
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 11.2, 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 : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
Questions and issues can be posted as GitHub Issues.
Review the generic prerequisites.
The pre-built binaries were built on macOS Mojave, 10.14.5.
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.
Download the Node.js package for macOS 64-bit and install it.
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Install node-oracledb using the npm package manager, which is
included in Node.js:
npm install oracledb
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.
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-18.1.0.0.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_18_1/libclntsh.dylib ~/lib/
Alternatively, copy the required OCI libraries, for example:
mkdir ~/lib
cp instantclient_18_1/{libclntsh.dylib.18.1,libclntshcore.dylib.18.1,libons.dylib,libnnz18.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/
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.
Download the example programs from GitHub.
Edit dbconfig.js and set the database credentials to your
environment, for example:
module.exports = {
user : "hr",
password : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
Follow these steps if your database is on a remote machine, or if you already have Oracle software installed but you want node-oracledb to use a different version of the libraries.
Questions and issues can be posted as GitHub Issues.
Review the generic prerequisites.
The pre-built binaries were built with Visual Studio 2017 and require the matching redistributable.
You may need Administrator privileges to set environment variables or install software.
Install the 64-bit Node.js MSI (e.g. node-v10.16.0-x86.msi) from nodejs.org. Make sure the option to add the Node and npm directories to the path is selected.
Open a terminal window.
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Install node-oracledb using the npm package manager, which is
included in Node.js:
npm install oracledb
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.
Download the free 64-bit Instant Client Basic ZIP file from Oracle Technology Network. If your Node.js architecture is 32-bit, then use the 32-bit Instant Client instead.
Unzip the ZIP file into a directory that is accessible to your
application. For example unzip
` instantclient-basic-windows.x64-19.3.0.0.0dbru.zip to
C:\oracle\instantclient_19_3`.
Add this directory to the PATH environment variable. For example
on Windows 7, update PATH in Control Panel -> System -> Advanced
System Settings -> Advanced -> Environment Variables -> System
variables -> PATH. The Instant Client directory must occur in
PATH before any other Oracle directories.
Restart any open command prompt windows.
To avoid interfering with existing tools that require other Oracle
Client versions then, instead of updating the system-wide PATH
variable, you may prefer to write a batch file that sets PATH, for
example:
REM mynode.bat
SET PATH=C:\oracle\instantclient_19_3;%PATH%
node %*
Invoke this batch file every time you want to run Node.js.
Alternatively use SET to change your PATH in each command prompt
window before you run node.
Another option is to 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 binaries. If you
do this, then PATH does not need to be set.
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.
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.
Download the example programs from GitHub.
Edit dbconfig.js and set the database credentials to your
environment, for example:
module.exports = {
user : "hr",
password : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
Questions and issues can be posted as GitHub Issues.
Review the generic prerequisites.
The pre-built binaries were built with Visual Studio 2017 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 Windows. 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.
Install the 64-bit Node.js MSI (e.g. node-v10.16.0-x64.msi) from nodejs.org. Make sure the option to add the Node and npm directories to the path is selected.
Open a terminal window.
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Install node-oracledb using the npm package manager, which is
included in Node.js:
npm install oracledb
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.
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.
Download the example programs from GitHub.
Edit dbconfig.js and set the database credentials to your
environment, for example:
module.exports = {
user : "hr",
password : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
Questions and issues can be posted as GitHub Issues.
Review the generic prerequisites.
The GCC compiler is needed.
Use GNU Make 4.1-1 or above.
Python 2.7 is needed by node-gyp.
Download Node.js for AIX on Power Systems. For
example, if you downloaded version 10.16.0 you could install Node.js
into /opt:
cd /opt
gunzip -c node-v10.16.0-aix-ppc64.tar.gz | tar -xvf -
Set PATH to include Node.js:
export PATH=/opt/node-v10.16.0-aix-ppc64/bin:$PATH
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Set the compiler to GCC:
export CC=gcc
Locate the GitHub tag of the desired node-oracledb version, for
example v4.0.1, 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#v4.0.1
Otherwise install using:
npm install https://github.com/oracle/node-oracledb/releases/download/v4.0.1/oracledb-src-4.0.1.tgz
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-19.3.0.0.0dbru.zip
mkdir -p /opt/oracle
mv instantclient_19_3 /opt/oracle
To run applications, you will need to set the link path:
export LIBPATH=/opt/oracle/instantclient_19_3:$LIBPATH
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_19_3/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.
Download the example programs from GitHub.
Edit dbconfig.js and set the database credentials to your
environment, for example:
module.exports = {
user : "hr",
password : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
Questions and issues can be posted as GitHub Issues.
Review the generic prerequisites.
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
If you are behind a firewall you may need to set your proxy, for example:
npm config set proxy http://myproxy.example.com:80/
Use the GNU gmake utility:
export MAKE=gmake
Locate the GitHub tag of the desired node-oracledb version, for
example v4.0.1, 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#v4.0.1
Otherwise install using:
npm install https://github.com/oracle/node-oracledb/releases/download/v4.0.1/oracledb-src-4.0.1.tgz
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-18.3.0.0.0dbru.zip
To run applications, you will need to set the link path:
export LD_LIBRARY_PATH_64=/opt/oracle/instantclient_18_3:$LD_LIBRARY_PATH_64
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_18_3/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.
Download the example programs from GitHub.
Edit dbconfig.js and set the database credentials to your
environment, for example:
module.exports = {
user : "hr",
password : process.env.NODE_ORACLEDB_PASSWORD,
connectString : "localhost/XEPDB1"
};
Run one of the examples:
node example.js
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 compiler:
On Linux, GCC 4.4.7 (the default on Oracle Linux 6) is known to work.
On macOS install Xcode from the Mac App store.
On Windows, install a C build environment such as Microsoft
Visual Studio 2017. 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.
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 ‘v4.0.1’, add
oracle/node-oracledb#v4.0.1 to your package.json dependencies, or
use the command:
npm install oracle/node-oracledb#v4.0.1
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/v4.0.1/oracledb-src-4.0.1.tgz
Note it may take some time before compilation begins due to the slow download of source code from GitHub.
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.
To clone the GitHub repository run:
git clone https://github.com/oracle/node-oracledb.git
cd node-oracledb
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.
Some companies block access to github.com so compiling source code
from GitHub with npm install oracle/node-oracledb.git#v4.0.1 will
fail.
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/
cd node-oracledb
git submodule init
git submodule update
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.
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.
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 19 install the Visual
Studio 2017 Redistributable. 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.
Node.js and node-oracledb Linux RPM packages are available on yum.oracle.com. Oracle Instant Client is also available in Oracle Linux 6 and Oracle Linux 7 channels. This means installation is simple, and can be automated.
As an example, to install Node 10 on Oracle Linux 7, run these commands:
sudo yum install -y oracle-nodejs-release-el7 oracle-release-el7
sudo yum install nodejs node-oracledb-node10
For Instant Client 19, the system library search path is automatically configured during installation.
For older versions, 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
Since node-oracledb is installed globally, set NODE_PATH before
running applications:
export NODE_PATH=$(npm root -g)
node myapp.js
See Node.js for Oracle Linux for details.
You can host node-oracledb packages locally.
Download the node-oracledb package from npm, for example from
https://registry.npmjs.com/oracledb/-/oracledb-4.0.1.tgz
Alternatively, if you want to build your own binaries and
node-oracledb package, the maintainer scripts in
/package
can be used. See
package/README
for details.
If you make the package accessible on your local web server, for example at www.example.com/oracledb-4.0.1.tgz, then your install command would be:
npm install https://www.example.com/oracledb-4.0.1.tgz
or your package.json would contain:
. . .
"dependencies": {
"oracledb": "https://www.example.com/oracledb-4.0.1.tgz"
},
. . .
Pre-built node-oracledb 2 and 3 binaries are available for some platforms and Node.js versions. Review the release tags for availability. You can compile the add-on for other platforms or Node.js versions.
The node-oracledb 3.1 installation steps are in the version 3.1 INSTALL guide.
The node-oracledb 3.0 installation steps are in the version 3.0 INSTALL guide.
The node-oracledb 2.x installation steps are in the version 2.x INSTALL guide
To get an old add-on you must explicitly use its version when installing:
npm install oracledb@2.3.0
or your package.json could contain:
. . .
"dependencies": {
"oracledb": "2.3.0"
},
. . .
The node-oracledb 1.x installation steps are in the version 1.x INSTALL guide. This version always requires compilation. To get an old add-on you must explicitly use its version when installing:
npm install oracledb@1.13.1
or your package.json could contain:
. . .
"dependencies": {
"oracledb": "1.13.1"
},
. . .
Read the Node-oracledb Installation Instructions.
Google anything that looks like an error.
If npm install oracledb fails:
Review the error messages closely. If a pre-built node-oracledb binary package is not available for your Node.js version or operating system, then change your Node.js version or compile node-oracledb from source code.
Was there a network connection error? Do you need to use npm config set
proxy, or 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.
When compiling node-oracledb from source, do you have Python 2.7?
Run python --version.
When compiling node-oracledb from source, 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 creating a connection fails:
If you got DPI-1047: Cannot locate an Oracle Client library, 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 libraries in ~/lib
or /usr/local/lib?
Issues and questions about node-oracledb can be posted on GitHub or Slack (link to join Slack).