Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: oracle/python-cx_Oracle
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 8.3.0
Choose a base ref
...
head repository: oracle/python-cx_Oracle
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
  • 11 commits
  • 53 files changed
  • 1 contributor

Commits on May 25, 2022

  1. Improved AQ test.

    anthony-tuininga committed May 25, 2022
    Copy the full SHA
    59c4153 View commit details
  2. Fix stale OCA link.

    anthony-tuininga committed May 25, 2022
    Copy the full SHA
    3db3e37 View commit details
  3. Doc improvements.

    anthony-tuininga committed May 25, 2022
    Copy the full SHA
    1ad43aa View commit details
  4. Copy the full SHA
    fde577b View commit details

Commits on Jun 8, 2022

  1. Copy the full SHA
    5cfbb7d View commit details

Commits on Jun 3, 2023

  1. Copy the full SHA
    a05b9a5 View commit details

Commits on Aug 17, 2023

  1. Copy the full SHA
    6766bca View commit details

Commits on May 8, 2024

  1. Copy the full SHA
    83774f9 View commit details

Commits on May 31, 2024

  1. Copy the full SHA
    93d69d8 View commit details

Commits on Jul 30, 2024

  1. Copy the full SHA
    bed2c03 View commit details

Commits on Mar 27, 2025

  1. Copy the full SHA
    70cbc43 View commit details
Showing with 533 additions and 218 deletions.
  1. +11 −1 .github/ISSUE_TEMPLATE/bug_report.md
  2. +6 −9 .github/ISSUE_TEMPLATE/documentation-and-example-improvements.md
  3. +6 −9 .github/ISSUE_TEMPLATE/enhancement-requests.md
  4. +8 −1 .github/ISSUE_TEMPLATE/general-questions-and-runtime-problems.md
  5. +8 −1 .github/ISSUE_TEMPLATE/installation-questions.md
  6. +0 −13 .github/SECURITY.md
  7. +4 −2 .github/SUPPORT.md
  8. +4 −17 .github/pull_request_template.md
  9. +11 −4 .readthedocs.yaml
  10. +4 −40 CONTRIBUTING.md
  11. +24 −50 README.md
  12. +5 −3 README.txt
  13. +37 −0 SECURITY.md
  14. +2 −2 doc/requirements.txt
  15. +7 −0 doc/src/api_manual/aq.rst
  16. +7 −0 doc/src/api_manual/connection.rst
  17. +8 −1 doc/src/api_manual/cursor.rst
  18. +7 −0 doc/src/api_manual/deprecations.rst
  19. +7 −0 doc/src/api_manual/lob.rst
  20. +8 −1 doc/src/api_manual/module.rst
  21. +7 −0 doc/src/api_manual/object_type.rst
  22. +8 −1 doc/src/api_manual/session_pool.rst
  23. +7 −0 doc/src/api_manual/soda.rst
  24. +7 −0 doc/src/api_manual/subscription.rst
  25. +7 −0 doc/src/api_manual/variable.rst
  26. +7 −0 doc/src/index.rst
  27. +7 −0 doc/src/release_notes.rst
  28. +7 −0 doc/src/user_guide/aq.rst
  29. +7 −0 doc/src/user_guide/batch_statement.rst
  30. +7 −0 doc/src/user_guide/bind.rst
  31. +13 −6 doc/src/user_guide/connection_handling.rst
  32. +17 −9 doc/src/user_guide/cqn.rst
  33. +7 −0 doc/src/user_guide/exception_handling.rst
  34. +7 −0 doc/src/user_guide/globalization.rst
  35. +7 −0 doc/src/user_guide/ha.rst
  36. +14 −7 doc/src/user_guide/initialization.rst
  37. +37 −14 doc/src/user_guide/installation.rst
  38. +7 −6 doc/src/user_guide/introduction.rst
  39. +7 −0 doc/src/user_guide/json_data_type.rst
  40. +7 −0 doc/src/user_guide/lob_data.rst
  41. +7 −0 doc/src/user_guide/plsql_execution.rst
  42. +7 −0 doc/src/user_guide/soda.rst
  43. +7 −0 doc/src/user_guide/sql_execution.rst
  44. +7 −0 doc/src/user_guide/startup.rst
  45. +7 −0 doc/src/user_guide/tracing_sql.rst
  46. +7 −0 doc/src/user_guide/tuning.rst
  47. +7 −0 doc/src/user_guide/txn_management.rst
  48. +7 −0 doc/src/user_guide/xml_data_type.rst
  49. +13 −1 samples/README.md
  50. +13 −0 samples/sample_env.py
  51. +12 −1 samples/tutorial/Python-and-Oracle-Database-Scripting-for-the-Future.html
  52. +7 −0 samples/tutorial/resources/base.css
  53. +64 −19 test/test_3000_subscription.py
