More tests and documentation updates for 6.9 features

Author: sharadraju

doc/src/.static/custom.css

@@ -21,6 +21,12 @@
     margin-bottom: 0pt;
 }
 
+/* Added code to remove the extra lines displayed in a warning block in a table */
+.wy-table-responsive table td div.warning {
+    line-height: 0pt;
+    margin-bottom: 0pt;
+}
+
 /* Added code to wrap the code-blocks that are used in a table*/
 .wy-table-responsive table td pre {
     white-space: pre-wrap !important;

doc/src/api_manual/oracledb.rst

@@ -511,7 +511,7 @@ Constants for :ref:`AqEnqOptions Class <aqenqoptionsclass>`
       - Messages are persistent.
     * - ``oracledb.AQ_MSG_DELIV_MODE_BUFFERED``
       - 2
-      - Messages are buffered.
+      - Messages are buffered. For multi-consumer queues, a `subscriber <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-5FB46C6A-BB22-4CDE-B7D6-E242DC8808D8>`__ with buffered delivery mode needs to be created prior to enqueuing buffered messages.
     * - ``oracledb.AQ_MSG_DELIV_MODE_PERSISTENT_OR_BUFFERED``
       - 3
       - Messages are either persistent or buffered.

doc/src/index.rst

@@ -45,6 +45,7 @@ User Guide
     user_guide/pgmstyle.rst
     user_guide/resources.rst
     user_guide/appendix_a.rst
+    user_guide/appendix_b.rst
 
 API Manual
 ==========

doc/src/release_notes.rst

@@ -26,22 +26,29 @@ Common Changes
     :attr:`dbObject.attributes` property which provide additional metadata
     about the database object.
 
-#)  Added support for property :attr:`pool.maxLifetimeSession` and added it as
-    an optional parameter for configurations of :meth:`oracledb.createPool()`
-    and :meth:`pool.reconfigure()`.
+#)  Added property :attr:`pool.maxLifetimeSession` to the
+    :ref:`Pool object <poolclass>`. This was also added as an optional
+    property in :meth:`oracledb.createPool()` and :meth:`pool.reconfigure()`.
 
-#)  Added instance principal authentication support in native IAM token based
-    authentication with Oracle Cloud Infrastructure.
+#)  Added support for :ref:`File Configuration Provider <fileconfigprovider>`,
+    :ref:`Oracle Cloud Infrastructure (OCI) Vault configuration provider
+    <ocivault>`, and :ref:`Microsoft Azure Key Vault configuration provider
+    <azurekeyvault>`.
 
-#)  Added support for setting
-    :ref:`application context <getconnectiondbattrsappcontext>` with database
-    connections.
+#)  Added support for
+    :ref:`instance principal authentication <_create_pool_oci_properties>`
+    in :ref:`native IAM token-based authentication <cloudnativeauthoci>`
+    with Oracle Cloud Infrastructure.
 
-#)  Added a second argument for the fetchTypeHandler call to get
+#)  Added support for setting the :ref:`application context <appcontext>` with
+    database connections.
+
+#)  Added a second argument for the
+    :attr:`fetchTypeHandler <oracledb.fetchTypeHandler>` call to get
     the metadata of all the result columns.
     See `Issue #1728 <https://github.com/oracle/node-oracledb/issues/1728>`__.
 
-#)  Added check for :meth:`lob.setDirFileName()` to verify if empty strings
+#)  Added a check for :meth:`lob.setDirFileName()` to verify if empty strings
     are passed or the properties are not found.
 
 #)  Added :attr:`~error.isRecoverable` property to the Error object to check
@@ -62,9 +69,6 @@ Common Changes
 Thin Mode Changes
 +++++++++++++++++
 
-#)  Added support for config-file, config-ociobject, and config-azurevault
-    configuration providers.
-
 #)  Fixed bug which forced node-oracledb to resolve the database host name
     even if a proxy was specified in the connect string. Now the proxy
     specified in the connect string will resolve the database host name.

doc/src/user_guide/appendix_a.rst

@@ -116,6 +116,9 @@ node-oracledb Thin and Thick modes. For more details see :ref:`modediff`.
     * - Easy Connect connection strings (see :ref:`easyconnect`)
       - Yes - Unknown settings are ignored and not passed to Oracle Database
       - Yes
+    * - Centralized Configuration Providers (see :ref:`configurationprovider`)
+      - Yes
+      - Yes
     * - Oracle Cloud Database connectivity (see :ref:`connectionadb`)
       - Yes
       - Yes
@@ -796,16 +799,3 @@ connection or pool, respectively.
 
 Another method that can be used to check which mode is in use is to query
 ``V$SESSION_CONNECT_INFO``. See :ref:`vsessconinfo`.
-
-.. _frameworks:
-
-Frameworks, SQL Generators, and ORMs
-====================================
-
-The features of node-oracledb Thin mode cover the needs of common frameworks
-that depend upon the Node.js API. For example, the node-oracledb Thin mode can
-be used in Sequelize. To run the node-oracledb Thin mode through Sequelize,
-you must not set the ``libPath`` in the dialectOptions object and must not
-:meth:`~oracledb.initOracleClient`. For node-oracledb Thick mode, set the
-``libPath`` in the dialectOptions object or call
-:meth:`~oracledb.initOracleClient()`.

doc/src/user_guide/appendix_b.rst

@@ -0,0 +1,20 @@
+.. _frameworks:
+
+************************************************
+Appendix B: Node.js Frameworks and node-oracledb
+************************************************
+
+The features of node-oracledb Thin and Thick modes cover the needs of common
+Node.js frameworks and libraries.
+
+Node-oracledb Thin and Thick modes can be used in `Sequelize
+<https://sequelize.org/>`__. To run node-oracledb Thin mode through Sequelize,
+you must *not* set the ``libPath`` in the dialectOptions object and must not
+call :meth:`~oracledb.initOracleClient`. For node-oracledb Thick mode, set the
+``libPath`` in the dialectOptions object or call
+:meth:`~oracledb.initOracleClient()`.
+
+You can use the `OpenTelemetry <https://opentelemetry.io/>`__ observability
+framework with node-oracledb to generate telemetry data for Oracle Database
+connections. This helps you to analyze and monitor connection metrics and
+optimize them, if necessary. See :ref:`opentelemetry` for more information.