subscription.rst @b1ea2624-b8ae-45ea-8f7f-f02dd21e77cd/upstream — view markup · raw · history · blame
Subscription Object
Note
This object is an extension the DB API.
System Message: INFO/1 (<string>, line 12)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 12)
Unknown directive type "attribute".
.. attribute:: Subscription.callback
This read-only attribute returns the callback that was registered when the
subscription was created.
System Message: INFO/1 (<string>, line 18)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 18)
Unknown directive type "attribute".
.. attribute:: Subscription.connection
This read-only attribute returns the connection that was used to register
the subscription when it was created.
System Message: INFO/1 (<string>, line 24)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 24)
Unknown directive type "attribute".
.. attribute:: Subscription.id
This read-only attribute returns the value of ``REGID`` found in the
database view ``USER_CHANGE_NOTIFICATION_REGS`` or the value of ``REG_ID``
found in the database view ``USER_SUBSCR_REGISTRATIONS``. For AQ
subscriptions, the value is 0.
System Message: INFO/1 (<string>, line 32)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 32)
Unknown directive type "attribute".
.. attribute:: Subscription.ipAddress
This read-only attribute returns the IP address used for callback
notifications from the database server. If not set during construction,
this value is None.
.. versionadded:: 6.4
System Message: INFO/1 (<string>, line 41)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 41)
Unknown directive type "attribute".
.. attribute:: Subscription.name
This read-only attribute returns the name used to register the subscription
when it was created.
.. versionadded:: 6.4
System Message: INFO/1 (<string>, line 49)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 49)
Unknown directive type "attribute".
.. attribute:: Subscription.namespace
This read-only attribute returns the namespace used to register the
subscription when it was created.
System Message: INFO/1 (<string>, line 55)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 55)
Unknown directive type "attribute".
.. 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.
System Message: INFO/1 (<string>, line 62)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 62)
Unknown directive type "attribute".
.. 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.
System Message: INFO/1 (<string>, line 69)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 69)
Unknown directive type "attribute".
.. attribute:: Subscription.protocol
This read-only attribute returns the protocol used to register the
subscription when it was created.
System Message: INFO/1 (<string>, line 75)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 75)
Unknown directive type "attribute".
.. attribute:: Subscription.qos
This read-only attribute returns the quality of service flags used to
register the subscription when it was created.
System Message: INFO/1 (<string>, line 81)
No directive entry for "method" in module "docutils.parsers.rst.languages.en". Trying "method" as canonical directive name.System Message: ERROR/3 (<string>, line 81)
Unknown directive type "method".
.. 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 args parameter 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.
System Message: INFO/1 (<string>, line 91)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 91)
Unknown directive type "attribute".
.. 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.
Message Objects
Note
This object is created internally when notification is received and passed to the callback procedure specified when a subscription is created.
System Message: INFO/1 (<string>, line 109)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 109)
Unknown directive type "attribute".
.. attribute:: Message.consumerName
This read-only attribute returns the name of the consumer which generated
the notification. It will be populated if the subscription was created with
the namespace :data:`cx_Oracle.SUBSCR_NAMESPACE_AQ` and the queue is a
multiple consumer queue.
.. versionadded:: 6.4
System Message: INFO/1 (<string>, line 119)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 119)
Unknown directive type "attribute".
.. attribute:: Message.dbname
This read-only attribute returns the name of the database that generated
the notification.
System Message: INFO/1 (<string>, line 125)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 125)
Unknown directive type "attribute".
.. 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 qos parameter did not include the flag
:data:`~cx_Oracle.SUBSCR_QOS_QUERY` when the subscription was created.
System Message: INFO/1 (<string>, line 133)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 133)
Unknown directive type "attribute".
.. attribute:: Message.queueName
This read-only attribute returns the name of the queue which generated the
notification. It will only be populated if the subscription was created
with the namespace :data:`cx_Oracle.SUBSCR_NAMESPACE_AQ`.
.. versionadded:: 6.4
System Message: INFO/1 (<string>, line 142)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 142)
Unknown directive type "attribute".
.. attribute:: Message.registered
This read-only attribute returns whether the subscription which generated
this notification is still registered with the database. The subscription
is automatically deregistered with the database when the subscription
timeout value is reached or when the first notification is sent (when the
quality of service flag :data:`cx_Oracle.SUBSCR_QOS_DEREG_NFY` is used).
.. versionadded:: 6.4
System Message: INFO/1 (<string>, line 153)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 153)
Unknown directive type "attribute".
.. attribute:: Message.subscription
This read-only attribute returns the subscription object for which this
notification was generated.
System Message: INFO/1 (<string>, line 159)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 159)
Unknown directive type "attribute".
.. 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 qos parameter included the flag
:data:`~cx_Oracle.SUBSCR_QOS_QUERY` when the subscription was created.
System Message: INFO/1 (<string>, line 167)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 167)
Unknown directive type "attribute".
.. attribute:: Message.txid
This read-only attribute returns the id of the transaction that generated
the notification.
System Message: INFO/1 (<string>, line 173)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 173)
Unknown directive type "attribute".
.. attribute:: Message.type
This read-only attribute returns the type of message that has been sent.
See the constants section on event types 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.
System Message: INFO/1 (<string>, line 189)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 189)
Unknown directive type "attribute".
.. attribute:: MessageTable.name
This read-only attribute returns the name of the table that was changed.
System Message: INFO/1 (<string>, line 194)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 194)
Unknown directive type "attribute".
.. attribute:: MessageTable.operation
This read-only attribute returns the operation that took place on the table
that was changed.
System Message: INFO/1 (<string>, line 200)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 200)
Unknown directive type "attribute".
.. 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 qos parameter to the :meth:`Connection.subscribe()` method
included the flag :data:`~cx_Oracle.SUBSCR_QOS_ROWIDS`.
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.
System Message: INFO/1 (<string>, line 218)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 218)
Unknown directive type "attribute".
.. attribute:: MessageRow.operation
This read-only attribute returns the operation that took place on the row
that was changed.
System Message: INFO/1 (<string>, line 224)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 224)
Unknown directive type "attribute".
.. 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.
System Message: INFO/1 (<string>, line 239)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 239)
Unknown directive type "attribute".
.. 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.
System Message: INFO/1 (<string>, line 246)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 246)
Unknown directive type "attribute".
.. 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
:data:`~cx_Oracle.EVENT_DEREG` and :data:`~cx_Oracle.EVENT_QUERYCHANGE`.
System Message: INFO/1 (<string>, line 253)
No directive entry for "attribute" in module "docutils.parsers.rst.languages.en". Trying "attribute" as canonical directive name.System Message: ERROR/3 (<string>, line 253)
Unknown directive type "attribute".
.. 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.
Docutils System Messages
System Message: INFO/1 (<string>, line 1)
Hyperlink target "subscrobj" is not referenced.System Message: INFO/1 (<string>, line 98)
Hyperlink target "msgobjects" is not referenced.