@@ -46,8 +46,6 @@ limitations under the License.
46
46
- 3.9 [ Hosting your own node-oracledb Packages] ( #selfhost )
47
47
- 3.10 [ Using node-oracledb in Docker] ( #docker )
48
48
4 . [ Installing Older Versions of Node-oracledb] ( #installingoldvers )
49
- - 4.1 [ Installing node-oracledb 2.x and 3.x] ( #installingv2 )
50
- - 4.2 [ Installing node-oracledb 1.x] ( #installingv1 )
51
49
5 . [ Troubleshooting Node-oracledb Installation Problems] ( #troubleshooting )
52
50
53
51
## <a name =" overview " ></a > 1. Node-oracledb Overview
@@ -58,11 +56,10 @@ The steps below create a Node.js installation for testing. Adjust the
58
56
steps for your environment.
59
57
60
58
This node-oracledb release has been tested with Node.js 10, 12 and 14 on 64-bit
61
- Oracle Linux, Windows and macOS Mojave 10.14. Note Node.js 10.16, or later is
62
- required. The add-on can also build on some 32-bit Linux, 32-bit Windows,
63
- Solaris and AIX environments, but these architectures have not been fully
64
- tested. Older versions of node-oracledb may work with older versions of
65
- Node.js.
59
+ Oracle Linux, Windows and macOS. Note Node.js 10.16, or later is required. The
60
+ add-on can also build on some 32-bit Linux, 32-bit Windows, Solaris and AIX
61
+ environments, but these architectures have not been fully tested. Older
62
+ versions of node-oracledb may work with older versions of Node.js.
66
63
67
64
Node-oracledb requires Oracle Client libraries version 11.2 or later, and
68
65
can connect to Oracle Database 9.2 or later, depending on the Oracle Client library
@@ -663,7 +660,7 @@ Questions and issues can be posted as [GitHub Issues][10].
663
660
664
661
Review the generic [ prerequisites] ( #prerequisites ) .
665
662
666
- The pre-built binaries were built on macOS Mojave, 10.14.6.
663
+ The pre-built binaries were built on macOS Mojave 10.14.6.
667
664
668
665
Oracle Instant Client libraries are required on macOS. Note that Oracle Instant
669
666
Client 19c and earlier are not supported on macOS Catalina 10.15: you will need
@@ -1540,6 +1537,8 @@ or your `package.json` would contain:
1540
1537
have a ` Dockerfile ` with steps to create a Docker image. Once created, the
1541
1538
image can be shared and run.
1542
1539
1540
+ Sample Dockerfiles for Oracle Linux are available on [ GitHub] [ 65 ] .
1541
+
1543
1542
#### Installing Node.js in Docker
1544
1543
1545
1544
If your ` Dockerfile ` uses Oracle Linux:
@@ -1551,14 +1550,13 @@ FROM oraclelinux:7-slim
1551
1550
Then you can install Node.js from [ yum.oracle.com] [ 46 ] using:
1552
1551
1553
1552
```
1554
- RUN yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
1555
- yum-config-manager --disable ol7_developer_EPEL && \
1553
+ RUN yum -y install oracle-nodejs-release-el7 && \
1556
1554
yum -y install nodejs && \
1557
1555
rm -rf /var/cache/yum
1558
1556
```
1559
1557
1560
- Alternatively you may prefer to use a [ Node.js image from
1561
- Docker Hub ] [ 56 ] , for example using:
1558
+ One alternative to Oracle Linux is to use a [ Node.js image from Docker Hub ] [ 56 ] ,
1559
+ for example using:
1562
1560
1563
1561
```
1564
1562
FROM node:12-buster-slim
@@ -1585,7 +1583,6 @@ install Instant Client. Three methods are shown below.
1585
1583
1586
1584
```
1587
1585
RUN yum -y install oracle-release-el7 && \
1588
- yum-config-manager --enable ol7_oracle_instantclient && \
1589
1586
yum -y install oracle-instantclient19.6-basiclite && \
1590
1587
rm -rf /var/cache/yum
1591
1588
```
@@ -1720,7 +1717,6 @@ If you use Oracle Linux, your `Dockerfile` will be like:
1720
1717
FROM oraclelinux:7-slim
1721
1718
1722
1719
RUN yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
1723
- yum-config-manager --disable ol7_developer_EPEL --enable ol7_oracle_instantclient && \
1724
1720
yum -y install nodejs oracle-instantclient19.6-basiclite && \
1725
1721
rm -rf /var/cache/yum
1726
1722
@@ -1767,7 +1763,7 @@ For either Dockerfile, the `package.json` is:
1767
1763
"myapp"
1768
1764
],
1769
1765
"dependencies": {
1770
- "oracledb" : "^4 "
1766
+ "oracledb" : "^5 "
1771
1767
},
1772
1768
"author": "Me",
1773
1769
"license": "UPL"
@@ -1827,55 +1823,31 @@ The output is like:
1827
1823
rows: [ { D: '24-Nov-2019 23:39' } ] }
1828
1824
```
1829
1825
1830
- ## <a name =" installingoldvers " ></a > 4. Installing Older Versions of Node-oracledb
1826
+ ## <a name =" installingoldvers " ></a > < a name = " installingv2 " ></ a > < a name = " installingv1 " ></ a > 4. Installing Older Versions of Node-oracledb
1831
1827
1832
- ### <a name =" installingv2 " ></a > 4.1 Installing node-oracledb 2.x and 3.x
1833
-
1834
- Pre-built node-oracledb 2 and 3 binaries are available for some platforms and
1828
+ Pre-built node-oracledb 3 and 4 binaries are available for some platforms and
1835
1829
Node.js versions. Review the [ release tags] [ 41 ] for availability. You can
1836
- compile the add-on for other platforms or Node.js versions.
1830
+ compile the add-on for other platforms or versions.
1831
+
1832
+ The node-oracledb 4.2 installation steps are in the [ version 4.2 INSTALL
1833
+ guide] [ 66 ] .
1837
1834
1838
1835
The node-oracledb 3.1 installation steps are in the [ version 3.1 INSTALL
1839
1836
guide] [ 55 ] .
1840
1837
1841
- The node-oracledb 3.0 installation steps are in the [ version 3.0 INSTALL
1842
- guide] [ 54 ] .
1843
-
1844
- The node-oracledb 2.x installation steps are in the [ version 2.x INSTALL
1845
- guide] [ 52 ]
1846
-
1847
- To get an old add-on you must explicitly use its version when installing:
1848
-
1849
- ```
1850
-
1851
- ```
1852
-
1853
- or your ` package.json ` could contain:
1854
-
1855
- ```
1856
- . . .
1857
- "dependencies": {
1858
- "oracledb": "2.3.0"
1859
- },
1860
- . . .
1861
- ```
1862
-
1863
- ### <a name =" installingv1 " ></a > 4.2 Installing node-oracledb 1.x
1864
-
1865
- The node-oracledb 1.x installation steps are in the [ version 1.x
1866
- INSTALL guide] [ 32 ] . This version always requires compilation. To get
1867
- an old add-on you must explicitly use its version when installing:
1838
+ To get an old add-on you must explicitly use its version when installing, for
1839
+ example:
1868
1840
1869
1841
```
1870
- npm install oracledb@1.13.1
1842
+ npm install oracledb@4.2.0
1871
1843
```
1872
1844
1873
1845
or your ` package.json ` could contain:
1874
1846
1875
1847
```
1876
1848
. . .
1877
1849
"dependencies": {
1878
- "oracledb": "1.13.1 "
1850
+ "oracledb": "4.2.0 "
1879
1851
},
1880
1852
. . .
1881
1853
```
@@ -1911,8 +1883,9 @@ If `npm install oracledb` fails:
1911
1883
1912
1884
If creating a connection fails:
1913
1885
1914
- - If you got * DPI-1047: Cannot locate an Oracle Client library* ,
1915
- then review any messages and the installation instructions.
1886
+ - If you got * DPI-1047: Cannot locate an Oracle Client library* , then review any
1887
+ messages, the installation instructions, and see [ Initializing
1888
+ Node-oracledb] [ 17 ] .
1916
1889
1917
1890
- If you got * DPI-1072: the Oracle Client library version is unsupported* , then
1918
1891
review the installation requirements. Node-oracledb needs Oracle client
@@ -1974,7 +1947,6 @@ Issues and questions about node-oracledb can be posted on [GitHub][10] or
1974
1947
[ 29 ] : https://www.microsoft.com/en-us/download/details.aspx?id=3387
1975
1948
[ 30 ] : https://www.oracle.com/database/technologies/instant-client/aix-ppc64-downloads.html
1976
1949
[ 31 ] : https://www.oracle.com/database/technologies/instant-client/solx8664-downloads.html
1977
- [ 32 ] : https://github.com/oracle/node-oracledb/blob/v1.13.1/INSTALL.md
1978
1950
[ 40 ] : https://github.com/oracle/node-oracledb/tags
1979
1951
[ 41 ] : https://github.com/oracle/node-oracledb/releases
1980
1952
[ 42 ] : https://oracle.github.io/node-oracledb/doc/api.html#migratev1v2
@@ -1987,9 +1959,7 @@ Issues and questions about node-oracledb can be posted on [GitHub][10] or
1987
1959
[ 49 ] : https://join.slack.com/t/node-oracledb/shared_invite/enQtNDU4Mjc2NzM5OTA2LWMzY2ZlZDY5MDdlMGZiMGRkY2IzYjI5OGU4YTEzZWM5YjQ3ODUzMjcxNWQyNzE4MzM5YjNkYjVmNDk5OWU5NDM
1988
1960
[ 50 ] : http://yum.oracle.com/repo/OracleLinux/OL6/oracle/instantclient/x86_64/index.html
1989
1961
[ 51 ] : http://yum.oracle.com/repo/OracleLinux/OL7/oracle/instantclient/x86_64/index.html
1990
- [ 52 ] : https://github.com/oracle/node-oracledb/blob/v2.3.0/INSTALL.md
1991
1962
[ 53 ] : https://nodejs.org/api/n-api.html
1992
- [ 54 ] : https://github.com/oracle/node-oracledb/blob/v3.0.1/INSTALL.md
1993
1963
[ 55 ] : https://github.com/oracle/node-oracledb/blob/v3.1.2/INSTALL.md
1994
1964
[ 56 ] : https://hub.docker.com/_/node/
1995
1965
[ 57 ] : https://oracle.github.io/node-oracledb/doc/api.html#connectionadb
@@ -2000,3 +1970,5 @@ Issues and questions about node-oracledb can be posted on [GitHub][10] or
2000
1970
[ 62 ] : https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-81D364CE-326D-4B3C-8C82-F468FF1AF30C
2001
1971
[ 63 ] : https://github.com/oracle/node-oracledb/tree/master/examples/example.js
2002
1972
[ 64 ] : https://oracle.github.io/node-oracledb/doc/api.html#odbinitoracleclient
1973
+ [ 65 ] : https://github.com/oracle/docker-images/tree/master/OracleLinuxDevelopers/oraclelinux7/nodejs
1974
+ [ 66 ] : https://github.com/oracle/node-oracledb/blob/v4.2.0/INSTALL.md
0 commit comments