Skip to content

Commit 7aebce2

Browse files
Doc updates.
1 parent fd76c9c commit 7aebce2

File tree

4 files changed

+24
-16
lines changed

4 files changed

+24
-16
lines changed

doc/src/api_manual/module.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ Oracledb Methods
364364

365365
The ``use_sni`` parameter is expected to be a boolean which indicates
366366
whether to use the TLS Server Name Indicator (SNI) extension to bypass the
367-
second TLS neogiation that would otherwise be required. This parameter is
367+
second TLS negotiation that would otherwise be required. This parameter is
368368
used in both python-oracledb Thin and Thick modes. The default value is
369369
False.
370370

@@ -697,7 +697,7 @@ Oracledb Methods
697697

698698
The ``use_sni`` parameter is expected to be a boolean which indicates
699699
whether to use the TLS Server Name Indicator (SNI) extension to bypass the
700-
second TLS neogiation that would otherwise be required. This parameter is
700+
second TLS negotiation that would otherwise be required. This parameter is
701701
used in both python-oracledb Thin and Thick modes. The default value is
702702
False.
703703

@@ -1041,7 +1041,7 @@ Oracledb Methods
10411041

10421042
The ``use_sni`` parameter is expected to be a boolean which indicates
10431043
whether to use the TLS Server Name Indicator (SNI) extension to bypass the
1044-
second TLS neogiation that would otherwise be required. This parameter is
1044+
second TLS negotiation that would otherwise be required. This parameter is
10451045
used in both python-oracledb Thin and Thick modes. The default value is
10461046
False.
10471047

@@ -1522,7 +1522,7 @@ Oracledb Methods
15221522

15231523
The ``use_sni`` parameter is expected to be a boolean which indicates
15241524
whether to use the TLS Server Name Indicator (SNI) extension to bypass the
1525-
second TLS neogiation that would otherwise be required. This parameter is
1525+
second TLS negotiation that would otherwise be required. This parameter is
15261526
used in both python-oracledb Thin and Thick modes. The default value is
15271527
False.
15281528

@@ -1919,7 +1919,7 @@ Oracledb Methods
19191919

19201920
The ``use_sni`` parameter is expected to be a boolean which indicates
19211921
whether to use the TLS Server Name Indicator (SNI) extension to bypass the
1922-
second TLS neogiation that would otherwise be required. This parameter is
1922+
second TLS negotiation that would otherwise be required. This parameter is
19231923
used in both python-oracledb Thin and Thick modes. The default value is
19241924
False.
19251925

@@ -2123,7 +2123,8 @@ Oracledb Methods
21232123
``is_thin_mode()`` will never change for the lifetime of the process.
21242124

21252125
The attribute :attr:`Connection.thin` can be used to check a connection's
2126-
mode.
2126+
mode. The attribute :attr:`ConnectionPool.thin` can be used to check a
2127+
pool's mode.
21272128

21282129
.. note::
21292130

@@ -2495,7 +2496,7 @@ Oracledb Methods
24952496

24962497
The ``use_sni`` parameter is expected to be a boolean which indicates
24972498
whether to use the TLS Server Name Indicator (SNI) extension to bypass the
2498-
second TLS neogiation that would otherwise be required. This parameter is
2499+
second TLS negotiation that would otherwise be required. This parameter is
24992500
used in both python-oracledb Thin and Thick modes. The default value is
25002501
False.
25012502

doc/src/user_guide/bind.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ more than once with different data values. If you do not use bind variables,
2929
Oracle must reparse and cache multiple statements. When using bind variables,
3030
Oracle Database may be able to reuse the statement execution plan and context.
3131

32-
.. note::
32+
.. warning::
3333

3434
Never concatenate or interpolate user data into SQL statements:
3535

doc/src/user_guide/connection_handling.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2091,10 +2091,11 @@ shrinkage is only initiated when the pool is accessed so pools in fully dormant
20912091
applications will not shrink until the application is next used.
20922092

20932093
For pools created with :ref:`external authentication <extauth>`, with
2094-
:ref:`homogeneous <connpooltypes>` set to False, or when using :ref:`drcp`,
2095-
then the number of connections opened at pool creation is zero even if a larger
2096-
value is specified for ``min``. Also, in these cases the pool increment unit
2097-
is always 1 regardless of the value of ``increment``.
2094+
:ref:`homogeneous <connpooltypes>` set to False, or when using :ref:`drcp` (in
2095+
python-oracledb Thick mode), then the number of connections opened at pool
2096+
creation is zero even if a larger value is specified for ``min``. Also, in
2097+
these cases the pool increment unit is always 1 regardless of the value of
2098+
``increment``.
20982099

20992100
.. _poolhealth:
21002101

@@ -2774,6 +2775,10 @@ state can optionally be specified. See the Oracle Database documentation on
27742775
dblatest&id=GUID-661BB906-74D2-4C5D-9C7E-2798F76501B3>`__ for more information
27752776
on purity and connection classes.
27762777

2778+
Note that when using DRCP with a python-oracledb local :ref:`connection pool
2779+
<connpooling>` in Thick mode, the local connection pool ``min`` value is
2780+
ignored and the pool will be created with zero connections.
2781+
27772782
**Requesting a Pooled Server**
27782783

27792784
To request a DRCP pooled server, you can:

doc/src/user_guide/tracing.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -248,11 +248,13 @@ Finding the python-oracledb Mode
248248

249249
The boolean attributes :attr:`Connection.thin` and :attr:`ConnectionPool.thin`
250250
can be used to show the current mode of a python-oracledb connection or pool,
251-
respectively. The python-oracledb version can be shown with
252-
:data:`oracledb.__version__`.
251+
respectively. The method :meth:`oracledb.is_thin_mode()` can also be used, but
252+
review its usage notes about when its return value may change.
253253

254-
The information can also be seen in the Oracle Database data dictionary table
255-
V$SESSION_CONNECT_INFO:
254+
The python-oracledb version can be shown with :data:`oracledb.__version__`.
255+
256+
Version and mode information can also be seen in the Oracle Database data
257+
dictionary table V$SESSION_CONNECT_INFO:
256258

257259
.. code-block:: python
258260

0 commit comments

Comments
 (0)