Complete update of documentation, test cases and other non-code files for 6.5 release

Author: sharadraju

doc/src/api_manual/connection.rst

@@ -1162,15 +1162,15 @@ Connection Methods
 
             Extended metadata is now always returned and includes the following information:
 
-            - ``annotations``: The `annotations <https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/annotations_clause.html#GUID-1AC16117-BBB6-4435-8794-2B99F8F68052>`__ object associated with the fetched column. If the column has no associated annotations, this property value is `undefined`. Annotations are supported from Oracle Database 23c onwards. If node-oracledb Thick mode is used, Oracle Client 23c is also required.
+            - ``annotations``: The `annotations <https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/annotations_clause.html#GUID-1AC16117-BBB6-4435-8794-2B99F8F68052>`__ object associated with the fetched column. If the column has no associated annotations, this property value is `undefined`. Annotations are supported from Oracle Database 23ai onwards. If node-oracledb Thick mode is used, Oracle Client 23ai is also required.
 
             - ``byteSize``: The database byte size. This is only set for ``oracledb.DB_TYPE_VARCHAR``, ``oracledb.DB_TYPE_CHAR`` and ``oracledb.DB_TYPE_RAW`` column types.
             - ``dbType``: one of the :ref:`Oracle Database Type Constant <oracledbconstantsdbtype>` values.
             - ``dbTypeClass``: The class associated with the database type. This is only set if the database type is an object type.
             - ``dbTypeName``: The name of the database type, such as “NUMBER” or “VARCHAR2”. For object types, this will be the object name.
-            - ``domainName``: The name of the `SQL domain <https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/create-domain.html#GUID-17D3A9C6-D993-4E94-BF6B-CACA56581F41>`__ associated with the fetched column. If the column does not have a SQL domain, this property value is `undefined`. SQL domains are supported from Oracle Database 23c onwards. If node-oracledb Thick mode is used, Oracle Client 23c is also required.
+            - ``domainName``: The name of the `SQL domain <https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/create-domain.html#GUID-17D3A9C6-D993-4E94-BF6B-CACA56581F41>`__ associated with the fetched column. If the column does not have a SQL domain, this property value is `undefined`. SQL domains are supported from Oracle Database 23ai onwards. If node-oracledb Thick mode is used, Oracle Client 23ai is also required.
 
-            - ``domainSchema``: The schema name of the `SQL domain <https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/create-domain.html#GUID-17D3A9C6-D993-4E94-BF6B-CACA56581F41>`__ associated with the fetched column. If the column does not have a SQL domain, this property value is `undefined`. SQL domains are supported from Oracle Database 23c onwards. If node-oracledb Thick mode is used, Oracle Client 23c is also required.
+            - ``domainSchema``: The schema name of the `SQL domain <https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/create-domain.html#GUID-17D3A9C6-D993-4E94-BF6B-CACA56581F41>`__ associated with the fetched column. If the column does not have a SQL domain, this property value is `undefined`. SQL domains are supported from Oracle Database 23ai onwards. If node-oracledb Thick mode is used, Oracle Client 23ai is also required.
 
             - ``fetchType``: One of the :ref:`Node-oracledb Type Constant <oracledbconstantsnodbtype>` values.
             - ``isJson``: Indicates if the column is known to contain JSON data. This will be ``true`` for JSON columns (from Oracle Database 21c) and for LOB and VARCHAR2 columns where "IS JSON" constraint is enabled (from Oracle Database 19c). This property will be ``false`` for all the other columns. It will also be ``false`` for any column when Oracle Client 18c or earlier is used in Thick mode or the Oracle Database version is earlier than 19c.
@@ -1179,6 +1179,12 @@ Connection Methods
             - ``nullable``: Indicates whether ``NULL`` values are permitted for this column.
             - ``precision``: Set only for ``oracledb.DB_TYPE_NUMBER``, ``oracledb.DB_TYPE_TIMESTAMP``, ``oracledb.DB_TYPE_TIMESTAMP_TZ``, and ``oracledb.DB_TYPE_TIMESTAMP_LTZ`` columns.
             - ``scale``: Set only for ``oracledb.DB_TYPE_NUMBER`` columns.
+            - ``vectorDimensions``: The number of dimensions of the vector column. If the column is not a vector column or allows for any number of dimensions, then the value of this property is *undefined*.
+            - ``vectorFormat``: The storage format of each dimension value in the vector column. If the column is not a vector column or allows for any storage format, then the value of this property is *undefined*.
+
+            .. versionchanged:: 6.5
+
+                The ``vectorDimensions`` and ``vectorFormat`` information attributes were added.
 
             .. versionchanged:: 6.4
 

doc/src/api_manual/oracledb.rst

@@ -181,6 +181,11 @@ instead of ``result.metadata[0].fetchType == 2001``.
     * - ``oracledb.DB_TYPE_XMLTYPE``
       - 2032
       - XMLTYPE
+    * - ``oracledb.DB_TYPE_VECTOR``
+      - 2033
+      - VECTOR
+
+        .. versionadded:: 6.5
 
 Note that the values for these constants changed in node-oracledb 4.0.
 
@@ -864,6 +869,34 @@ Constants for two-phase commit (TPC) functions
       - 1048576
       - Suspend the TPC transaction.
 
+Vector Type Constants
+---------------------
+.. versionadded:: 6.5
+
+Constants for the :ref:`vectorFormat <execmetadata>` attribute.
+
+.. list-table-with-summary::  Vector Type Constants
+    :header-rows: 1
+    :class: wy-table-responsive
+    :align: center
+    :widths: 10 10 30
+    :summary: The first column displays the name of the vector type constant
+     name. The second column displays the value of the constant. The third
+     column displays the description of the constant.
+
+    * - Constant Name
+      - Value
+      - Description
+    * - ``oracledb.VECTOR_FORMAT_FLOAT32``
+      - 2
+      - The storage format of each dimension value in the vector column is a 32-bit floating-point number.
+    * - ``VECTOR_FORMAT_FLOAT64``
+      - 3
+      - The storage format of each dimension value in the vector column is a 64-bit floating-point number.
+    * - ``VECTOR_FORMAT_INT8``
+      - 4
+      - The storage format of each dimension value in the vector column is an 8-bit signed integer.
+
 .. _oracledbproperties:
 
 Oracledb Properties

doc/src/conf.py

@@ -45,8 +45,8 @@
 # from the other)
 #
 # The short X.Y version.
-version = '6.4'
-release = '6.4.0'
+version = '6.5'
+release = '6.5.0'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

doc/src/index.rst

@@ -9,7 +9,7 @@ for Node.js powers high performance Oracle Database applications.
 :ref:`release notes <releasenotes>`.
 
 This module is currently tested with Node.js 16, 18, and 20 against Oracle
-Database 23c, 21c, 19c, 12c, and 11gR2.
+Database 23ai, 21c, 19c, 12c, and 11gR2.
 
 You can use assistive technology products, such as screen readers, while you
 work with the node-oracledb documentation. You can also use the keyboard
@@ -35,6 +35,7 @@ User Guide
     user_guide/lob_data.rst
     user_guide/json_data_type.rst
     user_guide/xml_data_type.rst
+    user_guide/vector_data_type.rst
     user_guide/objects.rst
     user_guide/soda.rst
     user_guide/aq.rst

doc/src/release_notes.rst

@@ -13,17 +13,20 @@ node-oracledb `v6.5.0 <https://github.com/oracle/node-oracledb/compare/v6.4.0...
 Common Changes
 ++++++++++++++
 
+#)  Added comprehensive support for Oracle Database 23ai
+    :ref:`VECTOR <vectors>` data type.
+
 #)  Incorporated changes to use end of data request flag set with data packets
-    available in Oracle Database 23c to improve handling of the async reads.
+    available in Oracle Database 23ai to improve handling of the async reads.
 
 #)  Added class :ref:`oracledb.JsonId <jsonid>` to represent JSON ID values
     returned by SODA in Oracle Database 23.4 and later in the ``_id``
     attribute of documents stored in native collections.
 
-#)  Added support for an Oracle Database 23c JSON feature allowing for field
+#)  Added support for an Oracle Database 23ai JSON feature allowing for field
     names with more than 255 UTF-8 encoded bytes.
 
-#)  Added support for an Oracle Database 23c JSON feature improving JSON
+#)  Added support for an Oracle Database 23ai JSON feature improving JSON
     storage usage.
 
 #)  Updated the error thrown during pool reconfiguration from ``ORA-24413`` to
@@ -53,7 +56,7 @@ Thin Mode Changes
 #)  Added support for easy connect string entries in tnsnames.ora.
     See `Issue #1644 <https://github.com/oracle/node-oracledb/issues/1644>`__.
 
-#)  Added support for Oracle Database 23c feature that can improve the
+#)  Added support for Oracle Database 23ai feature that can improve the
     performance of connection creation by reducing the number of
     round trips required for all connections created.
 
