Metadata-Version: 2.1
Name: oracledb
Version: 3.3.0
Summary: Python interface to Oracle Database
Author-email: Anthony Tuininga <anthony.tuininga@oracle.com>
License: Copyright (c) 2016, 2025 Oracle and/or its affiliates.
        
        This software is dual-licensed to you under the Universal Permissive License
        (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
        2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
        either license.
        
        If you elect to accept the software under the Apache License, Version 2.0,
        the following applies:
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
           https://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
        
        The Universal Permissive License (UPL), Version 1.0
        ===================================================
        
        Subject to the condition set forth below, permission is hereby granted to any
        person obtaining a copy of this software, associated documentation and/or data
        (collectively the "Software"), free of charge and under any and all copyright
        rights in the Software, and any and all patent rights owned or freely
        licensable by each licensor hereunder covering either (i) the unmodified
        Software as contributed to or provided by such licensor, or (ii) the Larger
        Works (as defined below), to deal in both
        
        (a) the Software, and
        
        (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
            one is included with the Software (each a "Larger Work" to which the
            Software is contributed by such licensors),
        
        without restriction, including without limitation the rights to copy, create
        derivative works of, display, perform, and distribute the Software and make,
        use, sell, offer for sale, import, export, have made, and have sold the
        Software and the Larger Work(s), and to sublicense the foregoing rights on
        either these or other terms.
        
        This license is subject to the following condition:
        
        The above copyright notice and either this complete permission notice or at a
        minimum a reference to the UPL must be included in all copies or substantial
        portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
        
        Apache License
        ==============
        
        Version 2.0, January 2004
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1.  **Definitions**.
        
            "License" shall mean the terms and conditions for use, reproduction, and
            distribution as defined by Sections 1 through 9 of this document.
        
            "Licensor" shall mean the copyright owner or entity authorized by the
            copyright owner that is granting the License.
        
            "Legal Entity" shall mean the union of the acting entity and all other
            entities that control, are controlled by, or are under common control with
            that entity.  For the purposes of this definition, "control" means (i) the
            power, direct or indirect, to cause the direction or management of such
            entity, whether by contract or otherwise, or (ii) ownership of fifty
            percent (50%) or more of the outstanding shares, or (iii) beneficial
            ownership of such entity.
        
            "You" (or "Your") shall mean an individual or Legal Entity exercising
            permissions granted by this License.
        
            "Source" form shall mean the preferred form for making modifications,
            including but not limited to software source code, documentation source,
            and configuration files.
        
            "Object" form shall mean any form resulting from mechanical transformation
            or translation of a Source form, including but not limited to compiled
            object code, generated documentation, and conversions to other media types.
        
            "Work" shall mean the work of authorship, whether in Source or Object form,
            made available under the License, as indicated by a copyright notice that
            is included in or attached to the work (an example is provided in the
            Appendix below).
        
            "Derivative Works" shall mean any work, whether in Source or Object form,
            that is based on (or derived from) the Work and for which the editorial
            revisions, annotations, elaborations, or other modifications represent, as
            a whole, an original work of authorship. For the purposes of this License,
            Derivative Works shall not include works that remain separable from, or
            merely link (or bind by name) to the interfaces of, the Work and Derivative
            Works thereof.
        
            "Contribution" shall mean any work of authorship, including the original
            version of the Work and any modifications or additions to that Work or
            Derivative Works thereof, that is intentionally submitted to Licensor for
            inclusion in the Work by the copyright owner or by an individual or Legal
            Entity authorized to submit on behalf of the copyright owner. For the
            purposes of this definition, "submitted" means any form of electronic,
            verbal, or written communication sent to the Licensor or its
            representatives, including but not limited to communication on electronic
            mailing lists, source code control systems, and issue tracking systems that
            are managed by, or on behalf of, the Licensor for the purpose of discussing
            and improving the Work, but excluding communication that is conspicuously
            marked or otherwise designated in writing by the copyright owner as "Not a
            Contribution."
        
            "Contributor" shall mean Licensor and any individual or Legal Entity on
            behalf of whom a Contribution has been received by Licensor and
            subsequently incorporated within the Work.
        
        2.  **Grant of Copyright License.** Subject to the terms and conditions of this
            License, each Contributor hereby grants to You a perpetual, worldwide,
            non-exclusive, no-charge, royalty-free, irrevocable copyright license to
            reproduce, prepare Derivative Works of, publicly display, publicly perform,
            sublicense, and distribute the Work and such Derivative Works in Source or
            Object form.
        
        3.  **Grant of Patent License.** Subject to the terms and conditions of this
            License, each Contributor hereby grants to You a perpetual, worldwide,
            non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
            this section) patent license to make, have made, use, offer to sell, sell,
            import, and otherwise transfer the Work, where such license applies only to
            those patent claims licensable by such Contributor that are necessarily
            infringed by their Contribution(s) alone or by combination of their
            Contribution(s) with the Work to which such Contribution(s) was submitted.
            If You institute patent litigation against any entity (including a
            cross-claim or counterclaim in a lawsuit) alleging that the Work or a
            Contribution incorporated within the Work constitutes direct or
            contributory patent infringement, then any patent licenses granted to You
            under this License for that Work shall terminate as of the date such
            litigation is filed.
        
        4.  **Redistribution.** You may reproduce and distribute copies of the Work or
            Derivative Works thereof in any medium, with or without modifications, and
            in Source or Object form, provided that You meet the following conditions:
        
            1.  You must give any other recipients of the Work or Derivative Works a
                copy of this License; and
        
            2.  You must cause any modified files to carry prominent notices stating
                that You changed the files; and
        
            3.  You must retain, in the Source form of any Derivative Works that You
                distribute, all copyright, patent, trademark, and attribution notices
                from the Source form of the Work, excluding those notices that do not
                pertain to any part of the Derivative Works; and
        
            4.  If the Work includes a "NOTICE" text file as part of its distribution,
                then any Derivative Works that You distribute must include a readable
                copy of the attribution notices contained within such NOTICE file,
                excluding those notices that do not pertain to any part of the
                Derivative Works, in at least one of the following places: within a
                NOTICE text file distributed as part of the Derivative Works; within
                the Source form or documentation, if provided along with the Derivative
                Works; or, within a display generated by the Derivative Works, if and
                wherever such third-party notices normally appear. The contents of the
                NOTICE file are for informational purposes only and do not modify the
                License. You may add Your own attribution notices within Derivative
                Works that You distribute, alongside or as an addendum to the NOTICE
                text from the Work, provided that such additional attribution notices
                cannot be construed as modifying the License.
        
                You may add Your own copyright statement to Your modifications and may
                provide additional or different license terms and conditions for use,
                reproduction, or distribution of Your modifications, or for any such
                Derivative Works as a whole, provided Your use, reproduction, and
                distribution of the Work otherwise complies with the conditions stated
                in this License.
        
        5.  **Submission of Contributions.** Unless You explicitly state otherwise, any
            Contribution intentionally submitted for inclusion in the Work by You to
            the Licensor shall be under the terms and conditions of this License,
            without any additional terms or conditions. Notwithstanding the above,
            nothing herein shall supersede or modify the terms of any separate license
            agreement you may have executed with Licensor regarding such Contributions.
        
        6.  **Trademarks.** This License does not grant permission to use the trade
            names, trademarks, service marks, or product names of the Licensor, except
            as required for reasonable and customary use in describing the origin of
            the Work and reproducing the content of the NOTICE file.
        
        7.  **Disclaimer of Warranty.** Unless required by applicable law or agreed to
            in writing, Licensor provides the Work (and each Contributor provides its
            Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
            KIND, either express or implied, including, without limitation, any
            warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
            FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
            determining the appropriateness of using or redistributing the Work and
            assume any risks associated with Your exercise of permissions under this
            License.
        
        8.  **Limitation of Liability.** In no event and under no legal theory, whether
            in tort (including negligence), contract, or otherwise, unless required by
            applicable law (such as deliberate and grossly negligent acts) or agreed to
            in writing, shall any Contributor be liable to You for damages, including
            any direct, indirect, special, incidental, or consequential damages of any
            character arising as a result of this License or out of the use or
            inability to use the Work (including but not limited to damages for loss of
            goodwill, work stoppage, computer failure or malfunction, or any and all
            other commercial damages or losses), even if such Contributor has been
            advised of the possibility of such damages.
        
        9.  **Accepting Warranty or Additional Liability.** While redistributing the
            Work or Derivative Works thereof, You may choose to offer, and charge a fee
            for, acceptance of support, warranty, indemnity, or other liability
            obligations and/or rights consistent with this License. However, in
            accepting such obligations, You may act only on Your own behalf and on Your
            sole responsibility, not on behalf of any other Contributor, and only if
            You agree to indemnify, defend, and hold each Contributor harmless for any
            liability incurred by, or claims asserted against, such Contributor by
            reason of your accepting any such warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
        
Project-URL: Homepage, https://oracle.github.io/python-oracledb
Project-URL: Installation, https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
Project-URL: Samples, https://github.com/oracle/python-oracledb/tree/main/samples
Project-URL: Documentation, http://python-oracledb.readthedocs.io
Project-URL: Release Notes, https://python-oracledb.readthedocs.io/en/latest/release_notes.html
Project-URL: Issues, https://github.com/oracle/python-oracledb/issues
Project-URL: Source, https://github.com/oracle/python-oracledb
Keywords: Oracle,database
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Cython
Classifier: Topic :: Database
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE.txt
License-File: THIRD_PARTY_LICENSES.txt
License-File: NOTICE.txt

# python-oracledb

Python-oracledb is an open-source [Python][python] extension module allowing
Python programs to connect to [Oracle Database][oracledb]. The module conforms
to the [Python Database API 2.0 specification][pep249] with a considerable
number of additions and a couple of minor exclusions, see the [feature
list][features]. It is maintained by Oracle.

Python-oracledb is used for executing SQL and PL/SQL; for calling NoSQL-style
document APIs; for working with data frames; for receiving database
notifications and messages; and for starting and stopping the database. It has
features for high availability and security. It is used by many Python
Frameworks, SQL Generators, ORMs, and libraries.

Synchronous and [concurrent][concurrent] coding styles are supported. Database
operations can optionally be [pipelined][pipelining].

Python-oracledb is the successor to the now obsolete cx_Oracle driver.

## Python-oracledb Installation

Run:

```
python -m pip install oracledb --upgrade
```

See [python-oracledb Installation][installation] for details.

## Samples

Examples can be found in the [/samples][samples] directory and the
[Python and Oracle Database Tutorial][tutorial].

A basic example:

```
import oracledb
import getpass

un = "scott"
cs = "localhost/orclpdb"
# cs = "localhost/freepdb1"   # for Oracle Database Free users
# cs = "localhost/orclpdb1"   # some databases may have this service
pw = getpass.getpass(f"Enter password for {un}@{cs}: ")

with oracledb.connect(user=un, password=pw, dsn=cs) as connection:
    with connection.cursor() as cursor:
        sql = "select sysdate from dual"
        for r in cursor.execute(sql):
            print(r)
```

## Dependencies and Interoperability

- Python versions 3.9 through 3.14.

  Pre-built packages are available on [PyPI][pypi] and other repositories.

  Source code is also available.

  Previous versions of python-oracledb supported older Python versions.

- Oracle Client libraries are *optional*.

  **Thin mode**: By default python-oracledb runs in a 'Thin' mode which
  connects directly to Oracle Database.

  **Thick mode**: Some advanced Oracle Database functionality is currently only
  available when optional Oracle Client libraries are loaded by
  python-oracledb.  Libraries are available in the free [Oracle Instant
  Client][instantclient] packages. Python-oracledb can use Oracle Client
  libraries 11.2 through 23ai.

- Oracle Database

  **Thin mode**: Oracle Database 12.1 (or later) is required.

  **Thick mode**: Oracle Database 9.2 (or later) is required, depending on the
  Oracle Client library version.  Oracle Database's standard client-server
  version interoperability allows connection to both older and newer
  databases. For example when python-oracledb uses Oracle Client 19c libraries,
  then it can connect to Oracle Database 11.2 or later.

## Documentation

See the [python-oracledb Documentation][documentation] and [Release
Notes][relnotes].

## Help

Questions can be asked in [GitHub Discussions][ghdiscussions].

Problem reports can be raised in [GitHub Issues][ghissues].

## Tests

See [/tests][tests]

## Contributing

This project welcomes contributions from the community. Before submitting a
pull request, please [review our contribution guide](./CONTRIBUTING.md).

## Security

Please consult the [security guide](./SECURITY.md) for our responsible security
vulnerability disclosure process.

## License

See [LICENSE][license], [THIRD_PARTY_LICENSES][tplicense], and
[NOTICE][notice].

[python]: https://www.python.org/
[oracledb]: https://www.oracle.com/database/
[instantclient]: https://www.oracle.com/database/technologies/instant-client.html
[pep249]: https://peps.python.org/pep-0249/
[documentation]: http://python-oracledb.readthedocs.io
[relnotes]: https://python-oracledb.readthedocs.io/en/latest/release_notes.html
[license]: https://github.com/oracle/python-oracledb/blob/main/LICENSE.txt
[tplicense]: https://github.com/oracle/python-oracledb/blob/main/THIRD_PARTY_LICENSES.txt
[notice]: https://github.com/oracle/python-oracledb/blob/main/NOTICE.txt
[tutorial]: https://oracle.github.io/python-oracledb/samples/tutorial/Python-and-Oracle-Database-The-New-Wave-of-Scripting.html
[ghdiscussions]: https://github.com/oracle/python-oracledb/discussions
[ghissues]: https://github.com/oracle/python-oracledb/issues
[tests]: https://github.com/oracle/python-oracledb/tree/main/tests
[samples]: https://github.com/oracle/python-oracledb/tree/main/samples
[installation]: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html
[features]: https://oracle.github.io/python-oracledb/#features
[concurrent]: https://python-oracledb.readthedocs.io/en/latest/user_guide/asyncio.html
[pipelining]: https://python-oracledb.readthedocs.io/en/latest/user_guide/asyncio.html#pipelining-database-operations
[pypi]: https://pypi.org/project/oracledb