12 changes: 11 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -13,7 +13,17 @@ Thank you for using cx_Oracle.
See https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html for how to report security issues
Please answer these questions so we can help you.
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Update to python-oracledb, if possible, and submit your bug report to the
python-oracledb repository.
No further releases under the cx_Oracle namespace are planned.
Otherwise, please answer these questions so we can help you.
Use Markdown syntax, see https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
15 changes: 6 additions & 9 deletions .github/ISSUE_TEMPLATE/documentation-and-example-improvements.md
Original file line number Diff line number Diff line change
@@ -9,16 +9,13 @@ assignees: ''

<!--
Thank you for using cx_Oracle.
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Please answer these questions so we can help you.
Please submit your documentation and example improvements to the python-oracledb repository.
Use Markdown syntax, see https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
No further releases under the cx_Oracle namespace are planned.
-->

1. What is the link to the documentation section that needs improving?

2. Describe the confusion

3. Suggest changes that would help
15 changes: 6 additions & 9 deletions .github/ISSUE_TEMPLATE/enhancement-requests.md
Original file line number Diff line number Diff line change
@@ -9,16 +9,13 @@ assignees: ''

<!--
Thank you for using cx_Oracle.
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Review existing enhancement requests: https://github.com/oracle/python-cx_Oracle/labels/enhancement
Please submit your enhancement requests to the python-oracledb repository.
Please answer these questions so we can help you.
Use Markdown syntax, see https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
No further releases under the cx_Oracle namespace are planned.
-->

1. Describe your new request in detail

2. Give supporting information about tools and operating systems. Give relevant product version numbers
Original file line number Diff line number Diff line change
@@ -11,7 +11,14 @@ assignees: ''
Thank you for using cx_Oracle.
Review the user manual: https://cx-oracle.readthedocs.io/en/latest/index.html
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Update to python-oracledb, if possible.
Otherwise, review the cx_Oracle user manual: https://cx-oracle.readthedocs.io/en/latest/index.html
Please answer these questions so we can help you.
9 changes: 8 additions & 1 deletion .github/ISSUE_TEMPLATE/installation-questions.md
Original file line number Diff line number Diff line change
@@ -11,9 +11,16 @@ assignees: ''
Thank you for using cx_Oracle.
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb. The installation
instructions are at:
https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Do these before creating a new issue:
Review and follow the Installation Instructions: https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html
Update to python-oracledb, if possible.
Otherwise, review and follow the Installation Instructions: https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html
Review the troubleshooting tips: https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting
13 changes: 0 additions & 13 deletions .github/SECURITY.md

This file was deleted.

6 changes: 4 additions & 2 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Python cx_Oracle Support

cx_Oracle is an Open Source project, so do some searching and reading
before asking questions.
**The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a
new repository at https://github.com/oracle/python-oracledb. Please update to
this new driver. If you still have problems, open an issue on the new
repository.**

## cx_Oracle Installation issues

21 changes: 4 additions & 17 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,8 @@
Thanks for contributing!

Before submitting PRs for cx_Oracle you must have your signed *Oracle
Contributor Agreement* accepted. See
https://www.oracle.com/technetwork/community/oca-486395.html
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb.

