Skip to content

Commit ebb1cb8

Browse files
Add Sphinx deprecated tags for constants.
1 parent 1bdfcb8 commit ebb1cb8

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

doc/src/module.rst

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -531,14 +531,23 @@ Database Change Notification
531531

532532
.. data:: SUBSCR_CQ_QOS_BEST_EFFORT
533533

534-
This constant is deprecated and will be removed in a future version of
535-
cx_Oracle. Use :data:`cx_Oracle.SUBSCR_QOS_BEST_EFFORT` instead.
534+
This constant can be used when creating a subscription and specifies that
535+
best effort filtering for query result set changes is acceptable. False
536+
positive notifications may be received. This behaviour may be suitable for
537+
caching applications.
538+
539+
.. deprecated:: 5.3
540+
Use :data:`~cx_Oracle.SUBSCR_QOS_BEST_EFFORT` instead.
536541

537542

538543
.. data:: SUBSCR_CQ_QOS_QUERY
539544

540-
This constant is deprecated and will be removed in a future version of
541-
cx_Oracle. Use :data:`cx_Oracle.SUBSCR_QOS_QUERY` instead.
545+
This constant can be used when creating a subscription and specifies that
546+
notifications should only be sent if the result set of the registered query
547+
changes. By default no false positive notifictions will be generated.
548+
549+
.. deprecated:: 5.3
550+
Use :data:`~cx_Oracle.SUBSCR_QOS_QUERY` instead.
542551

543552

544553
.. data:: SUBSCR_QOS_BEST_EFFORT
@@ -558,8 +567,12 @@ Database Change Notification
558567

559568
.. data:: SUBSCR_QOS_PURGE_ON_NTFN
560569

561-
This constant is deprecated and will be removed in a future version of
562-
cx_Oracle. Use :data:`cx_Oracle.SUBSCR_QOS_DEREG_NFY` instead.
570+
This constant can be used when creating a subscription and specifies that
571+
the subscription should be automatically unregistered after the first
572+
notification has been received.
573+
574+
.. deprecated:: 5.3
575+
Use :data:`~cx_Oracle.SUBSCR_QOS_DEREG_NFY` instead.
563576

564577

565578
.. data:: SUBSCR_QOS_QUERY
@@ -851,6 +864,8 @@ Types
851864
NCHAR strings are bound this way in order to avoid the "unimplemented or
852865
unreasonable conversion requested" error.
853866

867+
.. deprecated:: 5.3
868+
854869
.. note::
855870

856871
This type is an extension to the DB API definition.

0 commit comments

Comments
 (0)