Skip to content

Commit 27f1104

Browse files
Updates to deprecations section of documentation.
1 parent 672af3b commit 27f1104

File tree

1 file changed

+40
-37
lines changed

1 file changed

+40
-37
lines changed

Diff for: doc/src/api_manual/deprecations.rst

+40-37
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
.. _deprecations:
22

3-
************
4-
Deprecations
5-
************
3+
***********************************
4+
Deprecated and Desupported Features
5+
***********************************
66

7-
The following tables contain all of the deprecations in the python-oracledb API,
8-
when they were first deprecated and a comment on what should be used instead,
9-
if applicable. The most recent deprecations are listed first.
7+
The following tables contain the deprecated and desupported features of the
8+
python-oracledb API, and the replacement to be used instead, if applicable.
9+
The desupported API feature is a previous deprecation that has been removed
10+
and is no longer available in python-oracledb. The most recent deprecated and
11+
desupported features are listed first.
1012

1113
.. list-table-with-summary:: Desupported in python-oracledb 2.0
1214
:header-rows: 1
1315
:class: wy-table-responsive
14-
:summary: The first column, Name, displays the desupported feature. The second column, Comments, includes information about the desupport and what replacement to make, if applicable.
16+
:summary: The first column, Name, displays the desupported feature. The second column, Comments, includes information about the desupport and the replacement to use, if applicable.
1517
:name: _desupported_2_0
1618

1719
* - Name
@@ -52,7 +54,7 @@ if applicable. The most recent deprecations are listed first.
5254
.. list-table-with-summary:: Deprecated in python-oracledb 2.0
5355
:header-rows: 1
5456
:class: wy-table-responsive
55-
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecatation and what replacement to use, if applicable.
57+
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecation and the replacement to use, if applicable.
5658
:name: _deprecations_2_0
5759

5860
* - Name
@@ -71,7 +73,7 @@ if applicable. The most recent deprecations are listed first.
7173
.. list-table-with-summary:: Deprecated in python-oracledb 1.4
7274
:header-rows: 1
7375
:class: wy-table-responsive
74-
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecatation and what replacement to use, if applicable.
76+
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecation and the replacement to use, if applicable.
7577
:name: _deprecations_1_4
7678

7779
* - Name
@@ -84,17 +86,17 @@ if applicable. The most recent deprecations are listed first.
8486
.. list-table-with-summary:: Deprecated in python-oracledb 1.0
8587
:header-rows: 1
8688
:class: wy-table-responsive
87-
:summary: The first column, Name, displays the deprecated API name. The second column, Comments, includes information about when the API was deprecated and what API to use, if applicable.
89+
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecation and the replacement to use, if applicable.
8890
:name: _deprecations_1
8991

9092
* - Name
9193
- Comments
92-
* - `SessionPool class <https://cx-oracle.readthedocs.io/en/latest/api_manual/session_pool.html#sessionpool-object>`_ and use of `cx_Oracle.SessionPool() <https://cx-oracle.readthedocs.io/en/latest/api_manual/module.html#cx_Oracle.SessionPool>`_.
94+
* - `SessionPool class <https://cx-oracle.readthedocs.io/en/latest/api_manual/session_pool.html#sessionpool-object>`_ and use of `cx_Oracle.SessionPool() <https://cx-oracle.readthedocs.io/en/latest/api_manual/module.html#cx_Oracle.SessionPool>`_
9395
- Replace by the equivalent :ref:`ConnectionPool Class <connpool>`. Use the new method :meth:`oracledb.create_pool()` to create connection pools.
9496
* - :meth:`Connection.begin()`
95-
- Replace by the new :ref:`tcp` functionality.
97+
- Replace by the new :ref:`Two-Phase Commits (TPC) <tcp>` functionality.
9698
* - :meth:`Connection.prepare()`
97-
- Replace by the new :ref:`tcp` functionality.
99+
- Replace by the new :ref:`Two-Phase Commits (TPC) <tcp>` functionality.
98100
* - Parameters ``encoding`` and ``nencoding`` of the :func:`oracledb.connect()`, :func:`oracledb.create_pool()` and ``oracledb.SessionPool()`` methods
99101
- The encodings in use are always UTF-8.
100102
* - Parameter ``threaded`` of the :meth:`oracledb.connect()` method
@@ -157,32 +159,33 @@ of python-oracledb.
157159
Some of the previous deprecations that have been removed and are not available in
158160
python-oracledb are listed below:
159161

