Skip to content

Commit 5a2d97f

Browse files
committed
Update some versions
1 parent 5225c31 commit 5a2d97f

File tree

1 file changed

+40
-37
lines changed

1 file changed

+40
-37
lines changed

INSTALL.md

Lines changed: 40 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# Installing node-oracledb Version 4.0
23

34
*Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved.*
@@ -70,10 +71,11 @@ guaranteed to be available or usable in your environment.
7071

7172
#### <a name="mig40"></a> 1.1 Installation Changes in node-oracledb version 4.0
7273

73-
Node-oracledn 4.0 was refactored to use [N-API][53] version 2. On
74+
Node-oracledb 4.0 was refactored to use [N-API][53] version 2. On
7475
each operating system, a node-oracledb binary will work with a number
7576
of Node.js versions from Node.js 8.16 and Node.js 10.16 onwards,
76-
dependent on N-API compatibility.
77+
dependent on N-API compatibility. This means that when upgrading
78+
Node.js, you may not need to reinstall node-oracledb.
7779

7880
If compiling from source code, the compiler no longer needs C++11
7981
compatibility. The node-oracledb source code is now pure C.
@@ -346,7 +348,15 @@ package contents are identical in both channels. Alternatively,
346348
multiple versions of Instant Client RPMs are available from [Oracle
347349
Technology Network][12].
348350

349-
[Install Instant Client Basic][13] with sudo or as the root user:
351+
[Install Instant Client Basic][13] with sudo or as the root user,
352+
either directly from yum.oracle.com:
353+
354+
```
355+
sudo yum -y install oracle-release-el7
356+
sudo yum -y install oracle-instantclient19.3-basic
357+
```
358+
359+
Or from a downloaded file:
350360

