Skip to content

Commit a2f97f7

Browse files
committed
Update Migration documentation
1 parent d94817c commit a2f97f7

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

doc/api.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13559,9 +13559,30 @@ When upgrading from node-oracledb version 3.0 to version 3.1:
1355913559
1356013560
### <a name="migratev31v40"></a> 32.5 Migrating from node-oracledb 3.1 to node-oracledb 4.0
1356113561
13562-
- Review the [CHANGELOG][83].
13562+
When upgrading from node-oracledb version 3.1 to version 4.0:
13563+
13564+
- Review the [CHANGELOG][83] and take advantage of new features.
13565+
13566+
- Update Node.js, if necessary. Node-oracledb 4.0 requires
13567+
- Node.js 8.16 or higher
13568+
- Node.js 10.16, or higher
13569+
- Node.js 12
13570+
13571+
- Review error handling. Some errors have changed. All exceptions
13572+
are now passed through the error callback.
13573+
13574+
- Code that relied on numeric values for the [node-oracledb Type
13575+
Constants](#oracledbconstantsnodbtype) and [Oracle Database Type
13576+
Constants](#oracledbconstantsdbtype) will need updating. Use the
13577+
constant names instead of their values.
13578+
13579+
- To view node-oracledb class information, update code to use `Object.getPrototypeOf()`.
13580+
13581+
- Optionally migrate [`outFormat`](#propdboutformat) constants to the
13582+
new, preferred names
13583+
[`OUT_FORMAT_ARRAY`](#oracledbconstantsoutformat) and
13584+
[`OUT_FORMAT_OBJECT`](#oracledbconstantsoutformat).
1356313585
13564-
All exceptions are now passed through the error callback.
1356513586
1356613587
[1]: https://www.npmjs.com/package/oracledb
1356713588
[2]: https://oracle.github.io/node-oracledb/INSTALL.html

0 commit comments

Comments
 (0)