Small doc tweaks for obsolete functions

Author: cjbj

doc/api.md

@@ -177,7 +177,7 @@ For installation information, see the [Node-oracledb Installation Instructions][
     - 4.2 [Connection Methods](#connectionmethods)
         - 4.2.1 [`break()`](#break)
         - 4.2.2 [`changePassword()`](#changepassword)
-        - 4.2.3 [`close()`](#connectionclose)
+        - 4.2.3 [`close()`](#connectionclose), [`release()`](#connectionclose)
         - 4.2.4 [`commit()`](#commit)
         - 4.2.5 [`createLob()`](#connectioncreatelob)
         - 4.2.6 [`execute()`](#execute)
@@ -227,35 +227,34 @@ For installation information, see the [Node-oracledb Installation Instructions][
         - 4.2.11 [`getStatementInfo()`](#getstmtinfo)
         - 4.2.12 [`ping()`](#connectionping)
         - 4.2.13 [`queryStream()`](#querystream)
-        - 4.2.14 [`release()`](#release)
-        - 4.2.15 [`rollback()`](#rollback)
-        - 4.2.16 [`shutdown()`](#conshutdown)
-            - 4.2.16.1 [`shutdown()`: shutdownMode](#conshutdownmode)
-            - 4.2.16.2 [`shutdown()`: Callback Function](#conshutdowncallback)
-        - 4.2.17 [`subscribe()`](#consubscribe)
-            - 4.2.17.1 [`subscribe()`: Name](#consubscribename)
-            - 4.2.17.2 [`subscribe()`: Options](#consubscribeoptions)
-                - 4.2.17.2.1 [`binds`](#consubscribeoptbinds)
-                - 4.2.17.2.2 [`callback`](#consubscribeoptcallback)
-                - 4.2.17.2.3 [`clientInitiated`](#consubscribeoptclientinitiated)
-                - 4.2.17.2.4 [`groupingClass`](#consubscribeoptgroupingclass)
-                - 4.2.17.2.5 [`groupingType`](#consubscribeoptgroupingtype)
-                - 4.2.17.2.6 [`groupingValue`](#consubscribeoptgroupingvalue)
-                - 4.2.17.2.7 [`ipAddress`](#consubscribeoptipaddress)
-                - 4.2.17.2.8 [`namespace`](#consubscribeoptnamespace)
-                - 4.2.17.2.9 [`operations`](#consubscribeoptoperations)
-                - 4.2.17.2.10 [`port`](#consubscribeoptport)
-                - 4.2.17.2.11 [`qos`](#consubscribeoptqos)
-                - 4.2.17.2.12 [`sql`](#consubscribeoptsql)
-                - 4.2.17.2.13 [`timeout`](#consubscribeopttimeout)
-            - 4.2.17.3 [`subscribe()`: Callback Function](#consubscribecallback)
-        - 4.2.18 [`startup()`](#constartup)
-            - 4.2.18.1 [`startup()`: Options](#constartupoptions)
-                - 4.2.18.1.1 [`force`](#constartupoptionsforce)
-                - 4.2.18.1.2 [`pfile`](#constartupoptionspfile)
-                - 4.2.18.1.3 [`restrict`](#constartupoptionsrestrict)
-            - 4.2.18.2 [`startup()`: Callback Function](#constartupcallback)
-        - 4.2.19 [`unsubscribe()`](#conunsubscribe)
+        - 4.2.14 [`rollback()`](#rollback)
+        - 4.2.15 [`shutdown()`](#conshutdown)
+            - 4.2.15.1 [`shutdown()`: shutdownMode](#conshutdownmode)
+            - 4.2.15.2 [`shutdown()`: Callback Function](#conshutdowncallback)
+        - 4.2.16 [`subscribe()`](#consubscribe)
+            - 4.2.16.1 [`subscribe()`: Name](#consubscribename)
+            - 4.2.16.2 [`subscribe()`: Options](#consubscribeoptions)
+                - 4.2.16.2.1 [`binds`](#consubscribeoptbinds)
+                - 4.2.16.2.2 [`callback`](#consubscribeoptcallback)
+                - 4.2.16.2.3 [`clientInitiated`](#consubscribeoptclientinitiated)
+                - 4.2.16.2.4 [`groupingClass`](#consubscribeoptgroupingclass)
+                - 4.2.16.2.5 [`groupingType`](#consubscribeoptgroupingtype)
+                - 4.2.16.2.6 [`groupingValue`](#consubscribeoptgroupingvalue)
+                - 4.2.16.2.7 [`ipAddress`](#consubscribeoptipaddress)
+                - 4.2.16.2.8 [`namespace`](#consubscribeoptnamespace)
+                - 4.2.16.2.9 [`operations`](#consubscribeoptoperations)
+                - 4.2.16.2.10 [`port`](#consubscribeoptport)
+                - 4.2.16.2.11 [`qos`](#consubscribeoptqos)
+                - 4.2.16.2.12 [`sql`](#consubscribeoptsql)
+                - 4.2.16.2.13 [`timeout`](#consubscribeopttimeout)
+            - 4.2.16.3 [`subscribe()`: Callback Function](#consubscribecallback)
+        - 4.2.17 [`startup()`](#constartup)
+            - 4.2.17.1 [`startup()`: Options](#constartupoptions)
+                - 4.2.17.1.1 [`force`](#constartupoptionsforce)
+                - 4.2.17.1.2 [`pfile`](#constartupoptionspfile)
+                - 4.2.17.1.3 [`restrict`](#constartupoptionsrestrict)
+            - 4.2.17.2 [`startup()`: Callback Function](#constartupcallback)
+        - 4.2.18 [`unsubscribe()`](#conunsubscribe)
 5. [AqQueue Class](#aqqueueclass)
     - 5.1 [AqQueue Properties](#aqqueueproperties)
         - 5.1.1 [`name`](#aqqueuename)
@@ -2157,7 +2156,7 @@ Monitoring](#connpoolmonitor).
 
 The default value is *false*.
 
-This property was added in node-oracledb 5.2.  The older, equivalent alias
+This property was added in node-oracledb 5.2.  The obsolete property
 `_enableStats` can still be used, but it will be removed in a future version of
 node-oracledb.
 
@@ -3349,7 +3348,7 @@ This method was added in node-oracledb 2.2.
     ----------------------------|-------------
     *Error error* | If `changePassword()` succeeds, `error` is NULL.  If an error occurs, then `error` contains the [error message](#errorobj).
 
-####  <a name="connectionclose"></a> 4.2.3 `connection.close()`
+####  <a name="connectionclose"></a> <a name="release"></a> 4.2.3 `connection.close()`
 
 ##### Prototype
 
@@ -3379,8 +3378,9 @@ make the connection unusable, then `close()` will drop that connection
 from the connection pool so a future pooled `getConnection()` call
 that grows the pool will create a new, valid connection.
 
-This method was added to node-oracledb 1.9, replacing the equivalent
-alias `connection.release()`.
+This method was added to node-oracledb 1.9, replacing the obsolete equivalent
+alias `connection.release()` which will be removed in a future version of
+node-oracledb.
 
 ##### Parameters
 
@@ -4490,11 +4490,7 @@ This method was added in node-oracledb 1.8.
 
 See [execute()](#execute).
 
-#### <a name="release"></a> 4.2.14 `connection.release()`
-
-An alias for [connection.close()](#connectionclose).
-
-#### <a name="rollback"></a> 4.2.15 `connection.rollback()`
+#### <a name="rollback"></a> 4.2.14 `connection.rollback()`
 
 ##### Prototype
 
@@ -4524,7 +4520,7 @@ connection.
     ----------------------------|-------------
     *Error error* | If `rollback()` succeeds, `error` is NULL.  If an error occurs, then `error` contains the [error message](#errorobj).
 
-#### <a name="conshutdown"></a> 4.2.16 `connection.shutdown()`
+#### <a name="conshutdown"></a> 4.2.15 `connection.shutdown()`
 
 ##### Prototype
 
@@ -4558,7 +4554,7 @@ See [Database Start Up and Shut Down](#startupshutdown).
 
 This method was added in node-oracledb 5.0.
 
-##### <a name="conshutdownmode"></a> 4.2.16.1 `shutdown()`: shutdownMode
+##### <a name="conshutdownmode"></a> 4.2.15.1 `shutdown()`: shutdownMode
 
 ```
 Number shutdownMode
@@ -4578,7 +4574,7 @@ need to be called a second time.
 Only the second invocation of `connection.shutdown()` should use
 `oracledb.SHUTDOWN_MODE_FINAL`.
 
-##### <a name="conshutdowncallback"></a> 4.2.16.2 `shutdown()`: Callback Function
+##### <a name="conshutdowncallback"></a> 4.2.15.2 `shutdown()`: Callback Function
 
 ```
 function(Error error)
@@ -4590,7 +4586,7 @@ Callback function parameter | Description
 ----------------------------|-------------
 *Error error*               | If `shutdown()` succeeds, `error` is NULL.  If an error occurs, then `error` contains the [error message](#errorobj).
 
-#### <a name="consubscribe"></a> 4.2.17 `connection.subscribe()`
+#### <a name="consubscribe"></a> 4.2.16 `connection.subscribe()`
 
 ##### Prototype
 
@@ -4634,7 +4630,7 @@ added in node-oracledb 4.0
 
 The [`result`](#consubscribecallback) callback parameter was added in node-oracledb 4.0.
 
-##### <a name="consubscribename"></a> 4.2.17.1 `subscribe()`: Name
+##### <a name="consubscribename"></a> 4.2.16.1 `subscribe()`: Name
 
 ```
 String name
@@ -4644,15 +4640,15 @@ For Continuous Query Notification this is an arbitrary name given to
 the subscription.  For Advanced Queuing notifications this must be the
 queue name.
 
-##### <a name="consubscribeoptions"></a> 4.2.17.2 `subscribe()`: Options
+##### <a name="consubscribeoptions"></a> 4.2.16.2 `subscribe()`: Options
 
 ```
 Object options
 ```
 
 The options that control the subscription.  The following properties can be set.
 
-###### <a name="consubscribeoptbinds"></a> 4.2.17.2.1 `binds`
+###### <a name="consubscribeoptbinds"></a> 4.2.16.2.1 `binds`
 
 ```
 Object binds
@@ -4661,7 +4657,7 @@ Object binds
 An array (bind by position) or object (bind by name) containing the
 bind values to use in the [`sql`](#consubscribeoptsql) property.
 
-###### <a name="consubscribeoptcallback"></a> 4.2.17.2.2 `callback`
+###### <a name="consubscribeoptcallback"></a> 4.2.16.2.2 `callback`
 
 ```
 function callback(Object message)
@@ -4701,7 +4697,7 @@ The `message` parameter in the notification callback is an object containing the
     - [`oracledb.SUBSCR_EVENT_TYPE_OBJ_CHANGE`](#oracledbconstantssubscription) - object-level notifications are being used (Database Change Notification).
     - [`oracledb.SUBSCR_EVENT_TYPE_QUERY_CHANGE`](#oracledbconstantssubscription) - query-level notifications are being used (Continuous Query Notification).
 
-###### <a name="consubscribeoptclientinitiated"></a> 4.2.17.2.3 `clientInitiated`
+###### <a name="consubscribeoptclientinitiated"></a> 4.2.16.2.3 `clientInitiated`
 
 ```
 Boolean clientInitiated
@@ -4717,7 +4713,7 @@ The default is *false*.
 
 This property was added in node-oracledb 4.2.  It is available when Oracle Database and the Oracle client libraries are version 19.4 or higher.
 
-###### <a name="consubscribeoptgroupingclass"></a> 4.2.17.2.4 `groupingClass`
+###### <a name="consubscribeoptgroupingclass"></a> 4.2.16.2.4 `groupingClass`
 
 ```
 Number groupingClass
@@ -4728,7 +4724,7 @@ An integer mask which currently, if set, can only contain the value
 this value is set then notifications are grouped by time into a single
 notification.
 
-###### <a name="consubscribeoptgroupingtype"></a> 4.2.17.2.5 `groupingType`
+###### <a name="consubscribeoptgroupingtype"></a> 4.2.16.2.5 `groupingType`
 
 ```
 Number groupingType
@@ -4741,7 +4737,7 @@ or
 [`oracledb.SUBSCR_GROUPING_TYPE_LAST`](#oracledbconstantssubscription)
 indicating the last notification in the group should be sent.
 
-###### <a name="consubscribeoptgroupingvalue"></a> 4.2.17.2.6 `groupingValue`
+###### <a name="consubscribeoptgroupingvalue"></a> 4.2.16.2.6 `groupingValue`
 
 ```
 Number groupingValue
@@ -4753,7 +4749,7 @@ then `groupingValue` can be used to set the number of seconds over
 which notifications will be grouped together, invoking `callback`
 once.  If `groupingClass` is not set, then `groupingValue` is ignored.
 
-###### <a name="consubscribeoptipaddress"></a> 4.2.17.2.7 `ipAddress`
+###### <a name="consubscribeoptipaddress"></a> 4.2.16.2.7 `ipAddress`
 
 ```
 String ipAddress
@@ -4763,7 +4759,7 @@ A string containing an IPv4 or IPv6 address on which the subscription
 should listen to receive notifications.  If not specified, then the
 Oracle Client library will select an IP address.
 
-###### <a name="consubscribeoptnamespace"></a> 4.2.17.2.8 `namespace`
+###### <a name="consubscribeoptnamespace"></a> 4.2.16.2.8 `namespace`
 
 ```
 Number namespace
@@ -4778,7 +4774,7 @@ You can use `oracledb.SUBSCR_NAMESPACE_AQ` to get notifications that
 Advanced Queuing messages are available to be dequeued, see
 [Advanced Queuing Notifications](#aqnotifications).
 
-###### <a name="consubscribeoptoperations"></a> 4.2.17.2.9 `operations`
+###### <a name="consubscribeoptoperations"></a> 4.2.16.2.9 `operations`
 
 ```
 Number operations
@@ -4788,7 +4784,7 @@ An integer mask containing one or more of the operation type
 [`oracledb.CQN_OPCODE_*`](#oracledbconstantscqn) constants to indicate
 what types of database change should generation notifications.
 
-###### <a name="consubscribeoptport"></a> 4.2.17.2.10 `port`
+###### <a name="consubscribeoptport"></a> 4.2.16.2.10 `port`
 
 ```
 Number port
@@ -4798,7 +4794,7 @@ The port number on which the subscription should listen to receive
 notifications.  If not specified, then the Oracle Client library will
 select a port number.
 
-###### <a name="consubscribeoptqos"></a> 4.2.17.2.11 `qos`
+###### <a name="consubscribeoptqos"></a> 4.2.16.2.11 `qos`
 
 ```
 Number qos
@@ -4807,21 +4803,21 @@ Number qos
 An integer mask containing one or more of the quality of service
 [`oracledb.SUBSCR_QOS_*`](#oracledbconstantssubscription) constants.
 
-###### <a name="consubscribeoptsql"></a> 4.2.17.2.12 `sql`
+###### <a name="consubscribeoptsql"></a> 4.2.16.2.12 `sql`
 
 ```
 String sql
 ```
 
 The SQL query string to use for notifications.
 
-###### <a name="consubscribeopttimeout"></a> 4.2.17.2.13 `timeout`
+###### <a name="consubscribeopttimeout"></a> 4.2.16.2.13 `timeout`
 
 The number of seconds the subscription should remain active.  Once
 this length of time has been reached, the subscription is
 automatically unregistered and a deregistration notification is sent.
 
-##### <a name="consubscribecallback"></a> 4.2.17.3 `subscribe()`: Callback Function
+##### <a name="consubscribecallback"></a> 4.2.16.3 `subscribe()`: Callback Function
 
 ##### Prototype
 
@@ -4838,7 +4834,7 @@ Callback function parameter | Description
 
 The `result` callback parameter was added in node-oracledb 4.0.
 
-#### <a name="constartup"></a> 4.2.18 `connection.startup()`
+#### <a name="constartup"></a> 4.2.17 `connection.startup()`
 
 ##### Prototype
 
@@ -4874,24 +4870,24 @@ See [Database Start Up and Shut Down](#startupshutdown).
 
 This method was added in node-oracledb 5.0.
 
-##### <a name="constartupoptions"></a> 4.2.18.1 `startup()`: options
+##### <a name="constartupoptions"></a> 4.2.17.1 `startup()`: options
 
-##### <a name="constartupoptionsforce"></a> 4.2.18.1.1.1 `force`
+##### <a name="constartupoptionsforce"></a> 4.2.17.1.1.1 `force`
 
 Shuts down a running database using
 [`oracledb.SHUTDOWN_MODE_ABORT`](#oracledbconstantsshutdown) before restarting
 the database instance.  The next database start up may require instance recovery.
 The default for `force` is *false*.
 
-##### <a name="constartupoptionspfile"></a> 4.2.18.1.1.2 `pfile`
+##### <a name="constartupoptionspfile"></a> 4.2.17.1.1.2 `pfile`
 
 After the database is started, access is restricted to users who have the CREATE_SESSION and RESTRICTED SESSION privileges.  The default is *false*.
 
-##### <a name="constartupoptionsrestrict"></a> 4.2.18.1.1.3 `restrict`
+##### <a name="constartupoptionsrestrict"></a> 4.2.17.1.1.3 `restrict`
 
 The path and filename for a local text file containing [Oracle Database initialization parameters][171].  If `pfile` is not set, then the database server-side parameter file is used.
 
-##### <a name="constartupcallback"></a> 4.2.18.2 `startup()`: Callback Function
+##### <a name="constartupcallback"></a> 4.2.17.2 `startup()`: Callback Function
 
 ##### Prototype
 
@@ -4905,7 +4901,7 @@ Callback function parameter | Description
 ----------------------------|-------------
 *Error error*               | If `startup()` succeeds, `error` is NULL.  If an error occurs, then `error` contains the [error message](#errorobj).
 
-#### <a name="conunsubscribe"></a> 4.2.19 `connection.unsubscribe()`
+#### <a name="conunsubscribe"></a> 4.2.18 `connection.unsubscribe()`
 
 ##### Prototype
 
@@ -5864,8 +5860,9 @@ cache](#connpoolcache).
 If `pool.close()` is called while the pool is already closed, draining, or
 [reconfiguring](#poolreconfigure), then an error will be thrown.
 
-This method was added to node-oracledb 1.9, replacing the equivalent
-alias `pool.terminate()`.
+This method was added to node-oracledb 1.9, replacing the obsolete equivalent
+alias `pool.terminate()` which will be removed in a future version of
+node-oracledb.
 
 The `drainTime` parameter was added in node-oracledb 3.0.
 
@@ -6037,7 +6034,7 @@ is *false*.
 
 See [Connection Pool Monitoring](#connpoolmonitor).
 
-This function was added in node-oracledb 5.2.  The older, equivalent function
+This function was added in node-oracledb 5.2.  The obsolete function
 `_logStats()` can still be used, but it will be removed in a future version of
 node-oracledb.