Skip to content

Commit 4e9246e

Browse files
anthony-tuiningaanthony-tuininga
committed
Documentation updates.
1 parent 2bd2131 commit 4e9246e

File tree

9 files changed

+155
-128
lines changed

9 files changed

+155
-128
lines changed

‎README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ See [python-oracledb Installation][installation].
2020

2121
- Python versions 3.8 through 3.13.
2222

23-
Prebuilt packages are available for these Python versions on Windows, on
24-
macOS and on Linux.
23+
Pre-built packages are available on [PyPI][pypi] and other repositories.
2524

2625
Source code is also available.
2726

27+
Previous versions of python-oracledb supported older Python versions.
28+
2829
- Oracle Client libraries are *optional*.
2930

3031
**Thin mode**: By default python-oracledb runs in a 'Thin' mode which
@@ -98,3 +99,4 @@ See [LICENSE][license], [THIRD_PARTY_LICENSES][tplicense], and
9899
[installation]: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
99100
[features]: https://oracle.github.io/python-oracledb/#features
100101
[concurrent]: https://python-oracledb.readthedocs.io/en/latest/user_guide/asyncio.html
102+
[pypi]: https://pypi.org/project/oracledb

‎doc/src/api_manual/connect_params.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ ConnectParams Attributes
410410
throughput for large queries or bulk data loads, but at the cost of higher
411411
memory use. The SDU size that will actually be used is negotiated down to
412412
the lower of this value and the database network SDU configuration value.
413-
See the `SQL*Net documentation
413+
See the `Database Net Services documentation
414414
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&
415415
id=GUID-86D61D6F-AD26-421A-BABA-77949C8A2B04>`__ for more details.
416416

‎doc/src/api_manual/connection.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -823,14 +823,18 @@ Connection Attributes
823823

824824
This read-only attribute returns the logical transaction id for the
825825
connection. It is used within Oracle Transaction Guard as a means of
826-
ensuring that transactions are not duplicated. See the Oracle documentation
827-
and the provided sample for more information.
826+
ensuring that transactions are not duplicated. See :ref:`tg` for more
827+
information.
828828

829-
.. note:
829+
.. versionchanged:: 3.0.0
830+
831+
This attribute was added to python-oracledb Thin mode.
832+
833+
.. note::
830834

831835
This attribute is an extension to the DB API definition. It is only
832-
available with Oracle Database 12.1 or higher. In python-oracledb Thick
833-
mode, it also requires Oracle Client libraries 12.1 or higer.
836+
available with Oracle Database 12.1 or later. In python-oracledb Thick
837+
mode, it also requires Oracle Client libraries 12.1 or later.
834838

835839
.. attribute:: Connection.max_identifier_length
836840

‎doc/src/api_manual/connection_pool.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,10 @@ ConnectionPool Attributes
225225
or later must be used and, prior to Oracle Client 21, cleanup only occurs
226226
when the pool is accessed.
227227

228+
.. versionchanged:: 3.0.0
229+
230+
This attribute was added to python-oracledb Thin mode.
231+
228232
.. attribute:: ConnectionPool.max_sessions_per_shard
229233

230234
This read-write attribute returns the number of sessions that can be

‎doc/src/api_manual/module.rst

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,9 @@ Oracledb Methods
325325
requested size of the Session Data Unit (SDU), in bytes. The value tunes
326326
internal buffers used for communication to the database. Bigger values can
327327
increase throughput for large queries or bulk data loads, but at the cost
328-
of higher memory use. The SDU size that will actually be used is
329-
negotiated down to the lower of this value and the database network SDU
330-
configuration value. See the `SQL*Net documentation <https://www.oracle.
328+
of higher memory use. The SDU size that will actually be used is negotiated
329+
down to the lower of this value and the database network SDU configuration
330+
value. See the `Database Net Services documentation <https://www.oracle.
331331
com/pls/topic/lookup?ctx=dblatest&id=GUID-86D61D6F-AD26-421A-BABA-
332332
77949C8A2B04>`__ for more details. This value is used in both the
333333
python-oracledb Thin and Thick modes. The default value is *8192* bytes.
@@ -370,8 +370,9 @@ Oracledb Methods
370370
whether to use the TLS Server Name Indication (SNI) extension to bypass the
371371
second TLS negotiation that would otherwise be required. This parameter is
372372
used in both python-oracledb Thin and Thick modes. This parameter requires
373-
Oracle Database 23.7. The default value is *False*. See the `SQL*Net
374-
documentation <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
373+
Oracle Database 23.7. The default value is *False*. See the `Database Net
374+
Services documentation
375+
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
375376
GUID-E98F42D0-DC9D-4B52-9C66-6DE7EC5F64D6>`__ for more details.
376377

377378
The ``program`` parameter is expected to be a string which specifies the
@@ -685,9 +686,9 @@ Oracledb Methods
685686
requested size of the Session Data Unit (SDU), in bytes. The value tunes
686687
internal buffers used for communication to the database. Bigger values can
687688
increase throughput for large queries or bulk data loads, but at the cost
688-
of higher memory use. The SDU size that will actually be used is
689-
negotiated down to the lower of this value and the database network SDU
690-
configuration value. See the `SQL*Net documentation <https://www.oracle.
689+
of higher memory use. The SDU size that will actually be used is negotiated
690+
down to the lower of this value and the database network SDU configuration
691+
value. See the `Database Net Services documentation <https://www.oracle.
691692
com/pls/topic/lookup?ctx=dblatest&id=GUID-86D61D6F-AD26-421A-BABA-
692693
77949C8A2B04>`__ for more details. The default value is *8192* bytes.
693694

