Final Doc updates for 7.0.0 release

Author: sharadraju

README.md

@@ -1,12 +1,10 @@
-# node-oracledb version 7.0.0-dev <img src="https://img.shields.io/npm/v/oracledb.svg" alt="oracledb"/>  <img src="https://img.shields.io/npm/dm/oracledb.svg" alt="oracledb"/>
-
-**This release is under development and information may be incomplete**
+# node-oracledb version 7.0.0 <img src="https://img.shields.io/npm/v/oracledb.svg" alt="oracledb"/>  <img src="https://img.shields.io/npm/dm/oracledb.svg" alt="oracledb"/>
 
 The node-oracledb add-on for Node.js powers high performance Oracle Database
 applications.  Applications can be written in TypeScript, or directly in
 JavaScript.
 
-Use node-oracledb 7.0.0-dev to connect Node.js 14.17, or later, to Oracle
+Use node-oracledb 7.0.0 to connect Node.js 14.17, or later, to Oracle
 Database.  Older versions of node-oracledb may work with older versions of
 Node.js.
 

doc/api.md

@@ -1738,55 +1738,55 @@ The input value or variable to be used for an IN or IN OUT bind variable.
 
 ### <a name="extauth"></a> 17.4 External Authentication
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#extauth)
 
 ### <a name="tokenbasedauthentication"></a> 17.5 Token-Based Authentication
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#tokenbasedauthentication)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#tokenbasedauthentication)
 
 #### <a name="oauthtokenbasedauthentication"></a> 17.5.1 OAuth 2.0 Token-Based Authentication
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#oauthtokenbasedauthentication)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#oauthtokenbasedauthentication)
 
 ##### <a name="oauthtokengeneration"></a> 17.5.1.1 OAuth 2.0 Token Generation
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#oauthtokengeneration)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#oauthtokengeneration)
 
 ##### <a name="oauthstandalone"></a> 17.5.1.2 OAuth 2.0 Standalone Connections
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#oauthstandalone)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#oauthstandalone)
 
 ##### <a name="oauthpool"></a> 17.5.1.3 OAuth 2.0 Connection Pooling
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#oauthpool)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#oauthpool)
 
 ##### <a name="oauthconnectstring"></a> 17.5.1.4 OAuth 2.0 Connection Strings
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#oauthconnectstring)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#oauthconnectstring)
 
 #### <a name="tokenbasedauth"></a> <a name="iamtokenbasedauthentication"></a> 17.5.2 IAM Token-Based Authentication
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#iamtokenbasedauthentication)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#iamtokenbasedauthentication)
 
 ##### <a name="tokengen"></a> <a name="iamtokengeneration"></a> 17.5.2.1 IAM Token Generation
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#iamtokengeneration)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#iamtokengeneration)
 
 ##### <a name="tokenread"></a> <a name="iamtokenextraction"></a> 17.5.2.2 IAM Token and Private Key Extraction
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#iamtokenextraction)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#iamtokenextraction)
 
 ##### <a name="tokenbasedstandaloneconn"></a> <a name="iamstandalone"></a> 17.5.2.3 IAM Standalone Connections
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#iamstandalone)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#iamstandalone)
 
 ##### <a name="settingpooltokens"></a> <a name="tokenbasedpool"></a> <a name="iampool"></a> 17.5.2.4 IAM Connection Pooling
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#iampool)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#iampool)
 
 ##### <a name="tokenbasedconnstrings"></a> <a name="iamconnectstring"></a> 17.5.2.5 IAM Connection Strings
 
