ds_provider_xledger_py_lib.dataset.engines.read

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

Description

Read engine for paginated GraphQL execution.

Attributes

logger

Classes

Checkpoint	Read checkpoint state used by the read engine.
ReadEngine	Execute Xledger read requests including pagination handling.

Module Contents

ds_provider_xledger_py_lib.dataset.engines.read.logger

class ds_provider_xledger_py_lib.dataset.engines.read.Checkpoint

Bases: ds_common_serde_py_lib.serializable.Serializable

Read checkpoint state used by the read engine.

after: str | None = None

has_next_page: bool = False

class ds_provider_xledger_py_lib.dataset.engines.read.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

connection: ds_protocol_http_py_lib.utils.http.provider.Http

host: str

deserializer: ds_provider_xledger_py_lib.serde.deserializer.XledgerDeserializer

metadata: ds_provider_xledger_py_lib.utils.introspection.MetaData

output: list[pandas.DataFrame] = []

checkpoint: Checkpoint

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.

Parameters:

• read_settings – Effective read settings for query rendering/pagination.

• checkpoint – Existing checkpoint state to continue from.