Test, Documentation and Release Note updates

Author: sharadraju

doc/src/api_manual/oracledb.rst

@@ -1450,13 +1450,13 @@ Each of the configuration properties is described below.
 
     The default value is *1*.
 
-    With fixed-sized :ref:`homogeneous <createpoolpoolattrshomogeneous>`
-    pools (where ``poolMin`` equals ``poolMax``), and using Oracle Client 18c
-    (or later), you may wish to evaluate setting ``poolIncrement`` greater
-    than 1. This can expedite regrowth when the number of
-    :attr:`connections established <pool.connectionsOpen>` has become lower
-    than ``poolMin``, for example if network issues have caused connections
-    to become unusable and they have been dropped from the pool.
+    With fixed-size :ref:`homogeneous <createpoolpoolattrshomogeneous>`
+    pools (where ``poolMin`` equals ``poolMax``), and when using Oracle Client
+    18c (or later) for node-oracledb Thick mode, you may wish to evaluate
+    setting ``poolIncrement`` greater than 1. This can expedite regrowth when
+    the number of :attr:`connections established <pool.connectionsOpen>` has
+    become lower than ``poolMin``, for example, when network issues cause
+    connections to become unusable and get them dropped from the pool.
 
     This property may be overridden when
     :meth:`creating a connection pool <oracledb.createPool()>`.
@@ -1871,9 +1871,10 @@ Oracledb Methods
     password and connection string. A pool is typically created once during
     application initialization.
 
-    Internally, ``createPool()`` creates an `Oracle Call Interface Session
-    Pool <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-F9662FFB-
-    EAEF-495C-96FC-49C6D1D9625C>`__ for each Pool object.
+    In node-oracledb Thick mode, ``createPool()`` internally creates an
+    `Oracle Call Interface Session Pool <https://www.oracle.com/pls/topic/
+    lookup?ctx=dblatest&id=GUID-F9662FFB-EAEF-495C-96FC-49C6D1D9625C>`__ for
+    each Pool object.
 
     The default properties may be overridden by specifying new properties in
     the ``poolAttrs`` parameter.
@@ -1989,7 +1990,7 @@ Oracledb Methods
 
             .. desupported:: 6.0
 
-            Use :ref:`accessToken <createpoolpoolattrsaccesstoken>` instead, which was enhanced to support a callback.
+            Use :ref:`accessToken <createpoolpoolattrsaccesstoken>` with a callback instead.
         * - ``connectString``, ``connectionString``
           - String
           - Both

doc/src/api_manual/pool.rst

@@ -8,10 +8,10 @@ A connection *Pool* object is created by calling the
 :meth:`oracledb.createPool()` method.
 
 The *Pool* object obtains connections to the Oracle database using the
-``getConnection()`` method to “check them out” from the pool. Internally
-`Oracle Call Interface Session Pooling <https://www.oracle.com/pls/topic/
-lookup?ctx=dblatest&id=GUID-F9662FFB-EAEF-495C-96FC-49C6D1D9625C>`__
-is used.
+``getConnection()`` method to “check them out” from the pool. The
+node-oracledb Thick mode internally uses `Oracle Call Interface Session
+Pooling <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-
+F9662FFB-EAEF-495C-96FC-49C6D1D9625C>`__.
 
 After the application finishes using a connection pool, it should
 release all connections and terminate the connection pool by calling the
@@ -50,11 +50,17 @@ values.
     This read-only property is a string which specifies the connection string
     used to connect to the Oracle Database Instance.
 
+    See :ref:`connectString <createpoolpoolattrsconnectstring>` parameter of
+    :meth:`oracledb.createPool()`.
+
 .. attribute:: pool.edition
 
     This read-only property is a string which identifies the edition name
     used.
 
+    See :ref:`edition <createpoolpoolattrsedition>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.edition`.
+
     .. note::
 
         This property can only be used in the node-oracledb Thick mode. See
@@ -65,6 +71,9 @@ values.
     This read-only property is a boolean which denotes whether the Oracle
     Client events mode is enabled or not.
 
