Welcome to python-oracledb's documentation!
===========================================

Python-oracledb is the new name for the Python `cx_Oracle driver
<https://oracle.github.io/python-cx_Oracle/>`__.  The python-oracledb driver is
an open source module that enables Python programs to access Oracle
Database. It conforms to the `Python Database API v2.0 Specification
<https://www.python.org/dev/peps/pep-0249/>`__ with a considerable number of
additions and a couple of exclusions.

This module is currently tested with Python 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11
against Oracle Database 21c, 19c, 18c, 12c, and 11.2.

**python-oracledb** is distributed under an open-source
:ref:`license <license>`. Changes in python-oracledb releases can be found in
the :ref:`release notes <releasenotes>`.

You can use assistive technology products, such as screen readers, while you
work with the python-oracledb documentation. You can also use the keyboard
instead of the mouse.

User Guide
==========

.. toctree::
    :numbered:
    :maxdepth: 3

    user_guide/introduction.rst
    user_guide/installation.rst
    user_guide/initialization.rst
    user_guide/connection_handling.rst
    user_guide/sql_execution.rst
    user_guide/plsql_execution.rst
    user_guide/bind.rst
    user_guide/batch_statement.rst
    user_guide/txn_management.rst
    user_guide/tuning.rst
    user_guide/lob_data.rst
    user_guide/json_data_type.rst
    user_guide/xml_data_type.rst
    user_guide/soda.rst
    user_guide/aq.rst
    user_guide/cqn.rst
    user_guide/two_phase_commit.rst
    user_guide/startup.rst
    user_guide/ha.rst
    user_guide/tracing.rst
    user_guide/globalization.rst
    user_guide/exception_handling.rst
    user_guide/appendix_a.rst
    user_guide/appendix_b.rst
    user_guide/appendix_c.rst

API Manual
==========

.. toctree::
    :numbered:
    :maxdepth: 3

    api_manual/module.rst
    api_manual/defaults.rst
    api_manual/connection.rst
    api_manual/connect_param.rst
    api_manual/connection_pool.rst
    api_manual/pool_params.rst
    api_manual/cursor.rst
    api_manual/variable.rst
    api_manual/subscription.rst
    api_manual/lob.rst
    api_manual/dbobject_type.rst
    api_manual/aq.rst
    api_manual/soda.rst
    api_manual/deprecations.rst

.. toctree::
    :maxdepth: 1

    release_notes.rst
    license.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
