ds_provider_xledger_py_lib.dataset.xledger¶

File: xledger.py Region: ds_provider_xledger_py_lib/dataset

Description¶

Xledger dataset implementation.

This module follows the same high-level architecture as the HTTP protocol dataset:

linked service owns transport and authentication
dataset owns operation intent and contract behavior
serializer builds GraphQL query strings from tabular input
deserializer converts API response content to pandas.DataFrame

Attributes¶

`logger`
`XledgerDatasetSettingsType`
`XledgerLinkedServiceType`

Classes¶

`XledgerReadSettings`	Settings for Xledger read operations.
`XledgerCreateSettings`	Settings for Xledger create operations.
`XledgerUpdateSettings`	Settings for Xledger update operations.
`XledgerDeleteSettings`	Settings for Xledger delete operations.
`XledgerDatasetSettings`	Settings for Xledger dataset operations.
`XledgerDataset`	Tabular dataset for Xledger GraphQL operations.

Module Contents¶

ds_provider_xledger_py_lib.dataset.xledger.logger¶

class ds_provider_xledger_py_lib.dataset.xledger.XledgerReadSettings[source]¶

Bases: ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings

Settings for Xledger read operations.

first: int = 1000¶: The number of records to return.

last: int | None = None¶: The last record to return.

before: str | None = None¶: The cursor to return the previous page of results.

after: str | None = None¶: The cursor to return the next page of results.

filter: dict[str, Any] | None = None¶: The filter to apply to the query.

owner_set: ds_provider_xledger_py_lib.enums.OwnerSet | None = None¶: The owner set to return.

object_status: ds_provider_xledger_py_lib.enums.ObjectStatus | None = None¶: The object status to return.

columns: list[str] | None = None¶: The columns to return.

pagination: bool = False¶: Whether to return pagination information.

class ds_provider_xledger_py_lib.dataset.xledger.XledgerCreateSettings[source]¶

Bases: ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings

Settings for Xledger create operations.

return_columns: list[str] | None = None¶: The columns to return.

class ds_provider_xledger_py_lib.dataset.xledger.XledgerUpdateSettings[source]¶

Bases: ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings

Settings for Xledger update operations.

return_columns: list[str] | None = None¶: The columns to return.

class ds_provider_xledger_py_lib.dataset.xledger.XledgerDeleteSettings[source]¶

Bases: ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings

Settings for Xledger delete operations.

return_columns: list[str] | None = None¶: The columns to return.

class ds_provider_xledger_py_lib.dataset.xledger.XledgerDatasetSettings[source]¶

Bases: ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings

Settings for Xledger dataset operations.

entrypoint: str¶: Xledger entrypoint name targeted by dataset operations.

read: XledgerReadSettings¶: Settings for Xledger read operations.

create: XledgerCreateSettings¶: Settings for Xledger create operations.

update: XledgerUpdateSettings¶: Settings for Xledger update operations.

delete: XledgerDeleteSettings¶: Settings for Xledger delete operations.

ds_provider_xledger_py_lib.dataset.xledger.XledgerDatasetSettingsType¶

ds_provider_xledger_py_lib.dataset.xledger.XledgerLinkedServiceType¶

class ds_provider_xledger_py_lib.dataset.xledger.XledgerDataset[source]¶

Bases: ds_resource_plugin_py_lib.common.resource.dataset.TabularDataset[XledgerLinkedServiceType, XledgerDatasetSettingsType, ds_provider_xledger_py_lib.serde.serializer.XledgerSerializer, ds_provider_xledger_py_lib.serde.deserializer.XledgerDeserializer], Generic[XledgerLinkedServiceType, XledgerDatasetSettingsType]

Tabular dataset for Xledger GraphQL operations.

linked_service: XledgerLinkedServiceType¶

settings: XledgerDatasetSettingsType¶

serializer: ds_provider_xledger_py_lib.serde.serializer.XledgerSerializer | None¶

deserializer: ds_provider_xledger_py_lib.serde.deserializer.XledgerDeserializer | None¶

introspection: ds_provider_xledger_py_lib.utils.introspection.IntrospectionService¶

__post_init__() → None[source]¶

property supports_checkpoint: bool¶: Whether this dataset supports checkpointing.

property type: ds_provider_xledger_py_lib.enums.ResourceType¶: Return the dataset resource type.

read() → None[source]¶

Execute a GraphQL query and store the result in self.output.

Raises:

AuthenticationError – If authentication fails.
AuthorizationError – If authorization fails.
ConnectionError – If the transport cannot reach the endpoint.
ReadError – If query execution fails.

create() → None[source]¶

Execute a GraphQL mutation built from self.input.

For empty input, this method is a no-op and returns successfully.

Raises:

AuthenticationError – If authentication fails.
AuthorizationError – If authorization fails.
ConnectionError – If the transport cannot reach the endpoint.
CreateError – If mutation execution fails.

update() → None[source]¶

Execute a GraphQL mutation built from self.input.

For empty input, this method is a no-op and returns successfully.

Raises:

AuthenticationError – If authentication fails.
AuthorizationError – If authorization fails.
ConnectionError – If the transport cannot reach the endpoint.
UpdateError – If update operation fails.

delete() → None[source]¶

Execute a GraphQL mutation built from self.input.

For empty input, this method is a no-op and returns successfully.

Raises:

AuthenticationError – If authentication fails.
AuthorizationError – If authorization fails.
ConnectionError – If the transport cannot reach the endpoint.
DeleteError – If delete operation fails.

rename() → NoReturn[source]¶: Rename is not supported by this dataset.

upsert() → NoReturn[source]¶: Upsert is not supported by this dataset.

purge() → NoReturn[source]¶: Purge is not supported by this dataset.

list() → NoReturn[source]¶: List is not supported by this dataset.

close() → None[source]¶: Close the linked-service connection.