node-oracledb icon indicating copy to clipboard operation
node-oracledb copied to clipboard

Update documentation's general comments and sections for macOS ARM64 binaries available since version 6.6

Open odnodn opened this issue 8 months ago • 1 comments

  1. What is the link to the documentation section that needs improving? https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#installing-node-js-and-node-oracledb-on-apple-macos

  2. Describe the confusion sInce node-oracledb version 6.6 binaries for macOS arm64 are provided (no compilation from source necessary any longer), the documentation still mentions only existence of included binaries for mac intel.

  3. Suggest changes that would help

Pre-built ‘Thick’ mode binaries for common architectures (Windows 64-bit, Linux x86_64, Linux ARM (aarch64), and macOS Intel) are included in the node-oracledb installation as a convenience

should be

Pre-built ‘Thick’ mode binaries for common architectures (Windows 64-bit, Linux x86_64, Linux ARM (aarch64), and macOS Intel 🔴 AND macOS ARM64 🔴 ) are included in the node-oracledb installation as a convenience

AND

2.5.3. Install Oracle Client to use Thick Mode By default, the node-oracledb driver is a pure JavaScript module that runs in a Thin mode connecting directly to Oracle Database so no further installation steps are required. However, to use additional node-oracledb features available in Thick mode, you need to install Oracle Client libraries. Thick mode uses a binary add-on installed with node-oracledb that loads these libraries. This binary is available for macOS Intel only.

should rather be

2.5.3. Install Oracle Client to use Thick Mode By default, the node-oracledb driver is a pure JavaScript module that runs in a Thin mode connecting directly to Oracle Database so no further installation steps are required. However, to use additional node-oracledb features available in Thick mode, you need to install Oracle Client libraries. Thick mode uses a binary add-on installed with node-oracledb that loads these libraries. This binary is available for macOS Intel 🔴 AND macOS ARM64 since node-oracledb version 6.6 🔴.

odnodn avatar Apr 23 '25 19:04 odnodn

Thank you @odnodn for bringing this up. We will correct this in the next version

sharadraju avatar Apr 24 '25 05:04 sharadraju

Fixed in node-oracledb 6.9 documentation.

sharadraju avatar Jul 18 '25 14:07 sharadraju