If the problem solved is small, you may find it easier to open an Issue
describing the problem and its cause so we can create the fix.
Please submit your contributions to the python-oracledb repository.

The bottom of your commit message must have the following line using your name
and e-mail address as it appears in the OCA Signatories list.

```
Signed-off-by: Your Name <you@example.org>
```

This can be automatically added to pull requests by committing with:

```
git commit --signoff
````
No further releases under the cx_Oracle namespace are planned.
15 changes: 11 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# required
version: 2

build:
os: ubuntu-20.04
tools:
python: "3.9"

# Build documentation in the doc/src directory with Sphinx
sphinx:
configuration: doc/src/conf.py
configuration: doc/src/conf.py

# declare Python requirements required to build docs
python:
version: 3.8
install:
- requirements: doc/requirements.txt
install:
- requirements: doc/requirements.txt
44 changes: 4 additions & 40 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,8 @@
# Contributing

We welcome your contributions! There are multiple ways to contribute.
The cx_Oracle driver was renamed to python-oracledb in May 2022. It has a new
repository at https://github.com/oracle/python-oracledb

## Issues
Please submit your contributions to the python-oracledb repository.

For bugs or enhancement requests, please file a GitHub issue unless it's security related. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. If you think you've found a security vulnerability, do not raise a GitHub issue and follow the instructions on our [Security Policy](./.github/SECURITY.md).

## Contributing Code

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.

```text
Signed-off-by: Your Name <you@example.org>
```

This can be automatically added to pull requests by committing with:

```text
git commit --signoff
```

Only pull requests from committers that can be verified as having
signed the OCA can be accepted.

### Pull request process

1. Fork this repository
1. Create a branch in your fork to implement the changes. We recommend using
the issue number as part of your branch name, e.g. `1234-fixes`
1. Ensure that any documentation is updated with the changes that are required
by your fix.
1. Ensure that any samples are updated if the base image has been changed.
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
what your changes are meant to do and provide simple steps on how to validate
your changes. Ensure that you reference the issue you created as well.
1. We will review your PR before it is merged.

## Code of Conduct

Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd like more specific guidelines see the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
No further releases under the cx_Oracle namespace are planned.
74 changes: 24 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,33 @@
# cx_Oracle version 8.3
# Python cx_Oracle

cx_Oracle is a Python extension module that enables access to Oracle
Database. It conforms to the [Python database API 2.0
specification][1] with a considerable number of additions and a couple
of exclusions. See the
[homepage](https://oracle.github.io/python-cx_Oracle/index.html) for a
feature list.
**cx_Oracle was obsoleted by
[python-oracledb](https://oracle.github.io/python-oracledb/) in 2022.**

cx_Oracle 8.3 has been tested with Python versions 3.6 through 3.10. You can
use cx_Oracle with Oracle 11.2, 12c, 18c, 19c and 21c client libraries.
Oracle's standard client-server version interoperability allows connection to
both older and newer databases. For example Oracle 19c client libraries can
connect to Oracle Database 11.2. Older versions of cx_Oracle may work with
older versions of Python.
Python-oracledb uses the same Python DB API as cx_Oracle, and has many new
features.

## Installation
Install with:

See [cx_Oracle Installation][15].
```
python -m pip install oracledb
```

## Documentation
Usage is like:

See the [cx_Oracle Documentation][2] and [Release Notes][14].
```
import getpass
import oracledb
## Samples
un = 'scott'
cs = 'localhost/orclpdb1'
pw = getpass.getpass(f'Enter password for {un}@{cs}: ')
See the [/samples][12] directory and the [tutorial][6]. You can also
look at the scripts in [cx_OracleTools][7] and the modules in
[cx_PyOracleLib][8].
with oracledb.connect(user=un, password=pw, dsn=cs) as connection:
with connection.cursor() as cursor:
sql = 'select systimestamp from dual'
for r in cursor.execute(sql):
print(r)
```

## Help

Issues and questions can be raised with the cx_Oracle community on
[GitHub][9] or on the [mailing list][5].

## Tests

See [/test][11].

## Contributing

See [CONTRIBUTING](https://github.com/oracle/python-cx_Oracle/blob/main/CONTRIBUTING.md)

## License

cx_Oracle is licensed under a BSD license which you can find [here][3].

[1]: https://www.python.org/dev/peps/pep-0249
[2]: http://cx-oracle.readthedocs.io
[3]: https://github.com/oracle/python-cx_Oracle/blob/main/LICENSE.txt
[5]: http://lists.sourceforge.net/lists/listinfo/cx-oracle-users
[6]: https://github.com/oracle/python-cx_Oracle/tree/main/samples/tutorial
[7]: http://cx-oracletools.sourceforge.net
[8]: http://cx-pyoraclelib.sourceforge.net
[9]: https://github.com/oracle/python-cx_Oracle/issues
[11]: https://github.com/oracle/python-cx_Oracle/tree/main/test
[12]: https://github.com/oracle/python-cx_Oracle/tree/main/samples
[14]: https://cx-oracle.readthedocs.io/en/latest/release_notes.html
[15]: https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html
The source code for python-oracledb is at
[github.com/oracle/python-oracledb](https://github.com/oracle/python-oracledb).
8 changes: 5 additions & 3 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Please see the cx_Oracle home page for links to documentation, source, build
and installation instructions:
cx_Oracle was obsoleted by python-oracledb in 2022.

https://oracle.github.io/python-cx_Oracle/index.html
Python-oracledb uses the same Python DB API as cx_Oracle, and has many new
features.

See https://python-oracledb.readthedocs.io/en/latest/index.html for how to
install and use this updated driver.
37 changes: 37 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Reporting security vulnerabilities

Oracle values the independent security research community and believes that
responsible disclosure of security vulnerabilities helps us ensure the security
and privacy of all our users.

Please do NOT raise a GitHub Issue to report a security vulnerability. If you
believe you have found a security vulnerability, please submit a report to
[secalert_us@oracle.com][1] preferably with a proof of concept. Please review
some additional information on [how to report security vulnerabilities to
Oracle][2]. We encourage people who contact Oracle Security to use email
encryption using [our encryption key][3].

We ask that you do not use other channels or contact the project maintainers
directly.

Non-vulnerability related security issues including ideas for new or improved
security features are welcome on GitHub Issues.

## Security updates, alerts and bulletins

Security updates will be released on a regular cadence. Many of our projects
will typically release security fixes in conjunction with the Oracle Critical
Patch Update program. Additional information, including past advisories, is
available on our [security alerts][4] page.

## Security-related information

We will provide security related information such as a threat model,
considerations for secure use, or any known security issues in our
documentation. Please note that labs and sample code are intended to
demonstrate a concept and may not be sufficiently hardened for production use.

[1]: mailto:secalert_us@oracle.com
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
[4]: https://www.oracle.com/security-alerts/
4 changes: 2 additions & 2 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sphinx==4.1.2
sphinx_rtd_theme==0.5.1
sphinx>=4.2.0
sphinx-rtd-theme>=0.5.2
7 changes: 7 additions & 0 deletions doc/src/api_manual/aq.rst
Original file line number Diff line number Diff line change
@@ -4,6 +4,13 @@
Advanced Queuing (AQ)
*********************

.. note::

**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.

**New projects should install python-oracledb instead of cx_Oracle.**

See :ref:`aqusermanual` for more information about using AQ in cx_Oracle.

.. note::
7 changes: 7 additions & 0 deletions doc/src/api_manual/connection.rst
Original file line number Diff line number Diff line change
@@ -4,6 +4,13 @@
Connection Object
*****************

.. note::

**cx_Oracle has a major new release under a new name and homepage**
`python-oracledb <https://oracle.github.io/python-oracledb/>`__.

**New projects should install python-oracledb instead of cx_Oracle.**

.. note::

Any outstanding changes will be rolled back when the connection object
Loading