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

The python-oracledb driver is an open source Python module that enables access
to Oracle Database with no extra libraries needed. The module is built with
Cython for safety and speed. It is lightweight and high-performance. It is
stable, well tested, and has comprehensive documentation. The module is
maintained by Oracle.

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/authentication_methods.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/vector_data_type.rst
    user_guide/dataframes.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/asyncio.rst
    user_guide/globalization.rst
    user_guide/exception_handling.rst
    user_guide/tracing.rst
    user_guide/extending.rst
    user_guide/troubleshooting.rst
    user_guide/appendix_a.rst
    user_guide/appendix_b.rst
    user_guide/appendix_c.rst
    user_guide/appendix_d.rst

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

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

    api_manual/module.rst
    api_manual/defaults.rst
    api_manual/connection.rst
    api_manual/connect_params.rst
    api_manual/connection_pool.rst
    api_manual/pool_params.rst
    api_manual/cursor.rst
    api_manual/dataframe.rst
    api_manual/fetch_info.rst
    api_manual/variable.rst
    api_manual/subscription.rst
    api_manual/lob.rst
    api_manual/dbobject_type.rst
    api_manual/sparse_vector.rst
    api_manual/aq.rst
    api_manual/soda.rst
    api_manual/async_connection.rst
    api_manual/async_connection_pool.rst
    api_manual/async_cursor.rst
    api_manual/async_lob.rst
    api_manual/async_aq.rst
    api_manual/pipeline.rst
    api_manual/deprecations.rst

.. toctree::
    :maxdepth: 1

    release_notes.rst
    license.rst

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

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