Skip to content

Commit 592dae9

Browse files
Documentation updates for recent enhancements and other general
improvements to the documentation.
1 parent c8b9a41 commit 592dae9

19 files changed

+469
-108
lines changed

doc/src/api_manual/async_connection.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@ API.
1313

1414
.. versionadded:: 2.0.0
1515

16-
.. note::
17-
18-
The Asynchronous I/O (asyncio) support in python-oracledb 2.0.0 is a
19-
pre-release and may change in the next version.
20-
2116
.. note::
2217

2318
AsyncConnection objects are only supported in the python-oracledb Thin

doc/src/api_manual/async_connection_pool.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ API.
1010

1111
.. versionadded:: 2.0.0
1212

13-
.. note::
14-
15-
The Asynchronous I/O (asyncio) support in python-oracledb 2.0.0 is a
16-
pre-release and may change in the next version.
17-
1813
.. note::
1914

2015
AsyncConnectionPool objects are only supported in the python-oracledb Thin

doc/src/api_manual/async_cursor.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ with ``await``. This object is an extension to the DB API.
1010

1111
.. versionadded:: 2.0.0
1212

13-
.. note::
14-
15-
The Asynchronous I/O (asyncio) support in python-oracledb 2.0.0 is a
16-
pre-release and may change in the next version.
17-
1813
.. note::
1914

2015
AsyncCursor objects are only supported in the python-oracledb Thin mode.

doc/src/api_manual/async_lob.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ Also, this object is returned whenever Oracle :data:`CLOB`, :data:`BLOB` and
1010

1111
See :ref:`lobdata` for more information about using LOBs.
1212

13-
.. note::
14-
15-
The Asynchronous I/O (asyncio) support in python-oracledb 2.0.0 is a
16-
pre-release and may change in the next version.
17-
1813
.. note::
1914

2015
AsyncLOB objects are only supported in the python-oracledb Thin mode.

doc/src/api_manual/connect_param.rst renamed to doc/src/api_manual/connect_params.rst

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,27 @@ ConnectParams Methods
5151
externalauth=None, mode=None, disable_oob=None, stmtcachesize=None, \
5252
edition=None, tag=None, matchanytag=None, config_dir=None, \
5353
appcontext=[], shardingkey=[], supershardingkey=[], debug_jdwp=None, \
54-
connection_id_prefix=None, ssl_context=None, sdu=None, handle=None)
54+
connection_id_prefix=None, ssl_context=None, sdu=None, \
55+
pool_boundary=None, use_tcp_fast_open=False, handle=None)
5556

5657
Sets the default values for one or more of the parameters of an empty
5758
ConnectParams object. A default will be overriden when a connection string
5859
with that attribute is parsed. After a ConnectParams object has been
5960
populated by parsing a connection string, ``ConnectParams.set()`` will not
6061
override any values.
6162

63+
.. versionchanged:: 2.1.0
64+
65+
The ``pool_boundary`` and ``use_tcp_fast_open`` parameters were added.
66+
67+
.. versionchanged:: 2.0.0
68+
69+
The ``ssl_context`` and ``sdu`` parameters were added.
70+
71+
.. versionchanged:: 1.4.0
72+
73+
The ``connection_id_prefix`` parameter was added.
74+
6275

6376
.. _connparamsattr:
6477

@@ -199,6 +212,24 @@ ConnectParams Attributes
199212

200213
This attribute is supported in the python-oracledb Thin and Thick modes.
201214

215+
.. attribute:: ConnectParams.pool_boundary
216+
217+
This read-only attribute is one of the strings "statement" or
218+
"transaction" which indicates when pooled DRCP or PRCP connections can be
219+
returned to the pool. If the value is "statement", then pooled DRCP or
220+
PRCP connections are implicitly released back to the DRCP or PRCP pool
221+
when the connection is stateless (that is, there are no active cursors,
222+
active transactions, temporary tables, or temporary LOBs). If the value is
223+
"transaction", then pooled DRCP or PRCP connections are implicitly
224+
released back to the DRCP or PRCP pool when either one of the methods
225+
:meth:`Connection.commit()` or :meth:`Connection.rollback()` are called.
226+
This attribute requires the use of DRCP or PRCP with Oracle Database 23c
227+
(or later). See :ref:`implicitconnpool` for more information.
228+
229+
This attribute is supported in the python-oracledb Thin and Thick modes.
230+
231+
.. versionadded:: 2.1.0
232+
202233
.. attribute:: ConnectParams.port
203234

204235
This read-only attribute is an integer that returns the port number on
@@ -359,6 +390,20 @@ ConnectParams Attributes
359390

360391
This attribute is supported in the python-oracledb Thin and Thick modes.
361392

393+
.. attribute:: ConnectParams.use_tcp_fast_open
394+
395+
This read-only attribute is a boolean which indicates whether to use an
396+
an `Oracle Autonomous Database Serverless (ADB-S)
397+
<https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/
398+
adbsb/adbsb-overview.html#GUID-A7435462-9D74-44B4-8240-4A6F06E92348>`__
399+
specific feature that can reduce the latency in round-trips to the database
400+
after a connection has been established. This feature is only available
401+
with certain versions of ADB-S. The default value is False.
402+
403+
This attribute is used in both python-oracledb Thin and Thick modes.
404+
405+
.. versionadded:: 2.1.0
406+
362407
.. attribute:: ConnectParams.user
363408

364409
This read-only attribute is a string that specifies the name of the user to

0 commit comments

Comments
 (0)