Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
odnodn opened this issue Apr 23, 2025 · 1 comment

Comments

@odnodn
Copy link

odnodn commented Apr 23, 2025

  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 odnodn changed the title Update general comments and sections for macOS ARM64 binaries available since version 6.6 Update documentation's general comments and sections for macOS ARM64 binaries available since version 6.6 Apr 23, 2025
@sharadraju
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants