Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
188608e
Tweak documentation and README files.
anthony-tuininga Feb 26, 2021
aa2e258
Use a better resolution architecture diagram
Mar 3, 2021
bf38147
Update pool testcases
Mar 3, 2021
5f60401
Use aq_administrator_role for AQ samples
Mar 3, 2021
0a3aae5
Improve doc flow
Mar 3, 2021
fb2668e
Update tutorial configuration and setup instructions
Mar 3, 2021
e1b05d5
Correct file references.
anthony-tuininga Mar 3, 2021
1a42fb1
Update ODPI-C.
anthony-tuininga Mar 3, 2021
bdf6b4e
Use explicit SODA metadata for maximum version interoperability.
anthony-tuininga Mar 3, 2021
8f901ab
The distributed transaction handle assosciated with the connection is…
anthony-tuininga Mar 4, 2021
658f4cd
Require an issue template.
anthony-tuininga Apr 14, 2021
74b2e9a
Update ODPI-C.
anthony-tuininga Apr 15, 2021
517868e
Added support for supplying hints to various SODA operations.
anthony-tuininga Apr 15, 2021
c9110a3
Emphasize the Linux init_oracle_client() limitations.
anthony-tuininga Apr 15, 2021
ffa2086
Clarify release note (#544).
anthony-tuininga Apr 19, 2021
95baec2
Implemented #385 enhancement and updated documentation (#549)
Draco94 Apr 23, 2021
10f1c48
Update ODPI-C.
anthony-tuininga Apr 23, 2021
250b072
Update CLA URL to new online system.
anthony-tuininga Apr 23, 2021
4264d7b
Improved test suite; added check that the LOB type matches the expected
anthony-tuininga Apr 23, 2021
755b6fa
Documentation tweaks.
anthony-tuininga Apr 23, 2021
5e2a363
Modify the parameter names of the SessionPool constructor in order to
anthony-tuininga Apr 23, 2021
a1f8e1f
URL updates.
anthony-tuininga Apr 23, 2021
74d16d8
Improved the test suite.
anthony-tuininga Apr 23, 2021
4b72d0d
Rename samples and test files in order to be consistent.
anthony-tuininga Apr 23, 2021
c527c06
Further work on adjusting attribute, method and parameter names to be
anthony-tuininga Apr 23, 2021
df89702
Stop passing unsupported flags to dpiSodaDocCursor_getNext().
anthony-tuininga Apr 23, 2021
cb1061a
Remove extra word as noted in #550.
anthony-tuininga Apr 23, 2021
7ad13e7
Added parameter stmtcachesize to cx_Oracle.connect() and
anthony-tuininga Apr 23, 2021
9e8bc66
Tweak doc.
anthony-tuininga Apr 23, 2021
0edb436
Simplify samples.
anthony-tuininga Apr 23, 2021
cccfa32
Simplify code to take advantage of feature added in Python 3.3.
anthony-tuininga Apr 23, 2021
fa8d6fa
Migrate samples to use PEP 8 naming style consistently.
anthony-tuininga Apr 23, 2021
82fb398
Doc tweaks.
anthony-tuininga Apr 23, 2021
ba6e054
Further work on adjusting attribute, method and parameter names to be
anthony-tuininga Apr 23, 2021
fa36066
Added support for enabling the SODA metadata cache in Oracle Client
anthony-tuininga Apr 23, 2021
ab6e6f0
Documentation and sample updates for clarity and to note the fact that
anthony-tuininga Apr 23, 2021
96f9382
Further work on adjusting attribute, method and parameter names to be
anthony-tuininga Apr 23, 2021
8c99d1d
Final work on adjusting attribute, method and parameter names to be
anthony-tuininga Apr 23, 2021
2c6468d
Correct doc.
anthony-tuininga Apr 23, 2021
89aea21
Support non-simple characters.
anthony-tuininga Apr 23, 2021
932b413
Adjust sample to match other AQ samples.
anthony-tuininga Apr 28, 2021
5680620
Add support for specifying the ping interval for pools.
anthony-tuininga Apr 28, 2021
4189983
Adjust documentation to take into account recent changes regarding the
anthony-tuininga Apr 28, 2021
4661c66
Move section.
anthony-tuininga Apr 28, 2021
fbd9bfa
Update ODPI-C.
anthony-tuininga May 7, 2021
89eaea4
Update ODPI-C.
anthony-tuininga May 13, 2021
c665e7a
Update ODPI-C.
anthony-tuininga May 13, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: General Questions and Runtime Problems
name: Questions and Runtime Problems
about: For general cx_Oracle questions
title: ''
labels: question
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/installation-questions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Installation Questions
name: Installation Problems
about: Use this for cx_Oracle installation questions
title: ''
labels: install & configuration
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For bugs or enhancement requests, please file a GitHub issue unless it's securit

## Contributing Code

We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA).
We welcome your code contributions. To get started, you will need to sign the [Oracle Contributor Agreement](https://oca.opensource.oracle.com) (OCA).

For pull requests to be accepted, the bottom of your commit message must have
the following line using the name and e-mail address you used for the OCA.
Expand Down
69 changes: 54 additions & 15 deletions doc/src/api_manual/aq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,33 +25,42 @@ used to enqueue and dequeue messages.
which the queue was created.


.. method:: Queue.deqMany(maxMessages)
.. method:: Queue.deqmany(maxMessages)

Dequeues up to the specified number of messages from the queue and returns
a list of these messages. Each element of the returned list is a
:ref:`message property<msgproperties>` object.

.. versionchanged:: 8.2

.. method:: Queue.deqOne()
For consistency and compliance with the PEP 8 naming style, the name of
the method was changed from `deqMany()`. The old name will continue to
work for a period of time.

.. method:: Queue.deqone()

Dequeues at most one message from the queue. If a message is dequeued, it
will be a :ref:`message property<msgproperties>` object; otherwise, it will
be the value None.

.. attribute:: Queue.deqOptions
.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the name of
the method was changed from `deqOne()`. The old name will continue to
work for a period of time.

.. attribute:: Queue.deqoptions

This read-only attribute returns a reference to the :ref:`options
<deqoptions>` that will be used when dequeuing messages from the queue.

.. versionchanged:: 8.2

.. method:: Queue.enqOne(message)
For consistency and compliance with the PEP 8 naming style, the name of
the attribute was changed from `deqOptions`. The old name will continue
to work for a period of time.

Enqueues a single message into the queue. The message must be a
:ref:`message property<msgproperties>` object which has had its payload
attribute set to a value that the queue supports.


.. method:: Queue.enqMany(messages)
.. method:: Queue.enqmany(messages)

Enqueues multiple messages into the queue. The messages parameter must be a
sequence containing :ref:`message property <msgproperties>` objects which
Expand All @@ -62,26 +71,56 @@ used to enqueue and dequeue messages.
acquired from the same pool may fail due to Oracle bug 29928074. Ensure
that this function is not run in parallel, use standalone connections or
connections from different pools, or make multiple calls to
:meth:`Queue.enqOne()` instead. The function :meth:`Queue.deqMany()`
:meth:`Queue.enqone()` instead. The function :meth:`Queue.deqmany()`
call is not affected.

.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the name of
the method was changed from `enqMany()`. The old name will continue
to work for a period of time.

.. attribute:: Queue.enqOptions

.. method:: Queue.enqone(message)

Enqueues a single message into the queue. The message must be a
:ref:`message property<msgproperties>` object which has had its payload
attribute set to a value that the queue supports.

.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the name of
the method was changed from `enqOne()`. The old name will continue
to work for a period of time.

.. attribute:: Queue.enqoptions

This read-only attribute returns a reference to the :ref:`options
<enqoptions>` that will be used when enqueuing messages into the queue.

.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the name of
the attribute was changed from `enqOptions`. The old name will continue
to work for a period of time.


.. attribute:: Queue.name

This read-only attribute returns the name of the queue.


.. attribute:: Queue.payloadType
.. attribute:: Queue.payload_type

This read-only attribute returns the object type for payloads that can be
enqueued and dequeued. If using a raw queue, this returns the value None.

.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the name of
the attribute was changed from `payloadType`. The old name will
continue to work for a period of time.


.. _deqoptions:

Expand Down Expand Up @@ -225,8 +264,8 @@ Message Properties
These objects are used to identify the properties of messages that are
enqueued and dequeued in queues. They are created by the method
:meth:`Connection.msgproperties()`. They are used by the methods
:meth:`Queue.enqOne()` and :meth:`Queue.enqMany()` and
returned by the methods :meth:`Queue.deqOne()` and :meth:`Queue.deqMany()`.
:meth:`Queue.enqone()` and :meth:`Queue.enqmany()` and
returned by the methods :meth:`Queue.deqone()` and :meth:`Queue.deqmany()`.


.. attribute:: MessageProperties.attempts
Expand Down
68 changes: 50 additions & 18 deletions doc/src/api_manual/connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,20 @@ Connection Object
This method is an extension to the DB API definition.


.. attribute:: Connection.callTimeout
.. attribute:: Connection.call_timeout

This read-write attribute specifies the amount of time (in milliseconds)
that a single round-trip to the database may take before a timeout will
occur. A value of 0 means that no timeout will take place.

.. versionadded:: 7.0

.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the
attribute `callTimeout` was renamed to `call_timeout`. The old name
will continue to work for a period of time.

.. note::

This attribute is an extension to the DB API definition and is only
Expand Down Expand Up @@ -195,7 +201,7 @@ Connection Object

.. deprecated:: 7.2

Use the methods :meth:`Queue.deqOne()` or :meth:`Queue.deqMany()`
Use the methods :meth:`Queue.deqone()` or :meth:`Queue.deqmany()`
instead.

.. note::
Expand All @@ -212,7 +218,7 @@ Connection Object

.. deprecated:: 7.2

Use the attribute :attr:`Queue.deqOptions` instead.
Use the attribute :attr:`Queue.deqoptions` instead.

.. note::

Expand Down Expand Up @@ -247,6 +253,8 @@ Connection Object
This read-only attribute returns the IANA character set name of the
character set in use by the Oracle client for regular strings.

.. deprecated:: 8.2

.. note::

This attribute is an extension to the DB API definition.
Expand All @@ -264,7 +272,7 @@ Connection Object

.. deprecated:: 7.2

Use the methods :meth:`Queue.enqOne()` or :meth:`Queue.enqMany()`
Use the methods :meth:`Queue.enqone()` or :meth:`Queue.enqmany()`
instead.

.. note::
Expand All @@ -281,7 +289,7 @@ Connection Object

.. deprecated:: 7.2

Use the attribute :attr:`Queue.enqOptions` instead.
Use the attribute :attr:`Queue.enqoptions` instead.

.. note::

Expand All @@ -305,7 +313,7 @@ Connection Object
Return a :ref:`SodaDatabase <sodadb>` object for Simple Oracle Document
Access (SODA). All SODA operations are performed either on the returned
SodaDatabase object or from objects created by the returned SodaDatabase
object. See `here <http://www.oracle.com/pls/topic/lookup?
object. See `here <https://www.oracle.com/pls/topic/lookup?
ctx=dblatest&id=GUID-BE42F8D3-B86B-43B4-B2A3-5760A4DF79FB>`__ for
additional information on SODA.

Expand Down Expand Up @@ -387,6 +395,8 @@ Connection Object
This read-only attribute returns the maximum number of bytes each character
can use for the client character set.

.. deprecated:: 8.2

.. note::

This attribute is an extension to the DB API definition.
Expand Down Expand Up @@ -426,6 +436,8 @@ Connection Object
This read-only attribute returns the IANA character set name of the
national character set in use by the Oracle client.

.. deprecated:: 8.2

.. note::

This attribute is an extension to the DB API definition.
Expand Down Expand Up @@ -469,20 +481,26 @@ Connection Object
This method is an extension to the DB API definition.


.. method:: Connection.queue(name, payloadType=None)
.. method:: Connection.queue(name, payload_type=None)

Creates a :ref:`queue <queue>` which is used to enqueue and dequeue
messages in Advanced Queueing.

The name parameter is expected to be a string identifying the queue in
which messages are to be enqueued or dequeued.

The payloadType parameter, if specified, is expected to be an
The payload_type parameter, if specified, is expected to be an
:ref:`object type <objecttype>` that identifies the type of payload the
queue expects. If not specified, RAW data is enqueued and dequeued.

.. versionadded:: 7.2

.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the
parameter `payloadType` was renamed to `payload_type`. The old name
will continue to work as a keyword parameter for a period of time.

.. note::

This method is an extension to the DB API definition.
Expand Down Expand Up @@ -549,8 +567,8 @@ Connection Object
.. attribute:: Connection.stmtcachesize

This read-write attribute specifies the size of the statement cache. This
value can make a significant difference in performance (up to 100x) if you
have a small number of statements that you execute repeatedly.
value can make a significant difference in performance if you have a small
number of statements that you execute repeatedly.

The default value is 20.

Expand All @@ -561,7 +579,7 @@ Connection Object
This attribute is an extension to the DB API definition.


.. method:: Connection.subscribe(namespace=cx_Oracle.SUBSCR_NAMESPACE_DBCHANGE, protocol=cx_Oracle.SUBSCR_PROTO_OCI, callback=None, timeout=0, operations=OPCODE_ALLOPS, port=0, qos=0, ipAddress=None, groupingClass=0, groupingValue=0, groupingType=cx_Oracle.SUBSCR_GROUPING_TYPE_SUMMARY, name=None, clientInitiated=False)
.. method:: Connection.subscribe(namespace=cx_Oracle.SUBSCR_NAMESPACE_DBCHANGE, protocol=cx_Oracle.SUBSCR_PROTO_OCI, callback=None, timeout=0, operations=OPCODE_ALLOPS, port=0, qos=0, ip_address=None, grouping_class=0, grouping_value=0, grouping_type=cx_Oracle.SUBSCR_GROUPING_TYPE_SUMMARY, name=None, client_initiated=False)

Return a new :ref:`subscription object <subscrobj>` that receives
notifications for events that take place in the database that match the
Expand Down Expand Up @@ -599,16 +617,16 @@ Connection Object
:data:`cx_Oracle.SUBSCR_QOS_QUERY`,
:data:`cx_Oracle.SUBSCR_QOS_BEST_EFFORT`.

The ipAddress parameter specifies the IP address (IPv4 or IPv6) in standard
string notation to bind for callback notifications from the database
server. If not specified, the client IP address will be determined by the
Oracle Client libraries.
The ip_address parameter specifies the IP address (IPv4 or IPv6) in
standard string notation to bind for callback notifications from the
database server. If not specified, the client IP address will be determined
by the Oracle Client libraries.

The groupingClass parameter specifies what type of grouping of
The grouping_class parameter specifies what type of grouping of
notifications should take place. Currently, if set, this value can only be
set to the value :data:`cx_Oracle.SUBSCR_GROUPING_CLASS_TIME`, which
will group notifications by the number of seconds specified in the
groupingValue parameter. The groupingType parameter should be one of the
grouping_value parameter. The grouping_type parameter should be one of the
values :data:`cx_Oracle.SUBSCR_GROUPING_TYPE_SUMMARY` (the default) or
:data:`cx_Oracle.SUBSCR_GROUPING_TYPE_LAST`.

Expand All @@ -622,7 +640,7 @@ Connection Object
the queue that will be monitored for messages. The queue name may include
the schema, if needed.

The clientInitiated parameter is used to determine if client initiated
The client_initiated parameter is used to determine if client initiated
connections or server initiated connections (the default) will be
established. Client initiated connections are only available in Oracle
Client 19.4 and Oracle Database 19.4 and higher.
Expand All @@ -636,6 +654,16 @@ Connection Object

The parameter clientInitiated was added.

.. versionchanged:: 8.2

For consistency and compliance with the PEP 8 naming style, the
parameter `ipAddress` was renamed to `ip_address`, the parameter
`groupingClass` was renamed to `grouping_class`, the parameter
`groupingValue` was renamed to `grouping_value`, the parameter
`groupingType` was renamed to `grouping_type` and the parameter
`clientInitiated` was renamed to `client_initiated`. The old names will
continue to work as keyword parameters for a period of time.

.. note::

This method is an extension to the DB API definition.
Expand Down Expand Up @@ -674,6 +702,10 @@ Connection Object
This read-only attribute returns the TNS entry of the database to which a
connection has been established.

.. deprecated:: 8.2

Use the attribute :attr:`~Connection.dsn` instead.

.. note::

This attribute is an extension to the DB API definition.
Expand Down
Loading