.. _api-backends:

=============
Backends API
=============

This section provides the complete API reference for QuantumEngine's backend system.

.. contents:: Table of Contents
   :local:
   :depth: 2

Connection Management
---------------------

.. automodule:: quantumengine.connection
   :members:
   :undoc-members:
   :show-inheritance:

Backend Configuration
---------------------

Backend configuration and management utilities for connecting to different database systems.

Configuration Functions
~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: quantumengine.configure_backend

.. autofunction:: quantumengine.get_backend_config

Connection Functions
~~~~~~~~~~~~~~~~~~~~

.. autofunction:: quantumengine.connection.get_connection

.. autofunction:: quantumengine.connection.close_connection

.. autofunction:: quantumengine.connection.close_all_connections

Backend Implementations
-----------------------

SurrealDB Backend
~~~~~~~~~~~~~~~~~

SurrealDB-specific backend implementation for multi-model database operations.

.. autoclass:: quantumengine.backends.surrealdb.SurrealDBBackend
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: quantumengine.backends.surrealdb.SurrealDBConnection
   :members:
   :undoc-members:
   :show-inheritance:

ClickHouse Backend
~~~~~~~~~~~~~~~~~~

ClickHouse-specific backend implementation for analytical workloads.

.. autoclass:: quantumengine.backends.clickhouse.ClickHouseBackend
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: quantumengine.backends.clickhouse.ClickHouseConnection
   :members:
   :undoc-members:
   :show-inheritance:

Backend Interface
-----------------

Base Backend Classes
~~~~~~~~~~~~~~~~~~~~

Abstract base classes that define the backend interface.

.. autoclass:: quantumengine.backends.base.BaseBackend
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: quantumengine.backends.base.BaseConnection
   :members:
   :undoc-members:
   :show-inheritance:

Backend Registry
~~~~~~~~~~~~~~~~

Registry system for managing available backends.

.. autoclass:: quantumengine.backends.registry.BackendRegistry
   :members:
   :undoc-members:
   :show-inheritance:

.. autofunction:: quantumengine.backends.registry.register_backend

.. autofunction:: quantumengine.backends.registry.get_backend

.. autofunction:: quantumengine.backends.registry.list_backends

Schema Management
-----------------

Schema definition and management for different backends.

.. automodule:: quantumengine.schema
   :members:
   :undoc-members:
   :show-inheritance:

Schemaless Operations
~~~~~~~~~~~~~~~~~~~~~

Support for schemaless document operations.

.. automodule:: quantumengine.schemaless
   :members:
   :undoc-members:
   :show-inheritance:

Data Grid API
-------------

High-level API for data grid operations across backends.

.. automodule:: quantumengine.datagrid_api
   :members:
   :undoc-members:
   :show-inheritance:

Materialized Views
------------------

Support for materialized views and computed documents.

.. automodule:: quantumengine.materialized_view
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: quantumengine.materialized_document
   :members:
   :undoc-members:
   :show-inheritance:

Backend Utilities
-----------------

Connection Pooling
~~~~~~~~~~~~~~~~~~

Connection pool management for efficient database connections.

.. autoclass:: quantumengine.connection.ConnectionPool
   :members:
   :undoc-members:
   :show-inheritance:

Backend Detection
~~~~~~~~~~~~~~~~~

Utilities for detecting and validating backend configurations.

.. autofunction:: quantumengine.backends.utils.detect_backend

.. autofunction:: quantumengine.backends.utils.validate_backend_config

.. autofunction:: quantumengine.backends.utils.get_backend_capabilities

Backend-Specific Features
--------------------------

SurrealDB Features
~~~~~~~~~~~~~~~~~~

SurrealDB-specific functionality and optimizations.

.. automodule:: quantumengine.backends.surrealdb.features
   :members:
   :undoc-members:
   :show-inheritance:

ClickHouse Features
~~~~~~~~~~~~~~~~~~~

ClickHouse-specific functionality and optimizations.

.. automodule:: quantumengine.backends.clickhouse.features
   :members:
   :undoc-members:
   :show-inheritance:

Migration Support
-----------------

Tools for migrating data between backends.

.. automodule:: quantumengine.migration
   :members:
   :undoc-members:
   :show-inheritance:

Performance Monitoring
-----------------------

Backend performance monitoring and metrics.

.. automodule:: quantumengine.backends.monitoring
   :members:
   :undoc-members:
   :show-inheritance:

Exception Handling
-------------------

Backend-specific exception handling and error management.

.. autoclass:: quantumengine.exceptions.BackendError
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: quantumengine.exceptions.ConnectionError
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: quantumengine.exceptions.BackendConfigurationError
   :members:
   :undoc-members:
   :show-inheritance:

See Also
--------

* :doc:`/backends/index` - Comprehensive backends guide
* :doc:`/query/index` - Query system documentation
* :doc:`/fields/index` - Field types and backend compatibility
* :doc:`/exceptions/index` - Exception handling guide