Skip to content

Commit 1ad43aa

Browse files
Doc improvements.
1 parent 3db3e37 commit 1ad43aa

File tree

7 files changed

+25
-23
lines changed

7 files changed

+25
-23
lines changed

doc/src/api_manual/cursor.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Cursor Object
290290
See :ref:`fetching` for an example.
291291

292292

293-
.. method:: Cursor.fetchmany(num_rows=cursor.arraysize)
293+
.. method:: Cursor.fetchmany(numRows=cursor.arraysize)
294294

295295
Fetch the next set of rows of a query result, returning a list of tuples.
296296
An empty list is returned if no more rows are available. Note that the

doc/src/api_manual/module.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Module Interface
4040
mode=cx_Oracle.DEFAULT_AUTH, handle=0, pool=None, threaded=False, \
4141
events=False, cclass=None, purity=cx_Oracle.ATTR_PURITY_DEFAULT, \
4242
newpassword=None, encoding=None, nencoding=None, edition=None, \
43-
appcontext=[], tag=None, matchanytag=None, shardingkey=[], \
43+
appcontext=[], tag=None, matchanytag=False, shardingkey=[], \
4444
supershardingkey=[], stmtcachesize=20)
4545
Connection(user=None, password=None, dsn=None, \
4646
mode=cx_Oracle.DEFAULT_AUTH, handle=0, pool=None, threaded=False, \

doc/src/api_manual/session_pool.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ SessionPool Object
160160
unusable, it is discarded and a different connection is selected to be
161161
returned by :meth:`SessionPool.acquire()`. Setting ``ping_interval`` to a
162162
negative value disables pinging. Setting it to 0 forces a ping for every
163-
``aquire()`` and is not recommended.
163+
``acquire()`` and is not recommended.
164164

165165
Prior to cx_Oracle 8.2, the ping interval was fixed at 60 seconds.
166166

doc/src/user_guide/connection_handling.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ connection pool:
336336
pool.close()
337337
338338
Other :meth:`cx_Oracle.SessionPool()` options can be used at pool creation.
339-
For example the ``getmode`` value can be set so that any ``aquire()`` call will
339+
For example the ``getmode`` value can be set so that any ``acquire()`` call will
340340
wait for a connection to become available if all are currently in use, for
341341
example:
342342

@@ -349,8 +349,8 @@ example:
349349
getmode=cx_Oracle.SPOOL_ATTRVAL_WAIT,
350350
encoding="UTF-8")
351351
352-
See `ConnectionPool.py
353-
<https://github.com/oracle/python-cx_Oracle/tree/main/samples/ConnectionPool.py>`__
352+
See `connection_pool.py
353+
<https://github.com/oracle/python-cx_Oracle/tree/main/samples/connection_pool.py>`__
354354
for an example.
355355

356356
Before :meth:`SessionPool.acquire()` returns, cx_Oracle does a lightweight check
@@ -1348,10 +1348,10 @@ of the function :meth:`cx_Oracle.connect()` constructor:
13481348
dsn="dbhost.example.com/orclpdb1",
13491349
newpassword=newpwd, encoding="UTF-8")
13501350
1351-
.. _autononmousdb:
1351+
.. _autonomousdb:
13521352

1353-
Connecting to Oracle Cloud Autononmous Databases
1354-
================================================
1353+
Connecting to Oracle Cloud Autonomous Databases
1354+
===============================================
13551355

13561356
To enable connection to Oracle Autonomous Database in Oracle Cloud, a wallet
13571357
needs be downloaded from the cloud, and cx_Oracle needs to be configured to use

doc/src/user_guide/cqn.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ what types of SQL should trigger a notification, whether notifications should
1919
survive database loss, and control over unsubscription. You can also choose
2020
whether notification messages will include ROWIDs of affected rows.
2121

