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

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

.. autoapi-nested-parse::

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

   Description
   -----------
   Read engine for paginated GraphQL execution.



Attributes
----------

.. autoapisummary::

   ds_provider_xledger_py_lib.dataset.engines.read.logger


Classes
-------

.. autoapisummary::

   ds_provider_xledger_py_lib.dataset.engines.read.Checkpoint
   ds_provider_xledger_py_lib.dataset.engines.read.ReadEngine


Module Contents
---------------

.. py:data:: logger

.. py:class:: Checkpoint

   Bases: :py:obj:`ds_common_serde_py_lib.serializable.Serializable`


   Read checkpoint state used by the read engine.


   .. py:attribute:: after
      :type:  str | None
      :value: None



   .. py:attribute:: has_next_page
      :type:  bool
      :value: False



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