2023-05-24 12:54:08 +08:00
# Installing node-oracledb
2015-01-21 00:51:22 +08:00
2023-02-21 12:32:15 +08:00
*Copyright (c) 2015, 2023, Oracle and/or its affiliates.*
2015-01-21 00:51:22 +08:00
2023-02-21 09:43:43 +08:00
This software is dual-licensed to you under the Universal Permissive License
(UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
either license.
2015-01-21 00:51:22 +08:00
2023-02-21 09:43:43 +08:00
If you elect to accept the software under the Apache License, Version 2.0,
the following applies:
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
2015-01-21 00:51:22 +08:00
You may obtain a copy of the License at
2023-02-21 09:43:43 +08:00
https://www.apache.org/licenses/LICENSE-2.0
2015-01-21 00:51:22 +08:00
2023-02-21 09:43:43 +08:00
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.
2015-01-21 00:51:22 +08:00
2023-05-24 12:54:08 +08:00
## Note: The node-oracledb installation instructions have moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html).
2015-01-21 00:51:22 +08:00
2023-02-21 11:32:59 +08:00
## <a name="overview"></a> 1. Node-oracledb Overview
2020-02-28 07:50:42 +08:00
2023-05-24 12:54:08 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#overview )
2017-12-12 07:17:52 +08:00
2019-08-14 19:48:50 +08:00
## <a name="quickstart"></a> 2. Quick Start node-oracledb Installation
2017-11-17 20:06:47 +08:00
2023-05-24 12:54:08 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart )
2021-05-29 16:06:47 +08:00
2017-12-12 06:56:12 +08:00
## <a name="instructions"></a> 3. Node-oracledb Installation Instructions
2017-07-08 10:48:36 +08:00
2023-05-24 12:54:08 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instructions )
2017-07-08 10:48:36 +08:00
2017-12-12 06:56:12 +08:00
### <a name="prerequisites"></a> 3.1 Prerequisites
2017-11-17 20:06:47 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#prerequisites )
2017-06-14 09:49:08 +08:00
2020-06-03 12:14:49 +08:00
#### <a name="linuxinstall"></a> 3.2 Node-oracledb Installation on Linux
2015-01-21 00:51:22 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#linuxinstall )
2021-05-29 07:53:59 +08:00
#### <a name="instzip"></a> 3.2.1 Node-oracledb Installation on Linux x86_64 with Instant Client ZIP files
2020-06-03 12:14:49 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instzip )
2015-01-21 00:51:22 +08:00
2021-05-29 07:53:59 +08:00
#### <a name="instoh"></a> 3.2.2 Node-oracledb installation on Linux x86_64 with a Local Database or Full Client
2017-06-14 09:49:08 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instoh )
2015-01-21 00:51:22 +08:00
2021-05-29 07:53:59 +08:00
#### <a name="instrpm"></a> 3.2.3 Node-oracledb Installation on Linux x86_64 with Instant Client RPMs
2015-01-21 00:51:22 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instrpm )
2020-06-03 12:14:49 +08:00
2021-05-29 07:53:59 +08:00
#### <a name="aarch64"></a> 3.2.4 Node-oracledb Installation on Linux ARM (aarch64)
2020-06-03 12:14:49 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#aarch64 )
2020-06-03 12:14:49 +08:00
2021-05-29 07:53:59 +08:00
#### <a name="instnoderpms"></a> 3.2.5 Installing Node.js and node-oracledb RPMs from yum.oracle.com
2020-07-05 13:12:30 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instnoderpms )
2020-06-03 12:14:49 +08:00
2021-03-08 15:45:35 +08:00
### <a name="instosx"></a> 3.3 Node-oracledb Installation on Apple macOS (Intel x86)
2015-02-12 07:14:30 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instosx )
2015-02-12 07:14:30 +08:00
2020-06-03 12:14:49 +08:00
### <a name="windowsinstallation"></a> 3.4 Node-oracledb Installation on Microsoft Windows
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#windowsinstallation )
2020-06-03 12:14:49 +08:00
#### <a name="instwin"></a> 3.4.1 Node-oracledb Installation on Microsoft Windows with Instant Client ZIP files
2017-06-14 09:49:08 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instwin )
2017-11-17 20:06:47 +08:00
2020-06-03 12:14:49 +08:00
#### <a name="instwinoh"></a> 3.4.2 Node-oracledb Installation on Microsoft Windows with a Local Database or Full Client
2017-11-17 20:06:47 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instwinoh )
2015-02-12 07:16:59 +08:00
2020-06-03 12:14:49 +08:00
### <a name="instaix"></a> 3.5 Node-oracledb Installation on AIX on Power Systems with Instant Client ZIP files
2017-11-17 20:06:47 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instaix )
2016-07-08 14:54:51 +08:00
2020-06-03 12:14:49 +08:00
### <a name="instsolarisx8664"></a> 3.6 Node-oracledb Installation on Oracle Solaris x86-64 (64-Bit) with Instant Client ZIP files
2016-07-08 14:54:51 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instsolarisx8664 )
2017-06-29 14:35:55 +08:00
2021-05-29 16:06:47 +08:00
### <a name="github"></a> <a name="compileenv"></a> 3.7 Node-oracledb Installation from Source Code
2020-02-16 08:16:59 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#github )
2017-11-17 20:06:47 +08:00
2021-05-29 16:06:47 +08:00
#### <a name="githubclone"></a> 3.7.1 Installing GitHub clones and ZIP files
2020-02-16 08:16:59 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#githubclone )
2021-05-29 16:06:47 +08:00
#### <a name="githubtags"></a> 3.7.2 Installing using GitHub branches and tags
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#githubtags )
2020-06-03 12:14:49 +08:00
2021-05-29 16:06:47 +08:00
#### <a name="sourcepackage"></a> 3.7.3 Installing from a source package
2017-11-17 20:06:47 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#sourcepackage )
2018-02-09 16:55:52 +08:00
2021-05-29 16:06:47 +08:00
#### <a name="nogithubaccess"></a> 3.7.4 Installing from Oracle's repository
2018-02-09 16:55:52 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#nogithubaccess )
2021-05-29 16:06:47 +08:00
#### <a name="compilepackage"></a> 3.7.5 Creating a node-oracledb package from source code
2020-02-16 08:16:59 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#compilepackage )
2020-02-16 08:16:59 +08:00
2020-06-03 12:14:49 +08:00
### <a name="offline"></a> <a name="intermediateinstall"></a> 3.8 Node-oracledb Installation Without Internet Access
2018-02-09 16:55:52 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#offline )
2017-12-12 06:39:15 +08:00
2020-06-03 12:14:49 +08:00
#### <a name="winbins"></a> 3.8.1 Copying node-oracledb Binaries on Windows
2017-12-12 06:39:15 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#winbins )
2018-03-27 13:44:52 +08:00
2020-06-03 12:14:49 +08:00
### <a name="selfhost"></a> 3.9 Hosting your own node-oracledb Packages
2020-02-16 08:16:59 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#selfhost )
2021-05-29 16:06:47 +08:00
2020-06-03 12:14:49 +08:00
### <a name="docker"></a> 3.10 Using node-oracledb in Docker
2019-11-25 10:14:39 +08:00
2023-02-21 11:32:59 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#docker )
2018-12-07 13:31:23 +08:00
2020-06-25 07:38:09 +08:00
## <a name="installingoldvers"></a> <a name="installingv2"></a> <a name="installingv1"></a> 4. Installing Older Versions of Node-oracledb
2017-06-29 14:35:55 +08:00
2023-05-24 12:54:08 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#installingoldvers )
2017-12-12 06:39:15 +08:00
2019-08-14 19:48:50 +08:00
## <a name="troubleshooting"></a> 5. Troubleshooting Node-oracledb Installation Problems
2017-06-29 14:35:55 +08:00
2023-05-24 12:54:08 +08:00
[View latest documentation ](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting )
