Skip to content

Commit

Permalink
Documentation updates for 6.6 features
Browse files Browse the repository at this point in the history
  • Loading branch information
sharadraju committed Jul 15, 2024
1 parent 3ad2bab commit 3840873
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 10 deletions.
20 changes: 20 additions & 0 deletions doc/src/api_manual/oracledb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2128,6 +2128,16 @@ Oracledb Methods
For node-oracledb Thick mode, use an :ref:`Easy Connect string <easyconnect>` or a :ref:`Connect Descriptor string <embedtns>` instead.

.. versionadded:: 6.0
* - ``walletContent``
- String
- Thin
- .. _createpoolpoolattrswalletcontent:

The security credentials required to establish a mutual TLS (mTLS) connection to Oracle Database. This property can be used to directly specify the security credentials instead of storing and reading the credentials from the ``ewallet.pem`` file specified in the ``walletLocation`` property.

The value of the ``walletContent`` property overrides the ``walletLocation`` value and the ``WALLET_LOCATION`` parameter in the connection string.

.. versionadded:: 6.6
* - ``edition``
- String
- Thick
Expand Down Expand Up @@ -2836,6 +2846,16 @@ Oracledb Methods
For node-oracledb Thick mode, use an :ref:`Easy Connect string <easyconnect>` or a :ref:`Connect Descriptor string <embedtns>` instead.

.. versionadded:: 6.0
* - ``walletContent``
- String
- Thin
- .. _getconnectiondbattrswalletcontent:

The security credentials required to establish a mutual TLS (mTLS) connection to Oracle Database. This property can be used to directly specify the security credentials instead of storing and reading the credentials from the ``ewallet.pem`` file specified in the ``walletLocation`` property.

The value of the ``walletContent`` property overrides the ``walletLocation`` value and the ``WALLET_LOCATION`` parameter in the connection string.

.. versionadded:: 6.6
* - ``edition``
- String
- Thick
Expand Down
14 changes: 7 additions & 7 deletions doc/src/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Common Changes
configuration information from the supported provider and uses it to
connect to the database.

#) Added support for ``oracledb.DB_TYPE_BFILE`` data type.
#) Added support for ``oracledb.DB_TYPE_BFILE`` data type.

#) Test and documentation updates.
#) Test and documentation updates.

Thin Mode Changes
+++++++++++++++++
Expand All @@ -30,7 +30,7 @@ Thin Mode Changes
wallet content directly instead of storing and reading it up from a file.
See `Issue #1671 <https://github.com/oracle/node-oracledb/issues/
1671>`__.

#) Added support to use ``IFILE`` parameter to embed custom
network configuration files in the :ref:`tnsnames.ora <tnsadmin>` file.

Expand All @@ -47,7 +47,7 @@ Thin Mode Changes
provided for `Issue #1565 <https://github.com/oracle/node-oracledb/issues/
1565>`__.

#) Added :ref:`Two-Phase Commits <tpc>` support.
#) Added :ref:`Two-Phase Commits <twopc>` support.

Thick Mode Changes
+++++++++++++++++++
Expand All @@ -57,9 +57,9 @@ Thick Mode Changes

#) Added binary for the macOS ARM64 platform.

#) Corrected memory leak when dequeuing messages with JSON payloads
(`ODPI-C change
<https://github.com/oracle/odpi/commit/00b16209408ebc827a3a9b256cf9ad3f79e1ddc1>`__).
#) Corrected memory leak when dequeuing messages with JSON payloads
(`ODPI-C change <https://github.com/oracle/odpi/commit/
00b16209408ebc827a3a9b256cf9ad3f79e1ddc1>`__).

node-oracledb `v6.5.1 <https://github.com/oracle/node-oracledb/compare/v6.5.0...v6.5.1>`__ (23 May 2024)
---------------------------------------------------------------------------------------------------------
Expand Down
28 changes: 25 additions & 3 deletions doc/src/user_guide/connection_handling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3760,6 +3760,17 @@ connect as the ADMIN user using the ``cjdb1_high`` connection string:
walletPassword: wp
});
Instead of storing and reading the content from the ``ewallet.pem`` file which
is specified in the ``walletLocation`` property, you can use the
:ref:`walletContent <getconnectiondbattrswalletcontent>` property to directly
specify the security credentials required to establish a mutual TLS connection
to Oracle Database. This property was introduced in node-oracledb 6.6 and can
be used with the :meth:`oracledb.getConnection()` and
:meth:`oracledb.createPool()` methods. The value of this property takes
precedence and overrides the ``walletLocation`` property value of
:meth:`oracledb.getConnection()`, or the ``WALLET_LOCATION`` parameter
in the connection string.
**In node-oracledb Thick Mode**
For node-oracledb in Thick mode, only these files from the zip are needed:
Expand Down Expand Up @@ -3961,9 +3972,20 @@ example, using OpenSSL::
openssl pkcs12 -in ewallet.p12 -out wallet.pem
Once the PEM file has been created, you can use it by passing its directory
location as the ``walletLocation`` parameter to :meth:`oracledb.getconnection()` or
:meth:`oracledb.createPool()`. These methods also accept a ``walletPassword``
parameter, which can be the passphrase that was specified when the above
location as the ``walletLocation`` property to
:meth:`oracledb.getconnection()` or :meth:`oracledb.createPool()`. Instead of
storing and reading the content from the ``ewallet.pem`` file which is
specified in the ``walletLocation`` property, you can use the
``walletContent`` property to directly specify the security credentials
required to establish a mutual TLS connection to Oracle Database. The
``walletContent`` property was introduced in node-oracledb 6.6 and can be used
with :meth:`~oracledb.getConnection()` and :meth:`~oracledb.createPool()`. The
value of this property takes precedence and overrides the ``walletLocation``
value set in :meth:`~oracledb.getConnection()` or
:meth:`~oracledb.createPool()`, or the ``WALLET_LOCATION`` parameter in the
connection string. The :meth:`~oracledb.getConnection()` and
:meth:`~oracledb.createPool()` methods also accept a ``walletPassword``
property, which can be the passphrase that was specified when the above
openSSL command was run. See :ref:`connectionadbmtls`.
.. _connmultiwallets:
Expand Down

0 comments on commit 3840873

Please sign in to comment.