Skip to content

Commit 6ac51dd

Browse files
committed
Add migration information
1 parent ed8b816 commit 6ac51dd

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

INSTALL.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ 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 3.0](#mig30)
24+
- 1.2 [Changes in node-oracledb version 2.0](#mig20)
2325
2. [Quick Start Node-oracledb Installation](#quickstart)
2426
3. [Node-oracledb Installation Instructions](#instructions)
2527
- 3.1 [Prerequisites](#prerequisites)
@@ -62,7 +64,19 @@ and versions of Node.js that the pre-built binaries are compatible
6264
with will change as the Node.js project evolves. The binaries are not
6365
guaranteed to be available or usable in your environment.
6466

65-
#### Changes in node-oracledb version 2.0
67+
#### <a name="mig30"></a> 1.1 Changes in node-oracledb version 3.0
68+
69+
Installation of node-oracledb binaries will now use the `npm config`
70+
proxy if it is set. However, due to known npm performance issues, it
71+
is recommended to use environment variables like `https_proxy`
72+
instead, since these will be used in preference to the npm
73+
configuration.
74+
75+
The node-oracledb installer now supports basic proxy authentication.
76+
77+
See the [CHANGELOG][43] and [Migrating from Previous node-oracledb
78+
Releases][47] for more information about node-oracledb 3.0.
79+
#### <a name="mig20"></a> 1.2 Changes in node-oracledb version 2.0
6680

6781
In node-oracledb version 2.0, pre-built binaries are now available for
6882
some environments.
@@ -1684,3 +1698,4 @@ Questions and issues can be posted as [GitHub Issues][10].
16841698
[44]: https://oracle.github.io/node-oracledb/doc/api.html
16851699
[45]: https://www.youtube.com/watch?v=WDJacg0NuLo
16861700
[46]: http://yum.oracle.com/oracle-linux-nodejs.html
1701+
[47]: https://oracle.github.io/node-oracledb/doc/api.html#migrate

doc/api.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ limitations under the License.
298298
25. [Migrating from Previous node-oracledb Releases](#migrate)
299299
- 25.1 [Migrating from node-oracledb 1.13 to node-oracledb 2.0](#migratev1v2)
300300
- 25.2 [Migrating from node-oracledb 2.0 to node-oracledb 2.1](#migratev20v21)
301+
- 25.3 [Migrating from node-oracledb 2.3 to node-oracledb 3.0](#migratev23v30)
301302

302303
## <a name="apimanual"></a> NODE-ORACLEDB API MANUAL
303304

@@ -8891,6 +8892,26 @@ When upgrading from node-oracledb version 2.0 to version 2.1:
88918892
- Stop passing a callback.
88928893
- Optionally pass an error.
88938894
8895+
### <a name="migratev23v30"></a> 25.3 Migrating from node-oracledb 2.3 to node-oracledb 3.0
8896+
8897+
When upgrading from node-oracledb version 2.3 to version 3.0:
8898+
8899+
- Review the [CHANGELOG][83]. Implement new features such as the
8900+
[`pool.close()`](#poolclose) `drainTime` parameter.
8901+
8902+
- If using a connection pool and Oracle Client libraries 12.2 or
8903+
later, tune [`oracledb.poolPingInterval`](#propdbpoolpinginterval),
8904+
since this property is now additionally used with these versions of
8905+
Oracle Client.
8906+
8907+
- Before migrating, ensure your application works with the [Connection
8908+
Pool Queue](#connpoolqueue), since this mode is always enabled in
8909+
node-oracledb 3.0 and the value of
8910+
[`oracledb.queueRequests`](#propdbqueuerequests) is ignored.
8911+
8912+
- Change code that relied on unused properties in objects such as the
8913+
`execute()` result being set to `undefined`. These properties are
8914+
no longer set in node-oracledb 3.
88948915
88958916
[1]: https://www.npmjs.com/package/oracledb
88968917
[2]: https://oracle.github.io/node-oracledb/INSTALL.html

0 commit comments

Comments
 (0)