Skip to content

Commit 3840873

Browse files
committed
Documentation updates for 6.6 features
1 parent 3ad2bab commit 3840873

File tree

3 files changed

+52
-10
lines changed

3 files changed

+52
-10
lines changed

doc/src/api_manual/oracledb.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2128,6 +2128,16 @@ Oracledb Methods
21282128
For node-oracledb Thick mode, use an :ref:`Easy Connect string <easyconnect>` or a :ref:`Connect Descriptor string <embedtns>` instead.
21292129

21302130
.. versionadded:: 6.0
2131+
* - ``walletContent``
2132+
- String
2133+
- Thin
2134+
- .. _createpoolpoolattrswalletcontent:
2135+
2136+
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.
2137+
2138+
The value of the ``walletContent`` property overrides the ``walletLocation`` value and the ``WALLET_LOCATION`` parameter in the connection string.
2139+
2140+
.. versionadded:: 6.6
21312141
* - ``edition``
21322142
- String
21332143
- Thick
@@ -2836,6 +2846,16 @@ Oracledb Methods
28362846
For node-oracledb Thick mode, use an :ref:`Easy Connect string <easyconnect>` or a :ref:`Connect Descriptor string <embedtns>` instead.
28372847

28382848
.. versionadded:: 6.0
2849+
* - ``walletContent``
2850+
- String
2851+
- Thin
2852+
- .. _getconnectiondbattrswalletcontent:
2853+
2854+
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.
2855+
2856+
The value of the ``walletContent`` property overrides the ``walletLocation`` value and the ``WALLET_LOCATION`` parameter in the connection string.
2857+
2858+
.. versionadded:: 6.6
28392859
* - ``edition``
28402860
- String
28412861
- Thick

doc/src/release_notes.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Common Changes
1818
configuration information from the supported provider and uses it to
1919
connect to the database.
2020

21-
#) Added support for ``oracledb.DB_TYPE_BFILE`` data type.
21+
#) Added support for ``oracledb.DB_TYPE_BFILE`` data type.
2222

23-
#) Test and documentation updates.
23+
#) Test and documentation updates.
2424

2525
Thin Mode Changes
2626
+++++++++++++++++
@@ -30,7 +30,7 @@ Thin Mode Changes
3030
wallet content directly instead of storing and reading it up from a file.
3131
See `Issue #1671 <https://github.com/oracle/node-oracledb/issues/
3232
1671>`__.
33-
33+
3434
#) Added support to use ``IFILE`` parameter to embed custom
3535
network configuration files in the :ref:`tnsnames.ora <tnsadmin>` file.
3636

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

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

5252
Thick Mode Changes
5353
+++++++++++++++++++
@@ -57,9 +57,9 @@ Thick Mode Changes
5757

5858
#) Added binary for the macOS ARM64 platform.
5959

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

6464
node-oracledb `v6.5.1 <https://github.com/oracle/node-oracledb/compare/v6.5.0...v6.5.1>`__ (23 May 2024)
6565
---------------------------------------------------------------------------------------------------------

doc/src/user_guide/connection_handling.rst

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3760,6 +3760,17 @@ connect as the ADMIN user using the ``cjdb1_high`` connection string:
37603760
walletPassword: wp
37613761
});
37623762
3763+
Instead of storing and reading the content from the ``ewallet.pem`` file which
3764+
is specified in the ``walletLocation`` property, you can use the
3765+
:ref:`walletContent <getconnectiondbattrswalletcontent>` property to directly
3766+
specify the security credentials required to establish a mutual TLS connection
3767+
to Oracle Database. This property was introduced in node-oracledb 6.6 and can
3768+
be used with the :meth:`oracledb.getConnection()` and
3769+
:meth:`oracledb.createPool()` methods. The value of this property takes
3770+
precedence and overrides the ``walletLocation`` property value of
3771+
:meth:`oracledb.getConnection()`, or the ``WALLET_LOCATION`` parameter
3772+
in the connection string.
3773+
37633774
**In node-oracledb Thick Mode**
37643775
37653776
For node-oracledb in Thick mode, only these files from the zip are needed:
@@ -3961,9 +3972,20 @@ example, using OpenSSL::
39613972
openssl pkcs12 -in ewallet.p12 -out wallet.pem
39623973
39633974
Once the PEM file has been created, you can use it by passing its directory
3964-
location as the ``walletLocation`` parameter to :meth:`oracledb.getconnection()` or
3965-
:meth:`oracledb.createPool()`. These methods also accept a ``walletPassword``
3966-
parameter, which can be the passphrase that was specified when the above
3975+
location as the ``walletLocation`` property to
3976+
:meth:`oracledb.getconnection()` or :meth:`oracledb.createPool()`. Instead of
3977+
storing and reading the content from the ``ewallet.pem`` file which is
3978+
specified in the ``walletLocation`` property, you can use the
3979+
``walletContent`` property to directly specify the security credentials
3980+
required to establish a mutual TLS connection to Oracle Database. The
3981+
``walletContent`` property was introduced in node-oracledb 6.6 and can be used
3982+
with :meth:`~oracledb.getConnection()` and :meth:`~oracledb.createPool()`. The
3983+
value of this property takes precedence and overrides the ``walletLocation``
3984+
value set in :meth:`~oracledb.getConnection()` or
3985+
:meth:`~oracledb.createPool()`, or the ``WALLET_LOCATION`` parameter in the
3986+
connection string. The :meth:`~oracledb.getConnection()` and
3987+
:meth:`~oracledb.createPool()` methods also accept a ``walletPassword``
3988+
property, which can be the passphrase that was specified when the above
39673989
openSSL command was run. See :ref:`connectionadbmtls`.
39683990
39693991
.. _connmultiwallets:

0 commit comments

Comments
 (0)