Welcome to cx_Oracle's documentation!
=====================================

**cx_Oracle** is a module that enables access to Oracle Database and conforms
to the Python database API specification. This module is currently tested
against Oracle Client 21c, 19c, 18c, 12c, and 11.2, and Python 3.6, 3.7, 3.8,
3.9 and 3.10.  Older versions of cx_Oracle may be used with previous Python
releases.

**cx_Oracle** is distributed under an open-source :ref:`license <license>`
(the BSD license). A detailed description of cx_Oracle changes can be found in
the :ref:`release notes <releasenotes>`.

.. 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.**

Contents:

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

.. toctree::
    :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/lob_data.rst
    user_guide/json_data_type.rst
    user_guide/soda.rst
    user_guide/xml_data_type.rst
    user_guide/batch_statement.rst
    user_guide/exception_handling.rst
    user_guide/aq.rst
    user_guide/cqn.rst
    user_guide/txn_management.rst
    user_guide/tuning.rst
    user_guide/globalization.rst
    user_guide/startup.rst
    user_guide/ha.rst
    user_guide/tracing_sql.rst

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

.. toctree::
    :maxdepth: 3

    api_manual/module.rst
    api_manual/connection.rst
    api_manual/cursor.rst
    api_manual/variable.rst
    api_manual/session_pool.rst
    api_manual/subscription.rst
    api_manual/lob.rst
    api_manual/object_type.rst
    api_manual/aq.rst
    api_manual/soda.rst
    api_manual/deprecations.rst


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

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