+    See :ref:`events <createpoolpoolattrsevents>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.events`.
+
     .. note::
 
         This property can only be used in the node-oracledb Thick mode. See
@@ -75,18 +84,27 @@ values.
     This read-only property is a boolean which denotes whether connections
     are established using external authentication or not.
 
+    See :ref:`externalAuth <createpoolpoolattrsexternalauth>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.externalAuth`.
+
 .. attribute:: pool.enableStatistics
 
     This read-only property is a boolean which identifies whether pool usage
     statistics are being recorded.
 
+    See :ref:`enableStatistics <createpoolpoolattrsstats>` parameter of
+    :meth:`oracledb.createPool()`.
+
 .. attribute:: pool.homogeneous
 
     This read-only property is a boolean which identifies whether the
     connections in the pool all have the same credentials (a
     ‘homogenous’ pool), or whether different credentials can be used (a
     ‘heterogeneous’ pool).
 
+    See :ref:`homogeneous <createpoolpoolattrshomogeneous>` parameter of
+    :meth:`oracledb.createPool()`.
+
 .. attribute:: pool.poolAlias
 
     This read-only property is a number which specifies the alias of this
@@ -95,20 +113,25 @@ values.
     undefined for the second and subsequent pools that were created without
     an explicit alias specified.
 
+    See :ref:`poolAlias <createpoolpoolattrspoolalias>` parameter of
+    :meth:`oracledb.createPool()`.
+
 .. attribute:: pool.poolIncrement
 
     This read-only property is a number which specifies the number of
     connections that are opened whenever a connection request
     exceeds the number of currently open connections.
 
-    See :attr:`oracledb.poolIncrement`.
+    See :ref:`poolIncrement <createpoolpoolattrspoolincrement>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.poolIncrement`.
 
 .. attribute:: pool.poolMax
 
     This read-only property is a number which specifies the maximum number
     of connections that can be open in the connection pool.
 
-    See :attr:`oracledb.poolMax`.
+    See :ref:`poolMax <createpoolpoolattrspoolmax>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.poolMax`.
 
 .. attribute:: pool.poolMaxPerShard
 
@@ -117,7 +140,8 @@ values.
     database. This lets connections in the pool be balanced across the
     shards.
 
-    See :attr:`oracledb.poolMaxPerShard`.
+    See :ref:`poolMaxPerShard <createpoolpoolattrspoolmaxpershard>` parameter
+    of :meth:`oracledb.createPool()` and :attr:`oracledb.poolMaxPerShard`.
 
     .. note::
 
@@ -130,7 +154,8 @@ values.
     of connections a connection pool maintains, even when there is no
     activity to the target database.
 
-    See :attr:`oracledb.poolMin`.
+    See :ref:`poolMin <createpoolpoolattrspoolmin>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.poolMin`.
 
 .. attribute:: pool.poolPingInterval
 
@@ -140,15 +165,18 @@ values.
     node-oracledb pings the database prior to returning that connection to
     the application.
 
-    See :attr:`oracledb.poolPingInterval`.
+    See :ref:`poolPingInterval <createpoolpoolattrspoolpinginterval>`
+    parameter of :meth:`oracledb.createPool()` and
+    :attr:`oracledb.poolPingInterval`.
 
 .. attribute:: pool.poolTimeout
 
     This read-only property is a number which specifies the time (in seconds)
     after which the pool terminates idle connections (unused in the pool). The
     number of connections does not drop below poolMin.
 
-    See :attr:`oracledb.poolTimeout`.
+    See :ref:`poolTimeout <createpoolpoolattrspooltimeout>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.poolTimeout`.
 
 .. attribute:: pool.queueMax
 
@@ -158,35 +186,44 @@ values.
     of pending ``pool.getConnection()`` calls that can be
     :ref:`queued <connpoolqueue>`.
 
-    See :attr:`oracledb.queueMax`.
+    See :ref:`queueMax <createpoolpoolattrsqueuemax>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.queueMax`.
 
 .. attribute:: pool.queueRequests
 
