ds_provider_xledger_py_lib.dataset.engines
==========================================

.. py:module:: ds_provider_xledger_py_lib.dataset.engines

.. autoapi-nested-parse::

   **File:** ``__init__.py``
   **Region:** ``ds_provider_xledger_py_lib/dataset/engines``

   Description
   -----------
   Dataset execution engines.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ds_provider_xledger_py_lib/dataset/engines/read/index


Classes
-------

.. autoapisummary::

   ds_provider_xledger_py_lib.dataset.engines.ReadEngine


Package Contents
----------------

.. py:class:: ReadEngine

   Execute Xledger read requests including pagination handling.

   This engine is intentionally stateful:
   - ``output`` accumulates collected rows page-by-page
   - ``checkpoint`` tracks the last valid pagination state


   .. py:attribute:: connection
      :type:  ds_protocol_http_py_lib.utils.http.provider.Http


   .. py:attribute:: host
      :type:  str


   .. py:attribute:: deserializer
      :type:  ds_provider_xledger_py_lib.serde.deserializer.XledgerDeserializer


   .. py:attribute:: metadata
      :type:  ds_provider_xledger_py_lib.utils.introspection.MetaData


   .. py:attribute:: output
      :type:  list[pandas.DataFrame]
      :value: []



   .. py:attribute:: checkpoint
      :type:  Checkpoint


   .. py:method:: execute(*, read_settings: ds_provider_xledger_py_lib.dataset.xledger.XledgerReadSettings, checkpoint: dict[str, Any] | None = None) -> None

      Execute read flow and update ``output``/``checkpoint`` state.

      :param read_settings: Effective read settings for query rendering/pagination.
      :param checkpoint: Existing checkpoint state to continue from.