ds_provider_xledger_py_lib.dataset

File: __init__.py Region: ds_provider_xledger_py_lib/dataset

Description

This module implements a dataset for Xledger GraphQL APIs.

Submodules

• ds_provider_xledger_py_lib.dataset.engines
• ds_provider_xledger_py_lib.dataset.xledger

Classes

XledgerDataset	Tabular dataset for Xledger GraphQL operations.
XledgerDatasetSettings	Settings for Xledger dataset operations.

Package Contents

class ds_provider_xledger_py_lib.dataset.XledgerDataset

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

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

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

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

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

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

Rename is not supported by this dataset.

upsert() → NoReturn

Upsert is not supported by this dataset.

purge() → NoReturn

Purge is not supported by this dataset.

list() → NoReturn

List is not supported by this dataset.

close() → None

Close the linked-service connection.

class ds_provider_xledger_py_lib.dataset.XledgerDatasetSettings

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.