160-
- The previously deprecated function `Cursor.fetchraw() <https://cx-oracle.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.fetchraw>`__ has been removed in
161-
python-oracledb. Use one of the other fetch methods such as :meth:`Cursor.fetchmany()`
162-
instead.
163-
164-
- The previously deprecated function `Cursor.executemanyprepared() <https://cx-oracle.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.executemanyprepared>`__ has been removed
165-
in python-oracledb. Use :meth:`Cursor.executemany()` instead.
166-
167-
- The previously deprecated function `Cursor.rowcount() <https://cx-oracle.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.rowcount>`__ has been removed
168-
in python-oracledb. Use :meth:`Cursor.executemany()` instead.
169-
170-
- The previously deprecated Advanced Queuing (AQ) API has been removed in
171-
python-oracledb. Use the new AQ API instead. AQ is only available in the
172-
python-oracledb Thick mode.
173-
174-
- Replace `Connection.deq() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.deq>`__ with :meth:`Queue.deqone()` or :meth:`Queue.deqmany()`.
175-
176-
- Replace `Connection.deqoptions() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.deqoptions>`__ with :meth:`Queue.deqoptions()`.
177-
178-
- Replace `Connection.enq() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.enq>`__ with :meth:`Queue.enqone()` or :meth:`Queue.enqmany()`.
162+
.. list-table-with-summary:: Desupported in python-oracledb 1.0
163+
:header-rows: 1
164+
:class: wy-table-responsive
165+
:summary: The first column, Name, displays the desupported feature. The second column, Comments, includes information about the desupport and the replacement to use, if applicable.
166+
:name: _desupported_1
179167

180-
- Replace `Connection.enqoptions() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.enqoptions>`__ with :meth:`Queue.enqoptions()`.
168+
* - Name
169+
- Comments
170+
* - `Cursor.fetchraw() <https://cx-oracle.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.fetchraw>`__
171+
- Use one of the other fetch methods such as :meth:`Cursor.fetchmany()` instead.
172+
* - `Cursor.executemanyprepared() <https://cx-oracle.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.executemanyprepared>`__
173+
- Use :meth:`Cursor.executemany()` instead.
174+
* - Previously deprecated Advanced Queuing (AQ) API
175+
- Use the new :ref:`AQ API <aq>` instead. AQ is only available in the python-oracledb Thick mode.
176+
* - `Connection.deq() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.deq>`__
177+
- Replace with :meth:`Queue.deqone()` or :meth:`Queue.deqmany()`
178+
* - `Connection.deqoptions() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.deqoptions>`__
179+
- Replace with :attr:`Queue.deqoptions`
180+
* - `Connection.enq() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.enq>`__
181+
- Replace with :meth:`Queue.enqone()` or :meth:`Queue.enqmany()`
182+
* - `Connection.enqoptions() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.enqoptions>`__
183+
- Replace with :attr:`Queue.enqoptions`
181184

182185
.. list-table-with-summary:: Deprecated in cx_Oracle 8.2
183186
:header-rows: 1
184187
:class: wy-table-responsive
185-
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecatation and what replacement to use, if applicable.
188+
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecation and the replacement to use, if applicable.
186189
:name: _deprecations_8_2
187190

188191
* - Name
@@ -278,7 +281,7 @@ python-oracledb are listed below:
278281
.. list-table-with-summary:: Deprecated in cx_Oracle 8.0
279282
:header-rows: 1
280283
:class: wy-table-responsive
281-
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecatation and what replacement to use, if applicable.
284+
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecation and the replacement to use, if applicable.
282285
:name: _deprecations_8_0
283286

284287
* - Name
@@ -320,7 +323,7 @@ python-oracledb are listed below:
320323
.. list-table-with-summary:: Deprecated in cx_Oracle 7.2
321324
:header-rows: 1
322325
:class: wy-table-responsive
323-
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecatation and what replacement to use, if applicable.
326+
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecation and the replacement to use, if applicable.
324327
:name: _deprecations_7_2
325328

326329
* - Name
@@ -338,7 +341,7 @@ python-oracledb are listed below:
338341
.. list-table-with-summary:: Deprecated in cx_Oracle 6.4
339342
:header-rows: 1
340343
:class: wy-table-responsive
341-
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecatation and what replacement to use, if applicable.
344+
:summary: The first column, Name, displays the deprecated feature. The second column, Comments, includes information about the deprecation and the replacement to use, if applicable.
342345
:name: _deprecations_6_4
343346

344347
* - Name

0 commit comments

Comments
 (0)