Skip to content

Commit d9d4bee

Browse files
Remove use of encoding and nencoding in the documentation.
1 parent a9921bf commit d9d4bee

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

doc/src/user_guide/appendix_c.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -524,12 +524,13 @@ following steps:
524524
4. Review obsolete encoding parameters in calls to :func:`oracledb.connect()`,
525525
``oracledb.Connection()``, and ``oracledb.SessionPool()``:
526526

527-
- ``encoding`` and ``nencoding`` are ignored by python-oracledb. The
528-
python-oracledb driver uses UTF-8 exclusively.
527+
- ``encoding`` and ``nencoding`` are desupported in python-oracledb and must
528+
be removed. The python-oracledb driver uses UTF-8 exclusively.
529529

530-
- ``threaded`` is ignored in :func:`oracledb.connect()` and
531-
``oracledb.Connection()`` by python-oracledb. This parameter was already
532-
ignored in ``oracledb.SessionPool()`` from cx_Oracle 8.2.
530+
- ``threaded`` is desupported in :func:`oracledb.connect()` and
531+
``oracledb.Connection()`` by python-oracledb and must be removed. This
532+
parameter was already ignored in ``oracledb.SessionPool()`` from cx_Oracle
533+
8.2.
533534

534535
5. Remove all references to :meth:`Cursor.fetchraw()` as this method was
535536
deprecated in cx_Oracle 8.2 and has been removed in python-oracledb.

doc/src/user_guide/globalization.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,10 @@ To find the database's national character set, execute the query:
5151
Setting the Client Character Set
5252
--------------------------------
5353

54-
In python-oracledb, the encoding used for all character data is "UTF-8". The
55-
``encoding`` and ``nencoding`` parameters of the :meth:`oracledb.connect`
56-
and :meth:`oracledb.create_pool` methods are deprecated and ignored.
54+
In python-oracledb, the encoding used for all character data is "UTF-8". Older
55+
versions of the driver allowed ``encoding`` and ``nencoding`` parameters to be
56+
passed to the :meth:`oracledb.connect` and :meth:`oracledb.create_pool` methods
57+
but these parameters are now desupported.
5758

5859
.. _timezonefiles:
5960

doc/src/user_guide/startup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ of the database that should be started:
2929
connection.startup()
3030
3131
# the following statements must be issued in normal SYSDBA mode
32-
connection = oracledb.connect(mode=oracledb.SYSDBA, encoding="UTF-8")
32+
connection = oracledb.connect(mode=oracledb.SYSDBA)
3333
cursor = connection.cursor()
3434
cursor.execute("alter database mount")
3535
cursor.execute("alter database open")

0 commit comments

Comments
 (0)