-[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#iamconnectstring)
+[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/authentication_methods.html#iamconnectstring)
 
 ### <a name="drcp"></a> 17.6 Database Resident Connection Pooling (DRCP)
 

doc/src/api_manual/connection.rst

@@ -1375,15 +1375,6 @@ Connection Methods
           - .. _propexecobjpojo:
 
             Overrides :attr:`oracledb.dbObjectAsPojo`.
-        * - ``extendedMetaData``
-          - Boolean
-          - .. _propexecextendedmetadata:
-
-            Overrides :attr:`oracledb.extendedMetaData`.
-
-            .. desupported:: 6.0
-
-            Extended metadata is now always returned.
         * - ``fetchArraySize``
           - Number
           - .. _propexecfetcharraysize:

doc/src/api_manual/oracledb.rst

@@ -989,28 +989,6 @@ Each of the configuration properties is described below.
         const oracledb = require('oracledb');
         oracledb.events = false;
 
-.. attribute:: oracledb.extendedMetaData
-
-    .. desupported:: 6.0
-
-    Extended metadata is now always returned
-
-    .. versionadded:: 1.10
-
-    This property is a boolean that determines whether additional metadata is
-    available for queries and for REF CURSORs returned from PL/SQL blocks.
-
-    The default value for ``extendedMetaData`` is *false*. With this value,
-    the :ref:`result.metaData <execmetadata>` and :attr:`resultSet.metaData`
-    objects only include column names.
-
-    If ``extendedMetaData`` is *true* then ``metaData`` will contain
-    additional attributes. These are listed in :ref:`Result Object
-    Properties <execmetadata>`.
-
-    This property may be overridden in an :ref:`execute() <executeoptions>`
-    call.
-
 .. attribute:: oracledb.externalAuth
 
     This property is a boolean value. If this property is *true* in
@@ -2116,24 +2094,6 @@ Oracledb Methods
             .. versionchanged:: 5.5
 
                 The ``accessToken`` property was extended to allow OAuth 2.0 token-based authentication in node-oracledb 5.5. For OAuth 2.0, the property should be a string, or a callback. For node-oracledb Thick mode, Oracle Client libraries 19.15 (or later), or 21.7 (or later) must be used. The callback usage supports both OAuth 2.0 and IAM token-based authentication.
-        * - ``accessTokenCallback``
-          - Object
-          - NA
-          - .. _createpoolpoolattrsaccesstokencallback:
-
-            This optional attribute is a Node.js callback function. It gets called by the connection pool if the pool needs to grow and create new connections but the current token has expired.
-
-            The callback function must return a JavaScript object with attributes ``token`` and ``privateKey`` for IAM. See :ref:`Connection Pool Creation with Access Tokens for IAM <iampool>`.
-
-            .. versionadded:: 5.4
-
-            It should be used with Oracle Client libraries 19.14 (or later), or 21.5 (or later).
-
-            .. deprecated:: 5.5
-
-            .. desupported:: 6.0
-
-            Use :ref:`accessToken <createpoolpoolattrsaccesstoken>` with a callback instead.
         * - ``accessTokenConfig``
           - Object
           - Both

doc/src/release_notes.rst

@@ -48,8 +48,8 @@ Common Changes
 #)  Added support for :ref:`AWS Secrets Manager <awssecretsmanager>`
     Centralized Configuration Provider.
 
-#)  :ref:`Token-based Authentication <tokenbasedauthentication>` can now
-    include proxy session users by supplying user name inside square brackets
+#)  Enabled :ref:`Token-based Authentication <tokenbasedauthentication>` with
+    proxy session users by supplying proxy user name inside square brackets
     (for example, ``user: "[session_user]"``) alongside an authentication
     token when using external authentication.
 
@@ -75,7 +75,7 @@ Common Changes
     See `Issue #1771 <https://github.com/oracle/node-oracledb/issues/1771>`__.
 
 #)  Fixed issue to generate the correct SSL_SERVER_CERT_DN entry from an
-    Easy Connect string.
+    :ref:`Easy Connect string <easyconnect>`.
     See `Issue #1772 <https://github.com/oracle/node-oracledb/issues/1772>`__
     (Slawomir Osoba).
 
@@ -86,21 +86,26 @@ Common Changes
     :attr:`lob.pieceSize` properties return `undefined` for a closed
     :ref:`LOB object <lobclass>`.
 
-#)  Fixed an issue where SQL statements were not included in OpenTelemetry
+#)  Fixed issue where SQL statements were not included in OpenTelemetry
     trace spans for :meth:`connection.executeMany()`.
 
 #)  Internal code refactoring to optimize handling of
     :ref:`LOB object <lobclass>` methods and attributes.
 
+#)  Hardened protocol and network handling code by introducing security
+    guardrails for secure AI usage.
+
+#)  Multiple documentation and test updates and improvements.
+
 Thin Mode Changes
 +++++++++++++++++
 
 #)  Added support for :ref:`Direct Path Loads <directpathloads>`.
 
 #)  Added support for Oracle AI Database 26ai :ref:`Pipelining <pipelining>`.
 
-#)  Added :meth:`conn.setEndUserSecurityContext()` and
-    :meth:`conn.clearEndUserSecurityContext()` methods to the
+#)  Added :meth:`connection.setEndUserSecurityContext()` and
+    :meth:`connection.clearEndUserSecurityContext()` methods to the
     :ref:`Connection <connectionclass>`.
 
 #)  Fixed bug to close the socket when ``NJS-138`` error is thrown.
@@ -133,16 +138,17 @@ Thin Mode Changes
 Thick Mode Changes
 ++++++++++++++++++
 
-#)  Fixed potential crash when multiple implicit resultsets are closed.
+#)  Fixed potential crash when multiple
+    :ref:`implicit resultsets <implicitresults>` are closed.
 
-#)  Improved sparse vector handling so that empty sparse vectors can be bound
-    and fetched without raising ORA errors.
+#)  Improved :ref:`sparse vector <sparsevectors>` handling so that empty
+    sparse vectors can be bound and fetched without raising ORA errors.
 
-#)  Addressed potential memory leak issues for resultsets, token callbacks and
-    Advanced Queuing (AQ).
+#)  Addressed potential memory leak issues for resultsets, token callbacks
+    and Advanced Queuing (AQ).
 
-#)  Added guardrails against buffer overflows while fetching data from SODA
-    documents.
+#)  Added guardrails against buffer overflows while fetching data from
+    :ref:`SODA documents <sodadocumentclass>`.
 
 #)  Improved Token callback error handling and validation for undefined access
     token callback arguments.
@@ -152,6 +158,9 @@ Thick Mode Changes
 
 #)  Dropped support for Oracle Client libraries earlier than 19c.
 
+#)  Dropped support for pre-built macOS Intel x86-64 binaries from the
+    node-oracledb installation.
+
 node-oracledb `v6.10.0 <https://github.com/oracle/node-oracledb/compare/v6.9.0...v6.10.0>`__ (16 Oct 2025)
 -----------------------------------------------------------------------------------------------------------
 

doc/src/user_guide/appendix_a.rst

@@ -146,6 +146,9 @@ node-oracledb Thin and Thick modes. For more details see :ref:`modediff`.
     * - Bequeath connections
       - No
       - Yes
+    * - Oracle Database 26ai Deep Data Security (see :ref:`deepdatasecurity`)
+      - Yes
+      - No
     * - Lightweight Directory Access Protocol (LDAP) connections
       - No
       - Yes
@@ -583,11 +586,21 @@ from node-oracledb Thick mode in the following ways:
 - Not all the parameters of the :meth:`oracledb.createPool()` method are
   applicable to both node-oracledb modes. Each mode ignores unrecognized
   parameters. The parameters that are supported in Thin mode include
-  ``accessToken``, ``connectString``, ``connectionString``,
-  ``enableStatistics``, ``password``, ``poolAlias``, ``poolIncrement``,
-  ``poolMax``, ``poolMin``, ``poolPingInterval``, ``poolTimeout``,
-  ``queueMax``, ``queueRequests``, ``queueTimeout``, ``stmtCacheSize``,
-  ``user``, and ``username`` parameters.
+  ``accessToken``, ``accessTokenConfig``, ``appContext``, ``configDir``,
+  ``connectionIdPrefix``, ``connectString``, ``connectionString``,
+  ``connectTimeout``, ``driverName``, ``edition``, ``enableStatistics``,
+  ``expireTime``, ``externalAuth``, ``homogeneous``, ``httpsProxy``,
+  ``httpsProxyPort``, ``machine``, ``maxLifetimeSession``,
+  ``networkCompression``, ``networkCompressionThreshold``, ``osUser``,
+  ``password``, ``poolAlias``, ``poolIncrement``, ``poolMax``, ``poolMin``,
+  ``poolPingInterval``, ``poolPingTimeout``, ``poolTimeout``, ``privilege``,
+  ``program``, ``queueMax``, ``queueRequests``, ``queueTimeout``,
+  ``retryCount``, ``retryDelay``, ``sdu``, ``sessionCallback``,
+  ``sourceRoute``, ``sslAllowWeakDNMatch``, ``sslServerCertDN``,
+  ``sslServerDNMatch``, ``stmtCacheSize``, ``terminal``,
+  ``tokenAuthConfigAzure``, ``tokenAuthConfigOci``,
+  ``transportConnectTimeout``, ``user``, ``username``, ``useSNI``,
+  ``walletContent``, ``walletLocation``, and ``walletPassword`` parameters.
 
 - Node-oracledb Thin mode only supports homogeneous pools.
 
@@ -683,13 +696,12 @@ Supported Database Data Types in Thin and Thick Modes
 
 Node-oracledb Thin and Thick modes support different Oracle Database data
 types. The following table lists the types that are supported in the
-node-oracledb driver. See `Oracle Database Types <https://docs.oracle.
-com/en/database/oracle/oracle-database/21/sqlrf/Data-Types.html#GUID-A3C0D836-
-BADB-44E5-A5D4-265BA5968483>`__ and `PL/SQL Types <https://docs.oracle.com/en
-/database/oracle/oracle-database/21/lnpls/plsql-data-types.html#GUID-391C58FD-
-16AF-486C-AF28-173E309CDBA5>`__. The node-oracledb database type shown is the
-common one. In some node-oracledb APIs you may use other types, for example
-when binding numeric values.
+node-oracledb driver. See `Oracle Database Types <https://www.oracle.com/pls/
+topic/lookup?ctx=dblatest&id=GUID-A3C0D836-BADB-44E5-A5D4-265BA5968483>`__ and
+`PL/SQL Types <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-
+391C58FD-16AF-486C-AF28-173E309CDBA5>`__. The node-oracledb database type
+shown is the common one. In some node-oracledb APIs you may use other types,
+for example when binding numeric values.
 
 .. list-table-with-summary::  Oracle Database Data Types Supported
     :header-rows: 1
@@ -799,6 +811,9 @@ when binding numeric values.
     * - XMLType
       - DB_TYPE_XMLTYPE
       - Yes
+    * - VECTOR
+      - DB_TYPE_VECTOR
+      - Yes
 
 .. _testingmode:
 

doc/src/user_guide/connection_handling.rst

@@ -217,6 +217,12 @@ For example:
         connectString : "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=mymachine.example.com)(PORT=1521))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=orcl)))"
     });
 
