Skip to content

Commit 5087862

Browse files
committed
Update installation migration section about compiler requirements
1 parent 572fab7 commit 5087862

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
[NAN](https://github.com/nodejs/nan).
1010
- Node.js 8.16 or Node.js 10.16, or higher, is required by this version of node-oracledb. Node.js 8.16, 10.16, 11.12 and 12 contain an important N-API performance fix.
1111
- N-API allows node-oracledb binaries to be portable between Node.js versions on a given operating system, subject to N-API compatibility.
12-
- Oracle Client libraries are still required at runtime.
12+
- Oracle Client libraries are still required at runtime. These can be from Oracle Instant Client, the full Oracle Client, or an Oracle Database installation.
1313
- The string representation of classes has changed to `[Object Object]` as a consequence of using N-API.
14-
- A C++11 compiler is no longer required when building from source code. The node-oracledb source code is now pure C.
14+
- The C compiler required for building from source code no longer needs C++11 compatibility. The node-oracledb source code is now pure C.
1515

1616
- Added support for Oracle Advanced Queuing (AQ) RAW queues, allowing
1717
String and Buffer messages to be used.

INSTALL.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ limitations under the License.
2020
## ===> *** Note: Go to [https://oracle.github.io/node-oracledb/INSTALL.html](https://oracle.github.io/node-oracledb/INSTALL.html) for production documentation ***
2121

2222
1. [Node-oracledb Overview](#overview)
23-
- 1.1 [Changes in node-oracledb version 4.0](#mig40)
24-
- 1.2 [Changes in node-oracledb version 3.1](#mig31)
25-
- 1.3 [Changes in node-oracledb version 3.0](#mig30)
26-
- 1.4 [Changes in node-oracledb version 2.0](#mig20)
23+
- 1.1 [Installation Changes in node-oracledb version 4.0](#mig40)
24+
- 1.2 [Installation Changes in node-oracledb version 3.1](#mig31)
25+
- 1.3 [Installation Changes in node-oracledb version 3.0](#mig30)
26+
- 1.4 [Installation Changes in node-oracledb version 2.0](#mig20)
2727
2. [Quick Start Node-oracledb Installation](#quickstart)
2828
3. [Node-oracledb Installation Instructions](#instructions)
2929
- 3.1 [Prerequisites](#prerequisites)
@@ -68,14 +68,17 @@ and versions of Node.js that the pre-built binaries are compatible
6868
with will change as the Node.js project evolves. The binaries are not
6969
guaranteed to be available or usable in your environment.
7070

71-
#### <a name="mig40"></a> 1.1 Changes in node-oracledb version 4.0
71+
#### <a name="mig40"></a> 1.1 Installation Changes in node-oracledb version 4.0
7272

7373
Node-oracledn 4.0 was refactored to use [N-API][53] version 2. On
7474
each operating system, a node-oracledb binary will work with a number
7575
of Node.js versions from Node.js 8.16 and Node.js 10.16 onwards,
7676
dependent on N-API compatibility.
7777

78-
#### <a name="mig31"></a> 1.1 Changes in node-oracledb version 3.1
78+
If compiling from source code, the compiler no longer needs C++11
79+
compatibility. The node-oracledb source code is now pure C.
80+
81+
#### <a name="mig31"></a> 1.1 Installion Changes in node-oracledb version 3.1
7982

8083
Pre-built binaries are now contained in the package downloaded from
8184
npm. This removes the previous internally executed step of
@@ -93,7 +96,7 @@ that `require('oracledb')` can succeed on machines that do not have
9396
Oracle Client libraries installed. See the [CHANGELOG][43] for more
9497
information.
9598

96-
#### <a name="mig30"></a> 1.2 Changes in node-oracledb version 3.0
99+
#### <a name="mig30"></a> 1.2 Installation Changes in node-oracledb version 3.0
97100

98101
Installation of node-oracledb binaries will now use the `npm config`
99102
proxy if it is set. However, due to known npm performance issues, it

0 commit comments

Comments
 (0)