@@ -729,8 +730,9 @@ Oracledb Methods
729730
whether to use the TLS Server Name Indication (SNI) extension to bypass the
730731
second TLS negotiation that would otherwise be required. This parameter is
731732
used in both python-oracledb Thin and Thick modes. This parameter requires
732-
Oracle Database 23.7. The default value is *False*. See the `SQL*Net
733-
documentation <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
733+
Oracle Database 23.7. The default value is *False*. See the `Database Net
734+
Services documentation
735+
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
734736
GUID-E98F42D0-DC9D-4B52-9C66-6DE7EC5F64D6>`__ for more details.
735737

736738
The ``program`` parameter is expected to be a string which specifies the
@@ -1043,9 +1045,9 @@ Oracledb Methods
10431045
requested size of the Session Data Unit (SDU), in bytes. The value tunes
10441046
internal buffers used for communication to the database. Bigger values can
10451047
increase throughput for large queries or bulk data loads, but at the cost
1046-
of higher memory use. The SDU size that will actually be used is
1047-
negotiated down to the lower of this value and the database network SDU
1048-
configuration value. See the `SQL*Net documentation <https://www.oracle.
1048+
of higher memory use. The SDU size that will actually be used is negotiated
1049+
down to the lower of this value and the database network SDU configuration
1050+
value. See the `Database Net Services documentation <https://www.oracle.
10491051
com/pls/topic/lookup?ctx=dblatest&id=GUID-86D61D6F-AD26-421A-BABA-
10501052
77949C8A2B04>`__ for more details. This value is used in both the
10511053
python-oracledb Thin and Thick modes. The default value is *8192* bytes.
@@ -1088,8 +1090,9 @@ Oracledb Methods
10881090
whether to use the TLS Server Name Indication (SNI) extension to bypass the
10891091
second TLS negotiation that would otherwise be required. This parameter is
10901092
used in both python-oracledb Thin and Thick modes. This parameter requires
1091-
Oracle Database 23.7. The default value is *False*. See the `SQL*Net
1092-
documentation <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
1093+
Oracle Database 23.7. The default value is *False*. See the `Database Net
1094+
Services documentation
1095+
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
10931096
GUID-E98F42D0-DC9D-4B52-9C66-6DE7EC5F64D6>`__ for more details.
10941097

10951098
The ``program`` parameter is expected to be a string which specifies the
@@ -1546,9 +1549,9 @@ Oracledb Methods
15461549
requested size of the Session Data Unit (SDU), in bytes. The value tunes
15471550
internal buffers used for communication to the database. Bigger values can
15481551
increase throughput for large queries or bulk data loads, but at the cost
1549-
of higher memory use. The SDU size that will actually be used is
1550-
negotiated down to the lower of this value and the database network SDU
1551-
configuration value. See the `SQL*Net documentation <https://www.oracle.
1552+
of higher memory use. The SDU size that will actually be used is negotiated
1553+
down to the lower of this value and the database network SDU configuration
1554+
value. See the `Database Net Services documentation <https://www.oracle.
15521555
com/pls/topic/lookup?ctx=dblatest&id=GUID-86D61D6F-AD26-421A-BABA-
15531556
77949C8A2B04>`__ for more details. This value is used in both the
15541557
python-oracledb Thin and Thick modes. The default value is *8192* bytes.
@@ -1591,8 +1594,9 @@ Oracledb Methods
15911594
whether to use the TLS Server Name Indication (SNI) extension to bypass the
15921595
second TLS negotiation that would otherwise be required. This parameter is
15931596
used in both python-oracledb Thin and Thick modes. This parameter requires
1594-
Oracle Database 23.7. The default value is *False*. See the `SQL*Net
1595-
documentation <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
1597+
Oracle Database 23.7. The default value is *False*. See the `Database Net
1598+
Services documentation
1599+
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
15961600
GUID-E98F42D0-DC9D-4B52-9C66-6DE7EC5F64D6>`__ for more details.
15971601

15981602
The ``program`` parameter is expected to be a string which specifies the
@@ -1969,9 +1973,9 @@ Oracledb Methods
19691973
requested size of the Session Data Unit (SDU), in bytes. The value tunes
19701974
internal buffers used for communication to the database. Bigger values can
19711975
increase throughput for large queries or bulk data loads, but at the cost
1972-
of higher memory use. The SDU size that will actually be used is
1973-
negotiated down to the lower of this value and the database network SDU
1974-
configuration value. See the `SQL*Net documentation <https://www.oracle.
1976+
of higher memory use. The SDU size that will actually be used is negotiated
1977+
down to the lower of this value and the database network SDU configuration
1978+
value. See the `Database Net Services documentation <https://www.oracle.
19751979
com/pls/topic/lookup?ctx=dblatest&id=GUID-86D61D6F-AD26-421A-BABA-
19761980
77949C8A2B04>`__ for more details. The default value is *8192* bytes.
19771981