351361
```
352362
sudo yum install oracle-instantclient19.3-basic-19.3.0.0.0-1.x86_64.rpm
@@ -677,7 +687,7 @@ Questions and issues can be posted as [GitHub Issues][10].
677687

678688
Review the generic [prerequisites](#prerequisites).
679689

680-
The pre-built binaries were built on macOS High Sierra, 10.13.6
690+
The pre-built binaries were built on macOS Mojave, 10.14.5.
681691

682692
Oracle Instant Client libraries are required on macOS. There is no
683693
native Oracle Database for macOS but one can easily be run in a Linux
@@ -720,22 +730,22 @@ and unzip it, for example:
720730

721731
```
722732
mkdir -p /opt/oracle
723-
unzip instantclient-basic-macos.x64-12.2.0.1.0.zip
733+
unzip instantclient-basic-macos.x64-18.1.0.0.0.zip
724734
```
725735

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

729739
```
730740
mkdir ~/lib
731-
ln -s instantclient_12_2/libclntsh.dylib ~/lib/
741+
ln -s instantclient_18_1/libclntsh.dylib ~/lib/
732742
```
733743

734744
Alternatively, copy the required OCI libraries, for example:
735745

736746
```
737747
mkdir ~/lib
738-
cp instantclient_12_2/{libclntsh.dylib.12.1,libclntshcore.dylib.12.1,libons.dylib,libnnz12.dylib,libociei.dylib} ~/lib/
748+
cp instantclient_18_1/{libclntsh.dylib.18.1,libclntshcore.dylib.18.1,libons.dylib,libnnz18.dylib,libociei.dylib} ~/lib/
739749
```
740750

741751
For Instant Client 11.2, the OCI libraries must be copied. For example:
@@ -805,7 +815,7 @@ install software.
805815

806816
#### 3.6.2 Install Node.js
807817

808-
Install the 64-bit Node.js MSI (e.g. node-v6.11.0-x64.msi) from
818+
Install the 64-bit Node.js MSI (e.g. node-v10.16.0-x86.msi) from
809819
[nodejs.org][11]. Make sure the option to add the Node and npm
810820
directories to the path is selected.
811821

@@ -844,8 +854,8 @@ Download the free 64-bit Instant Client **Basic** ZIP file from
844854

845855
- Unzip the ZIP file into a directory that is accessible to your
846856
application. For example unzip
847-
`instantclient-basic-windows.x64-18.3.0.0.0dbru.zip` to
848-
`C:\oracle\instantclient_18_3`.
857+
` instantclient-basic-windows.x64-19.3.0.0.0dbru.zip` to
858+
`C:\oracle\instantclient_19_3`.
849859

850860
- Add this directory to the `PATH` environment variable. For example
851861
on Windows 7, update `PATH` in Control Panel -> System -> Advanced
@@ -862,7 +872,7 @@ Download the free 64-bit Instant Client **Basic** ZIP file from
862872

863873
```
864874
REM mynode.bat
865-
SET PATH=C:\oracle\instantclient_18_3;%PATH%
875+
SET PATH=C:\oracle\instantclient_19_3;%PATH%
866876
node %*
867877
```
868878

@@ -893,6 +903,7 @@ Then set the environment variable `TNS_ADMIN` to that directory name.
893903
#### <a name="winredists"> </a> 3.6.6 Install the Visual Studio Redistributables
894904

895905
The `PATH` variable needs to include the appropriate VS Redistributable:
906+
- Oracle client 19 requires the [Visual Studio 2017 Redistributable][27].
896907
- Oracle client 18 and 12.2 require the [Visual Studio 2013 Redistributable][27].
897908
- Oracle client 12.1 requires the [Visual Studio 2010 Redistributable][27].
898909
- Oracle client 11.2 requires the [Visual Studio 2005 Redistributable][29].
@@ -953,7 +964,7 @@ install software.
953964

954965
#### 3.7.2 Install Node.js
955966

956-
Install the 64-bit Node.js MSI (e.g. node-v10.15.3-x64.msi) from
967+
Install the 64-bit Node.js MSI (e.g. node-v10.16.0-x64.msi) from
957968
[nodejs.org][11]. Make sure the option to add the Node and npm
958969
directories to the path is selected.
959970

@@ -1032,18 +1043,18 @@ Python 2.7 is needed by node-gyp.
10321043
#### 3.9.2 Install Node.js
10331044

10341045
Download [Node.js][11] for AIX on Power Systems. For
1035-
example, if you downloaded version 6.11.0 you could install Node.js
1046+
example, if you downloaded version 10.16.0 you could install Node.js
10361047
into `/opt`:
10371048

10381049
```
10391050
cd /opt
1040-
gunzip -c node-v6.11.0-aix-ppc64.tar.gz | tar -xvf -
1051+
gunzip -c node-v10.16.0-aix-ppc64.tar.gz | tar -xvf -
10411052
```
10421053

10431054
Set `PATH` to include Node.js:
10441055

10451056
```
1046-
export PATH=/opt/node-v6.11.0-aix-ppc64/bin:$PATH
1057+
export PATH=/opt/node-v10.16.0-aix-ppc64/bin:$PATH
10471058
```
10481059

10491060
#### 3.9.3 Install the add-on
@@ -1085,15 +1096,15 @@ and extract it into a directory that is accessible to your
10851096
application, for example `/opt/oracle`:
10861097

10871098
```
1088-
unzip instantclient-basic-aix.ppc64-12.2.0.1.0.zip
1099+
unzip instantclient-basic-aix.ppc64-19.3.0.0.0dbru.zip
10891100
mkdir -p /opt/oracle
1090-
mv instantclient_12_2 /opt/oracle
1101+
mv instantclient_19_3 /opt/oracle
10911102
```
10921103

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

10951106
```
1096-
export LIBPATH=/opt/oracle/instantclient_12_2:$LIBPATH
1107+
export LIBPATH=/opt/oracle/instantclient_19_3:$LIBPATH
10971108
```
10981109

10991110
#### 3.9.5 Optionally create the default Oracle Client configuration directory
@@ -1104,7 +1115,7 @@ If you intend to co-locate optional Oracle configuration files such as
11041115
`network/admin` subdirectory. Create this if needed. For example:
11051116

11061117
```
1107-
sudo mkdir -p /opt/oracle/instantclient_12_2/network/admin
1118+
sudo mkdir -p /opt/oracle/instantclient_19_3/network/admin
11081119
```
11091120

11101121
This is the default Oracle configuration directory for applications
@@ -1206,13 +1217,13 @@ application, for example `/opt/oracle`:
12061217

12071218
```
12081219
cd /opt/oracle
1209-
unzip instantclient-basic-solaris.x64-12.2.0.1.0.zip
1220+
unzip instantclient-basic-solaris.x64-18.3.0.0.0dbru.zip
12101221
```
12111222

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

12141225
```
1215-
export LD_LIBRARY_PATH_64=/opt/oracle/instantclient_12_2:$LD_LIBRARY_PATH_64
1226+
export LD_LIBRARY_PATH_64=/opt/oracle/instantclient_18_3:$LD_LIBRARY_PATH_64
12161227
```
12171228

12181229
#### 3.9.5 Optionally create the default Oracle Client configuration directory
@@ -1223,7 +1234,7 @@ If you intend to co-locate optional Oracle configuration files such as
12231234
`network/admin` subdirectory. Create this if needed. For example:
12241235

12251236
```
1226-
mkdir -p /opt/oracle/instantclient_12_2/network/admin
1237+
mkdir -p /opt/oracle/instantclient_18_3/network/admin
12271238
```
12281239

12291240
This is the default Oracle configuration directory for applications
@@ -1398,10 +1409,11 @@ versions do not have to be the same on different computers, but
13981409
node-oracledb behavior and features may then differ.
13991410

14001411
The destination computer's `PATH` needs to include Visual Studio
1401-
Redistributables. If you have Oracle client 18 or 12.2, install the Visual
1402-
Studio 2013 Redistributable. For Oracle client 12.1 install the Visual
1403-
Studio 2010 Redistributable. For Oracle client 11.2 install the Visual
1404-
Studio 2005 Redistributable.
1412+
Redistributables. If you have Oracle client 19 install the Visual
1413+
Studio 2017 Redistributable. If you have Oracle client 18 or 12.2,
1414+
install the Visual Studio 2013 Redistributable. For Oracle client
1415+
12.1 install the Visual Studio 2010 Redistributable. For Oracle
1416+
client 11.2 install the Visual Studio 2005 Redistributable.
14051417

14061418
You can also find out the Redistributable required by locating the
14071419
library `OCI.DLL` on the source computer and running:
@@ -1574,15 +1586,6 @@ If `npm install oracledb` fails:
15741586
- Try running `npm cache clean -f` and deleting the
15751587
`node_modules/oracledb` directory.
15761588

1577-
If `require('oracledb')` fails:
1578-
1579-
- Do you have multiple copies of Node.js installed? Did the correct
1580-
`npm` and `node-gyp` get invoked?
1581-
1582-
- Did you get *Error: Module version mismatch* or *Error: Module
1583-
did not self-register*? You must rebuild node-oracledb when you
1584-
upgrade Node.js.
1585-
15861589
If creating a connection fails:
15871590

15881591
- If you got *DPI-1047: Cannot locate an Oracle Client library*,
@@ -1608,8 +1611,8 @@ If creating a connection fails:
16081611
expected version first in `PATH` (on Windows) or `LD_LIBRARY_PATH`
16091612
(on Linux)?
16101613

1611-
- On macOS, did you install Oracle Instant Client in `~/lib` or
1612-
`/usr/local/lib`?
1614+
- On macOS, did you install Oracle Instant Client libraries in `~/lib`
1615+
or `/usr/local/lib`?
16131616

16141617
Issues and questions about node-oracledb can be posted on [GitHub][10] or
16151618
[Slack][48] ([link to join Slack][49]).

0 commit comments

Comments
 (0)