Skip to content

Commit b89536d

Browse files
committed
Mention using a BAT file to set PATH
1 parent 377acf3 commit b89536d

File tree

1 file changed

+34
-14
lines changed

1 file changed

+34
-14
lines changed

INSTALL.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,9 @@ node example.js
772772

773773
### <a name="instwin"></a> 3.6 Node-oracledb Installation on Windows with Instant Client ZIP files
774774

775-
Follow these steps if your database is on a remote machine.
775+
Follow these steps if your database is on a remote machine, or if you
776+
already have Oracle software installed but you want node-oracledb to
777+
use a different version of the libraries.
776778

777779
Questions and issues can be posted as [GitHub Issues][10].
778780

@@ -822,24 +824,42 @@ Source Code](#github).
822824
#### 3.6.4 Install the free Oracle Instant Client ZIP
823825

824826
Download the free 64-bit Instant Client **Basic** ZIP file from
825-
[Oracle Technology Network][25]. (The 32-bit Instant Client is
826-
[here][26]).
827+
[Oracle Technology Network][25]. If your Node.js architecture is
828+
32-bit, then use the [32-bit Instant Client][26] instead.
829+
830+
- Unzip the ZIP file into a directory that is accessible to your
831+
application. For example unzip
832+
`instantclient-basic-windows.x64-18.3.0.0.0dbru.zip` to
833+
`C:\oracle\instantclient_18_3`.
834+
835+
- Add this directory to the `PATH` environment variable. For example
836+
on Windows 7, update `PATH` in Control Panel -> System -> Advanced
837+
System Settings -> Advanced -> Environment Variables -> System
838+
variables -> `PATH`. The Instant Client directory must occur in
839+
`PATH` before any other Oracle directories.
840+
841+
Restart any open command prompt windows.
827842

828-
- Extract `instantclient-basic-windows.x64-18.3.0.0.0dbru.zip`
843+
To avoid interfering with existing tools that require other Oracle
844+
Client versions then, instead of updating the system-wide `PATH`
845+
variable, you may prefer to write a batch file that sets `PATH`, for
846+
example:
847+
848+
```
849+
REM mynode.bat
850+
SET PATH=C:\oracle\instantclient_18_3;%PATH%
851+
node %*
852+
```
829853

830-
- Add its directory to `PATH`. For example on Windows 7, update
831-
`PATH` in Control Panel -> System -> Advanced System Settings ->
832-
Advanced -> Environment Variables -> System variables -> `PATH` and
833-
add your path, such as `C:\oracle\instantclient_18_3`.
854+
Invoke this batch file everytime you want to run Node.js.
834855

835-
If you have multiple versions of Oracle libraries installed, make
836-
sure the desired version occurs first in `PATH` before you run
837-
Node.js.
856+
Alternatively use `SET` to change your `PATH` in each command prompt
857+
window before you run node.
838858

839-
Alternatively move the unzipped Instant Client files to
859+
Another option is to move the unzipped Instant Client files to
840860
`node_modules\oracledb\build\Release` so the DLLs and other files
841-
are in the same directory as the `oracledb.node` binary. If you do
842-
this, then `PATH` does not need to be set.
861+
are in the same directory as the `oracledb*.node` binaries. If you
862+
do this, then `PATH` does not need to be set.
843863

844864
#### 3.6.5 Optionally create the default Oracle Client configuration directory
845865

0 commit comments

Comments
 (0)