-    This property was removed in node-oracledb 3.0. See :ref:`Connection Pool
-    Queue <connpoolqueue>` for more information.
+    .. desupported:: 3.0
+
+    See :ref:`Connection Pool Queue <connpoolqueue>` for more information.
 
 .. attribute:: pool.queueTimeout
 
     This read-only property is a number which identifies the time
     (in milliseconds) that a connection request should wait in the
     queue before the request is terminated.
 
-    See :attr:`oracledb.queueTimeout`.
+    See :ref:`queueTimeout <createpoolpoolattrsqueuetimeout>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.queueTimeout`.
 
 .. attribute:: pool.sessionCallback
 
     This read-only property can be a function or string. The Node.js or
     PL/SQL function that is invoked by ``pool.getConnection()`` when the
     connection is brand new.
 
-    See :ref:`Connection Tagging and Session State <connpooltagging>`.
+    See :ref:`sessionCallback <createpoolpoolattrssessioncallback>` parameter
+    of :meth:`oracledb.createPool()`.
+
+    Also, see :ref:`Connection Tagging and Session State <connpooltagging>`.
 
 .. attribute:: pool.sodaMetaDataCache
 
     This read-only property is a boolean which determines whether the pool
     has a metadata cache enabled for SODA collection access.
 
-    See :ref:`Using the SODA Metadata Cache <sodamdcache>`.
+    See :ref:`sodaMetaDataCache <createpoolpoolattrssodamdcache>` parameter of
+    :meth:`oracledb.createPool()`.
+
+    Also, see :ref:`Using the SODA Metadata Cache <sodamdcache>`.
 
     .. note::
 
@@ -210,7 +247,8 @@ values.
     statements to be cached in the :ref:`statement
     cache <stmtcache>` of each connection.
 
-    See :attr:`oracledb.stmtCacheSize`.
+    See :ref:`stmtCacheSize <createpoolpoolattrsstmtcachesize>` parameter of
+    :meth:`oracledb.createPool()` and :attr:`oracledb.stmtCacheSize`.
 
 .. attribute:: pool.thin
 
@@ -231,6 +269,9 @@ values.
     This read-only property is a string which specifies the database username
     for connections in the pool.
 
+    See :ref:`user <createpoolpoolattrsuser>` parameter of
+    :meth:`oracledb.createPool()`.
+
 .. _poolmethods:
 
 Pool Methods

doc/src/api_manual/statistics.rst

@@ -6,7 +6,7 @@ API: PoolStatistics Class
 
 A PoolStatistics object is returned from :meth:`pool.getStatistics()`.
 It contains attributes recording the pool statistics and pool configuration.
-The attributes are described in :ref:`poolstats`.
+The attributes are described in :ref:`Connection Pool Monitoring <poolstats>`.
 
 .. versionadded:: 5.3
 

doc/src/release_notes.rst

@@ -5,10 +5,18 @@
 node-oracledb Release Notes
 =============================
 
-node-oracledb `v6.0.1 <https://github.com/oracle/node-oracledb/compare/v6.0.0...v6.0.1>`__ (DD MON 2023)
+node-oracledb `v6.0.1 <https://github.com/oracle/node-oracledb/compare/v6.0.0...v6.0.1>`__ (TBD)
 --------------------------------------------------------------------------------------------------------
 
-#) Allow bind variables to use multi-byte characters. `Issue #1554 <https://github.com/oracle/node-oracledb/issues/1554>`__.
+#) Allow bind variables to use multi-byte characters. Fix for `Issue #1554 <https://github.com/oracle/node-oracledb/issues/1554>`__.
+
+#) Allow using colons in multiple single-line SQL comments in Thin mode. Fix for `Issue #1561 <https://github.com/oracle/node-oracledb/issues/1561>`__.
+
+#) Added enhanced binding support in Thin mode.
+
+#) Improved statement cache handling in Thin mode.
+
+#) Added clear error message when users try to establish a connection with unsupported database versions.
 
 node-oracledb `v6.0.0 <https://github.com/oracle/node-oracledb/compare/v5.5.0...v6.0.0>`__ (24 May 2023)
 --------------------------------------------------------------------------------------------------------