22-
By default, object-level (previously known as Database Change Notification)
23-
occurs and the Python notification method is invoked whenever a database
24-
transaction is committed that changes an object that a registered query
25-
references, regardless of whether the actual query result changed. However if
26-
the :meth:`subscription <Connection.subscribe>` option ``qos`` is
27-
:data:`cx_Oracle.SUBSCR_QOS_QUERY` then query-level notification occurs. In
28-
this mode, the database notifies the application whenever a transaction changing
29-
the result of the registered query is committed.
22+
By default, object-level notification (previously known as Database Change
23+
Notification) occurs. With this mode a Python notification method is invoked
24+
whenever a database transaction is committed that changes an object referenced
25+
by a registered query. However if the :meth:`subscription
26+
<Connection.subscribe>` option ``qos`` is :data:`cx_Oracle.SUBSCR_QOS_QUERY`
27+
then query-level notification occurs. In this mode, the database notifies the
28+
application whenever a committed transaction changes the result of a registered
29+
query.
3030

3131
CQN is best used to track infrequent data changes.
3232

@@ -109,7 +109,7 @@ calling :meth:`Subscription.registerquery()`. Registering a query behaves
109109
similarly to :meth:`Cursor.execute()`, but only queries are permitted and the
110110
``args`` parameter must be a sequence or dictionary.
111111

112-
An example script to receive query notifications when the 'CUSTOMER' table data
112+
An example script to receive query notifications when the 'REGIONS' table data
113113
changes is:
114114

115115
.. code-block:: python
@@ -129,6 +129,7 @@ changes is:
129129
subscr = connection.subscribe(callback=cqn_callback,
130130
operations=cx_Oracle.OPCODE_INSERT | cx_Oracle.OPCODE_DELETE,
131131
qos=cx_Oracle.SUBSCR_QOS_QUERY | cx_Oracle.SUBSCR_QOS_ROWIDS)
132+
132133
subscr.registerquery("select * from regions")
133134
input("Hit enter to stop CQN demo\n")
134135

doc/src/user_guide/initialization.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ located with, or separately from, the ``tnsnames.ora`` and ``sqlnet.ora``
241241
files. It should be securely stored. The ``sqlnet.ora`` file's
242242
``WALLET_LOCATION`` path should be set to the directory containing
243243
``cwallet.sso``. For Oracle Autonomous Database use of wallets, see
244-
:ref:`autononmousdb`.
244+
:ref:`autonomousdb`.
245245

246246
Note the :ref:`easyconnect` can set many common configuration options without
247247
needing ``tnsnames.ora`` or ``sqlnet.ora`` files.

doc/src/user_guide/installation.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -491,10 +491,11 @@ To use cx_Oracle with Oracle Instant Client zip files:
491491
a 64-bit or 32-bit architecture to match Instant Client's architecture.
492492
Each Instant Client version requires a different redistributable version:
493493

494-
- For Instant Client 19 install `VS 2017 <https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads>`__.
495-
- For Instant Client 18 or 12.2 install `VS 2013 <https://support.microsoft.com/en-us/kb/2977003#bookmark-vs2013>`__
496-
- For Instant Client 12.1 install `VS 2010 <https://support.microsoft.com/en-us/kb/2977003#bookmark-vs2010>`__
497-
- For Instant Client 11.2 install `VS 2005 64-bit <https://www.microsoft.com/en-us/download/details.aspx?id=18471>`__ or `VS 2005 32-bit <https://www.microsoft.com/en-ca/download/details.aspx?id=3387>`__
494+
- For Instant Client 21 install `VS 2019 <https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170>`__ or later.
495+
- For Instant Client 19 install `VS 2017 <https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170>`__.
496+
- For Instant Client 18 or 12.2 install `VS 2013 <https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170#visual-studio-2013-vc-120>`__
497+
- For Instant Client 12.1 install `VS 2010 <https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170#visual-studio-2010-vc-100-sp1-no-longer-supported>`__
498+
- For Instant Client 11.2 install `VS 2005 64-bit <https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170#visual-studio-2005-vc-80-sp1-no-longer-supported>`__
498499

499500
Configure Oracle Instant Client
500501
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)