+When a connect descriptor is specified in the ``connectString`` property as
+shown in the example above, the maximum length of the ``DESCRIPTION``
+parameter is *4096* bytes and its maximum nesting depth (maximum level of
+sub-sections inside the DESCRIPTION section + 1) is *64*. If either limit is
+exceeded, an error is raised.
+
 Any ``DESCRIPTION``, ``CONNECT_DATA`` and ``SECURITY`` parameters of a connect
 descriptor that are not recognized by node-oracledb are passed to the database
 unchanged.
@@ -685,7 +691,7 @@ below.
         .. versionadded:: 6.10
       - Optional
     * - ``njs``
-      - The node-oracledb specific properties. The properties that can be stored in OCI Object Storage include ``poolMin``, ``poolMax``, ``poolIncrement``, ``poolTimeout``, ``poolPingInterval``, ``poolPingTimeout``, ``stmtCacheSize``, ``prefetchRows``, and ``lobPrefetch``.
+      - The node-oracledb specific properties. The properties that can be stored include ``poolMin``, ``poolMax``, ``poolIncrement``, ``poolTimeout``, ``poolPingInterval``, ``poolPingTimeout``, ``stmtCacheSize``, ``prefetchRows``, and ``lobPrefetch``.
       - Optional
 
 **Precedence of Properties**
