7299d41eca
more closely align with the PL/SQL implementation and prepare for sending notifications for AQ messages.
219 lines
6.1 KiB
ReStructuredText
219 lines
6.1 KiB
ReStructuredText
.. _subscrobj:
|
|
|
|
*******************
|
|
Subscription Object
|
|
*******************
|
|
|
|
.. note::
|
|
|
|
This object is an extension the DB API.
|
|
|
|
|
|
.. attribute:: Subscription.callback
|
|
|
|
This read-only attribute returns the callback that was registered when the
|
|
subscription was created.
|
|
|
|
|
|
.. attribute:: Subscription.connection
|
|
|
|
This read-only attribute returns the connection that was used to register
|
|
the subscription when it was created.
|
|
|
|
|
|
.. attribute:: Subscription.cqqos
|
|
|
|
This read-only attribute returns the quality of service flags used to
|
|
register the subscription when it was created. This attribute is deprecated
|
|
and will be removed in a future version of cx_Oracle. Use the qos attribute
|
|
instead.
|
|
|
|
|
|
.. attribute:: Subscription.id
|
|
|
|
This read-only attribute returns the registration ID returned by the
|
|
database when the subscription was created.
|
|
|
|
|
|
.. attribute:: Subscription.namespace
|
|
|
|
This read-only attribute returns the namespace used to register the
|
|
subscription when it was created.
|
|
|
|
|
|
.. attribute:: Subscription.operations
|
|
|
|
This read-only attribute returns the operations that will send notifications
|
|
for each table or query that is registered using this subscription.
|
|
|
|
|
|
.. attribute:: Subscription.port
|
|
|
|
This read-only attribute returns the port used for callback notifications
|
|
from the database server. If not set during construction, this value is
|
|
zero.
|
|
|
|
|
|
.. attribute:: Subscription.protocol
|
|
|
|
This read-only attribute returns the protocol used to register the
|
|
subscription when it was created.
|
|
|
|
|
|
.. attribute:: Subscription.qos
|
|
|
|
This read-only attribute returns the quality of service flags used to
|
|
register the subscription when it was created.
|
|
|
|
|
|
.. method:: Subscription.registerquery(statement, [args])
|
|
|
|
Register the query for subsequent notification when tables referenced by the
|
|
query are changed. This behaves similarly to cursor.execute() but only
|
|
queries are permitted and the arguments must be a sequence or dictionary.
|
|
If the qos parameter included the flag cx_Oracle.SUBSCR_QOS_QUERY when
|
|
the subscription was created, then the ID for the registered query is
|
|
returned; otherwise, None is returned.
|
|
|
|
|
|
.. attribute:: Subscription.rowids
|
|
|
|
This read-only attribute returns True or False specifying if rowids will be
|
|
included in notifications sent using this subscription. This attribute is
|
|
deprecated and will be removed in a future version of cx_Oracle. Use the
|
|
qos attribute instead (masked with the constant SUBSCR_QOS_ROWIDS).
|
|
|
|
|
|
.. attribute:: Subscription.timeout
|
|
|
|
This read-only attribute returns the timeout (in seconds) that was specified
|
|
when the subscription was created. A value of 0 indicates that there is no
|
|
timeout.
|
|
|
|
|
|
.. _msgobjects:
|
|
|
|
Message Objects
|
|
===============
|
|
|
|
.. note::
|
|
|
|
This object is created internally when notification is received and passed
|
|
to the callback procedure specified when a subscription is created.
|
|
|
|
|
|
.. attribute:: Message.dbname
|
|
|
|
This read-only attribute returns the name of the database that generated the
|
|
notification.
|
|
|
|
|
|
.. attribute:: Message.queries
|
|
|
|
This read-only attribute returns a list of message query objects that give
|
|
information about query result sets changed for this notification. This
|
|
attribute will be None if the cqqos parameter did not include the flag
|
|
cx_Oracle.SUBSCR_CQ_QOS_QUERY when the subscription was created.
|
|
|
|
|
|
.. attribute:: Message.subscription
|
|
|
|
This read-only attribute returns the subscription object for which this
|
|
notification was generated.
|
|
|
|
|
|
.. attribute:: Message.tables
|
|
|
|
This read-only attribute returns a list of message table objects that give
|
|
information about the tables changed for this notification. This
|
|
attribute will be None if the cqqos parameter included the flag
|
|
cx_Oracle.SUBSCR_CQ_QOS_QUERY when the subscription was created.
|
|
|
|
|
|
.. attribute:: Message.type
|
|
|
|
This read-only attribute returns the type of message that has been sent.
|
|
See the constants section on database change notification for additional
|
|
information.
|
|
|
|
|
|
Message Table Objects
|
|
=====================
|
|
|
|
.. note::
|
|
|
|
This object is created internally for each table changed when notification
|
|
is received and is found in the tables attribute of message objects, and
|
|
the tables attribute of message query objects.
|
|
|
|
|
|
.. attribute:: MessageTable.name
|
|
|
|
This read-only attribute returns the name of the table that was changed.
|
|
|
|
|
|
.. attribute:: MessageTable.operation
|
|
|
|
This read-only attribute returns the operation that took place on the table
|
|
that was changed.
|
|
|
|
|
|
.. attribute:: MessageTable.rows
|
|
|
|
This read-only attribute returns a list of message row objects that give
|
|
information about the rows changed on the table. This value is only filled
|
|
in if the rowids argument to the Connection.subscribe() method is True.
|
|
|
|
|
|
Message Row Objects
|
|
===================
|
|
|
|
.. note::
|
|
|
|
This object is created internally for each row changed on a table when
|
|
notification is received and is found in the rows attribute of message table
|
|
objects.
|
|
|
|
|
|
.. attribute:: MessageRow.operation
|
|
|
|
This read-only attribute returns the operation that took place on the row
|
|
that was changed.
|
|
|
|
|
|
.. attribute:: MessageRow.rowid
|
|
|
|
This read-only attribute returns the rowid of the row that was changed.
|
|
|
|
|
|
Message Query Objects
|
|
=====================
|
|
|
|
.. note::
|
|
|
|
This object is created internally for each query result set changed when
|
|
notification is received and is found in the queries attribute of message
|
|
objects.
|
|
|
|
|
|
.. attribute:: MessageQuery.id
|
|
|
|
This read-only attribute returns the query id of the query for which the
|
|
result set changed. The value will match the value returned by
|
|
Subscription.registerquery when the related query was registered.
|
|
|
|
|
|
.. attribute:: MessageQuery.operation
|
|
|
|
This read-only attribute returns the operation that took place on the query
|
|
result set that was changed. Valid values for this attribute are
|
|
cx_Oracle.EVENT_DEREG and cx_Oracle.EVENT_QUERYCHANGE.
|
|
|
|
|
|
.. attribute:: MessageQuery.tables
|
|
|
|
This read-only attribute returns a list of message table objects that give
|
|
information about the table changes that caused the query result set to
|
|
change for this notification.
|
|
|