@@ -2013,8 +2017,9 @@ Oracledb Methods
20132017
whether to use the TLS Server Name Indication (SNI) extension to bypass the
20142018
second TLS negotiation that would otherwise be required. This parameter is
20152019
used in both python-oracledb Thin and Thick modes. This parameter requires
2016-
Oracle Database 23.7. The default value is *False*. See the `SQL*Net
2017-
documentation <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
2020+
Oracle Database 23.7. The default value is *False*. See the `Database Net
2021+
Services documentation
2022+
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
20182023
GUID-E98F42D0-DC9D-4B52-9C66-6DE7EC5F64D6>`__ for more details.
20192024

20202025
The ``program`` parameter is expected to be a string which specifies the
@@ -2593,9 +2598,9 @@ Oracledb Methods
25932598
requested size of the Session Data Unit (SDU), in bytes. The value tunes
25942599
internal buffers used for communication to the database. Bigger values can
25952600
increase throughput for large queries or bulk data loads, but at the cost
2596-
of higher memory use. The SDU size that will actually be used is
2597-
negotiated down to the lower of this value and the database network SDU
2598-
configuration value. See the `SQL*Net documentation <https://www.oracle.
2601+
of higher memory use. The SDU size that will actually be used is negotiated
2602+
down to the lower of this value and the database network SDU configuration
2603+
value. See the `Database Net Services documentation <https://www.oracle.
25992604
com/pls/topic/lookup?ctx=dblatest&id=GUID-86D61D6F-AD26-421A-BABA-
26002605
77949C8A2B04>`__ for more details. This value is used in both the
26012606
python-oracledb Thin and Thick modes. The default value is *8192* bytes.
@@ -2638,8 +2643,9 @@ Oracledb Methods
26382643
whether to use the TLS Server Name Indication (SNI) extension to bypass the
26392644
second TLS negotiation that would otherwise be required. This parameter is
26402645
used in both python-oracledb Thin and Thick modes. This parameter requires
2641-
Oracle Database 23.7. The default value is *False*. See the `SQL*Net
2642-
documentation <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
2646+
Oracle Database 23.7. The default value is *False*. See the `Database Net
2647+
Services documentation
2648+
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
26432649
GUID-E98F42D0-DC9D-4B52-9C66-6DE7EC5F64D6>`__ for more details.
26442650

26452651
The ``program`` parameter is expected to be a string which specifies the

‎doc/src/release_notes.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,10 @@ Common Changes
6464
:attr:`defaults.fetch_decimals` is set to *True*.
6565
#) Fixed bug when binding a variable that was previously bound as an output
6666
variable in a DML RETURNING statement.
67-
#) An error message that links to documention on setting up a protocol hook
68-
function is now returned for "ldap" and "ldaps" connection strings.
67+
#) An error message that links to :ref:`documentation <ldapconnections>` on
68+
setting up a protocol hook function is now returned for LDAP and LDAPS URL
69+
connection strings in python-oracledb thin mode, or when
70+
:attr:`defaults.thick_mode_dsn_passthrough` is *False*.
6971
#) Error ``DPY-2062: payload cannot be enqueued since it does not match the
7072
payload type supported by the queue`` is now raised when the payload of a
7173
message being enqueued is not supported by the queue. Previously,
@@ -2743,9 +2745,9 @@ cx_Oracle 5.3 (March 2017)
27432745
versions of the gcc compiler for Cygwin.
27442746
#) Simplified test suite by combining Python 2 and 3 scripts into one script
27452747
and separated out 12.1 features into a single script.
2746-
#) Updated samples to use code that works on both Python 2 and 3
2748+
#) Updated samples to use code that works on both Python 2 and 3.
27472749
#) Added support for pickling/unpickling error objects
2748-
(`Issue #23 <https://bitbucket.org/anthony_tuininga/cx_oracle/issues/23>`__)
2750+
(Bitbucket Issue #23).
27492751
#) Dropped support for callbacks on OCI functions.
27502752
#) Removed deprecated types UNICODE, FIXED_UNICODE and LONG_UNICODE (use
27512753
NCHAR, FIXED_NCHAR and LONG_NCHAR instead).
@@ -2821,10 +2823,10 @@ cx_Oracle 5.2 (June 2015)
28212823
#) Removed remaining remnants of support Oracle 9i.
28222824
#) Added __version__ attribute to conform with PEP 396.
28232825
#) Ensure that sessions are released to the pool when calling
2824-
connection.close()
2825-
(`Issue #2 <https://bitbucket.org/anthony_tuininga/cx_oracle/issue/2>`__)
2826+
connection.close().
2827+
(Bitbucket Issue #2).
28262828
#) Fixed handling of datetime intervals
2827-
(`Issue #7 <https://bitbucket.org/anthony_tuininga/cx_oracle/issue/7>`__)
2829+
(Bitbucket Issue #7).
28282830

28292831

28302832
cx_Oracle 5.1.3 (May 2014)

‎doc/src/user_guide/appendix_a.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ see :ref:`driverdiff` and :ref:`compatibility`.
252252
- Yes
253253
- Yes
254254
* - Oracle Transactional Event Queues and Advanced Queuing (AQ) (see :ref:`aqusermanual`)
255-
- Yes - only "Classic" queue is supported (RAW, named Oracle object, and JSON payloads)
255+
- Yes - only "Classic" queues are supported (RAW, named Oracle object, and JSON payloads)
256256
- Yes
257257
- Yes
258258
* - Call timeouts (see :attr:`Connection.call_timeout`)

0 commit comments

Comments
 (0)