@@ -755,7 +761,7 @@ Provider is:
         "user": "scott",
         "password": {
           "type": "base64",
-          "value": "dGlnZXI="
+          "value": "***xyz"
         }
         "njs": {
             "stmtCacheSize": 30,
@@ -827,7 +833,7 @@ Multiple alias names can be defined in a JSON file as shown below:
             "user": "scott",
             "password": {
               "type": "base64",
-              "value": "dGlnZXI="
+              "value": "***xyz"
             }
         }
     }
@@ -1367,7 +1373,7 @@ An example of a JSON file that can be used with AWS S3 Configuration Provider is
         "user": "scott",
         "password": {
             "type": "base64",
-            "value": "dGlnZXI="
+            "value": "***xyz"
         },
         "njs": {
             "stmtCacheSize": 30,
@@ -2053,6 +2059,8 @@ connection is shown below:
       user: "hr",
       password: mypw, // contains the hr schema password
       connectString: "mydbmachine.example.com/orclpdb1",
+      walletLocation: "/opt/OracleCloud/MYDB", // location of pem file
+      walletPassword: wp
     });
 
     connection.setEndUserSecurityContext(user_context);
@@ -2067,7 +2075,9 @@ An example of setting an end user security context for a connection pool is:
       connectString : "mydbmachine.example.com/orclpdb1",
       poolIncrement: 1,
       poolMin: 1,
-      poolMax: 5
+      poolMax: 5,
+      walletLocation: "/opt/OracleCloud/MYDB",
+      walletPassword: wp
     });
 
     const connection = await pool.getConnection();