@@ -67,7 +70,7 @@ Thin Mode Changes
 
 #)  Added support for :meth:`pool reconfiguration <pool.reconfigure()>`.
 
-#)  Added support for Oracle Database 23c
+#)  Added support for Oracle Database 23ai
     :ref:`Implicit Connection Pooling <implicitpool>` in Database Resident
     Connection Pooling (DRCP) and Proxy Resident Connection Pooling (PRCP).
 
@@ -385,7 +388,7 @@ Common Changes
 Thin Mode Changes
 +++++++++++++++++
 
-#)  Added support for an Oracle Database 23c feature that can improve the
+#)  Added support for an Oracle Database 23ai feature that can improve the
     performance of connection creation by reducing the number of round trips
     required to create the second and subsequent connections to the same
     database.
@@ -397,14 +400,14 @@ Thin Mode Changes
 #)  Added new ``sslAllowWeakDNMatch`` connection attribute in :ref:`createPool()
     <createpoolpoolattrssslallowweak>` and :ref:`getConnection()
     <getconnectiondbattrssslallowweak>` methods and support for
-    ``SSL_WEAK_DN_MATCH`` (an Oracle Database 23c feature). If set, this
+    ``SSL_WEAK_DN_MATCH`` (an Oracle Database 23ai feature). If set, this
     enables ``sslServerDNMatch`` / ``SSL_SERVER_DN_MATCH`` to check the
     database server certificate (but not the listener) and enables the service
     name to be used for partial DN matching. The search order is: the host
     name, then the Subject Alternative Name (SAN), and then the service name.
 
 #)  Added support to include database error cause/action URLs (introduced from
-    Oracle Database 23c onwards) for ORA error messages.
+    Oracle Database 23ai onwards) for ORA error messages.
 
 #)  Added network connection optimization for multiple database hosts.
     If a host is found to be unreachable during connection, the host is added
@@ -440,7 +443,7 @@ Thin Mode Changes
     same certificate.
 
 #)  Fixed bug with duplicate data for queries that exceed 2016 columns (only
-    possible with Oracle Database 23c).
+    possible with Oracle Database 23ai).
 
 Thick Mode Changes
 ++++++++++++++++++
@@ -647,7 +650,7 @@ node-oracledb `v6.0.0 <https://github.com/oracle/node-oracledb/compare/v5.5.0...
     - Changed ``oracledb.DB_TYPE_*`` constants to be ``DbType`` objects
       instead of numbers.
 
-    - Added support for the Oracle Database 23c BOOLEAN SQL type.
+    - Added support for the Oracle Database 23ai BOOLEAN SQL type.
 
     - Fixed type used when fetching NCLOB as a string.
 

doc/src/user_guide/appendix_a.rst

@@ -128,7 +128,7 @@ node-oracledb Thin and Thick modes. For more details see :ref:`modediff`.
     * - Oracle Database Dedicated Servers, Shared Servers, and Database Resident Connection Pooling (DRCP) (see :ref:`drcp`)
       - Yes
       - Yes
-    * - Oracle Database 23c Implicit connection pooling for DRCP and PRCP (see :ref:`implicitpool`)
+    * - Oracle Database 23ai Implicit connection pooling for DRCP and PRCP (see :ref:`implicitpool`)
       - Yes
       - Yes
     * - Multitenant Databases
@@ -278,10 +278,10 @@ node-oracledb Thin and Thick modes. For more details see :ref:`modediff`.
     * - Oracle Database 21c JSON data type (see :ref:`json21ctype`)
       - Yes
       - Yes
-    * - Oracle Database 23c JSON duality view
+    * - Oracle Database 23ai JSON duality view
       - Yes
       - Yes
-    * - Oracle Database 23c BOOLEAN data type (see :ref:`oracledbconstantsdbtype`)
+    * - Oracle Database 23ai BOOLEAN data type (see :ref:`oracledbconstantsdbtype`)
       - Yes
       - Yes
     * - ROWID, UROWID data types (see :ref:`oracledbconstantsdbtype`)
@@ -299,6 +299,9 @@ node-oracledb Thin and Thick modes. For more details see :ref:`modediff`.
     * - NCHAR, NVARCHAR2, NCLOB data types (see :ref:`oracledbconstantsdbtype`)
       - Yes
       - Yes
+    * - Oracle Database 23c VECTOR data type (see :ref:`oracledbconstantsdbtype`)
+      - Yes
+      - Yes
     * - Bind PL/SQL Boolean
       - Yes
       - Yes