Skip to content

Commit 916bf9e

Browse files
Further doc improvements.
1 parent 136f62d commit 916bf9e

File tree

6 files changed

+306
-232
lines changed

6 files changed

+306
-232
lines changed

doc/src/api_manual/module.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,9 @@ Oracledb Methods
7575
``params`` parameter object. Similar precedence rules also apply to other
7676
values.
7777

78-
The ``dsn`` (data source name) parameter can be a string in the format
79-
``user/password@connect_string`` or can simply be the connect string (in
80-
which case authentication credentials such as the username and password
81-
need to be specified separately). See :ref:`connstr` for more information.
78+
The ``dsn`` (data source name) parameter is an :ref:`Oracle Net Services
79+
Connection String <connstr>`. It can also be a string in the format
80+
``user/password@connect_string``.
8281

8382
The ``pool`` parameter is expected to be a pool object. The use of this
8483
parameter is the equivalent of calling :meth:`ConnectionPool.acquire()`.
@@ -444,10 +443,9 @@ Oracledb Methods
444443
the ``params`` parameter object. Similar precedence rules also apply to
445444
other values.
446445

447-
The ``dsn`` (data source name) parameter can be a string in the format
448-
``user/password@connect_string`` or can simply be the connect string (in
449-
which case authentication credentials such as the username and password
450-
need to be specified separately). See :ref:`connstr` for more information.
446+
The ``dsn`` (data source name) parameter is an :ref:`Oracle Net Services
447+
Connection String <connstr>`. It can also be a string in the format
448+
``user/password@connect_string``.
451449

452450
The ``pool`` parameter is expected to be an AsyncConnectionPool object. The
453451
use of this parameter is the equivalent of calling
@@ -1086,8 +1084,7 @@ Oracledb Methods
10861084
:ref:`ConnectionPool object <connpool>` for the pool. See :ref:`Connection
10871085
pooling <connpooling>` for more information.
10881086

1089-
This function is the equivalent of the `cx_Oracle.SessionPool()
1090-
<https://cx-oracle.readthedocs.io/en/latest/api_manual/module.html#cx_Oracle.SessionPool>`__
1087+
This function is the equivalent of the ``cx_Oracle.SessionPool()``
10911088
function. The use of ``SessionPool()`` has been deprecated in
10921089
python-oracledb.
10931090

@@ -1551,7 +1548,7 @@ Oracledb Methods
15511548
other values.
15521549

15531550
The ``user``, ``password``, and ``dsn`` parameters are the same as for
1554-
:meth:`oracledb.connect_async()`.
1551+
:meth:`oracledb.connect()`.
15551552

15561553
The ``pool_class`` parameter is expected to be an
15571554
:ref:`AsyncConnectionPool Object <asyncconnpoolobj>` or a subclass of

doc/src/user_guide/appendix_b.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,18 @@ See :ref:`optnetfiles` and :ref:`optclientfiles` for more information.
7878
Connection Strings
7979
------------------
8080

81-
The python-oracledb Thin mode accepts connection strings in the same formats as
82-
the Oracle Client libraries used by Thick mode does, but not all Oracle Net
83-
keywords will be supported.
81+
Python-oracledb Thin mode accepts :ref:`Oracle Net Services connection strings
82+
<connstr>` in the same formats as the Oracle Client libraries used by Thick
83+
mode does, but not all keywords will be supported.
8484

8585
The following table lists the parameters that are recognized in Thin mode
86-
either in Easy Connect Strings or in Full Connect Descriptor Strings that are
87-
either explicitly passed or referred to by a ``tnsnames.ora`` alias. All
88-
unrecognized parameters are ignored. The connection parameters shown can be
89-
used in :meth:`oracledb.connect()`, :meth:`oracledb.create_pool()`,
90-
:meth:`oracledb.ConnectParams()`, and :meth:`oracledb.PoolParams()`.
86+
either in :ref:`Easy Connect <easyconnect>` strings or in :ref:`Connect
87+
Descriptors <conndescriptor>` that are either explicitly passed, or are in a
88+
``tnsnames.ora`` file. All unrecognized parameters are ignored. The
89+
connection parameters shown can be used in :meth:`oracledb.connect()`,
90+
:meth:`oracledb.create_pool()`, :meth:`oracledb.connect_async()`,
91+
:meth:`oracledb.create_pool_async()`, :meth:`oracledb.ConnectParams()`, and
92+
:meth:`oracledb.PoolParams()`.
9193

9294
.. list-table-with-summary:: Oracle Net Keywords Supported in the python-oracledb Thin Mode
9395
:header-rows: 1

doc/src/user_guide/appendix_c.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -620,13 +620,12 @@ addition to the common :ref:`commonupgrade`:
620620
621621
See :ref:`otherinit`.
622622

623-
4. If the application is connecting using an :ref:`Oracle Net service name
624-
<netservice>` from a ``tnsnames.ora`` file located in a "default" location
625-
such as the Instant Client ``network/admin/`` subdirectory, in
626-
``$ORACLE_HOME/network/admin/``, or in
627-
``$ORACLE_BASE/homes/XYZ/network/admin/`` (in a read-only Oracle Database
628-
home), then the configuration file directory must now explicitly be set as
629-
shown above.
623+
4. If the application is connecting using a :ref:`TNS Alias <netservice>` from
624+
a ``tnsnames.ora`` file located in a "default" location such as the Instant
625+
Client ``network/admin/`` subdirectory, in ``$ORACLE_HOME/network/admin/``,
626+
or in ``$ORACLE_BASE/homes/XYZ/network/admin/`` (in a read-only Oracle
627+
Database home), then the configuration file directory must now explicitly be
628+
set as shown in Step 2.
630629

631630
5. Remove calls to :func:`oracledb.clientversion()` which is only available in
632631
the python-oracledb Thick mode. Oracle Client libraries are not available

0 commit comments

Comments
 (0)