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

.. py:module:: ds_provider_xledger_py_lib.dataset

.. autoapi-nested-parse::

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

   Description
   -----------
   This module implements a dataset for Xledger GraphQL APIs.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ds_provider_xledger_py_lib/dataset/engines/index
   /autoapi/ds_provider_xledger_py_lib/dataset/xledger/index


Classes
-------

.. autoapisummary::

   ds_provider_xledger_py_lib.dataset.XledgerDataset
   ds_provider_xledger_py_lib.dataset.XledgerDatasetSettings


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

.. py:class:: XledgerDataset

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


   Tabular dataset for Xledger GraphQL operations.


   .. py:attribute:: linked_service
      :type:  XledgerLinkedServiceType


   .. py:attribute:: settings
      :type:  XledgerDatasetSettingsType


   .. py:attribute:: serializer
      :type:  ds_provider_xledger_py_lib.serde.serializer.XledgerSerializer | None


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


   .. py:attribute:: introspection
      :type:  ds_provider_xledger_py_lib.utils.introspection.IntrospectionService


   .. py:method:: __post_init__() -> None


   .. py:property:: supports_checkpoint
      :type: bool


      Whether this dataset supports checkpointing.


   .. py:property:: type
      :type: ds_provider_xledger_py_lib.enums.ResourceType


      Return the dataset resource type.


   .. py:method:: read() -> None

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

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



   .. py:method:: 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.
      :raises AuthorizationError: If authorization fails.
      :raises ConnectionError: If the transport cannot reach the endpoint.
      :raises CreateError: If mutation execution fails.



   .. py:method:: 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.
      :raises AuthorizationError: If authorization fails.
      :raises ConnectionError: If the transport cannot reach the endpoint.
      :raises UpdateError: If update operation fails.



   .. py:method:: 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.
      :raises AuthorizationError: If authorization fails.
      :raises ConnectionError: If the transport cannot reach the endpoint.
      :raises DeleteError: If delete operation fails.



   .. py:method:: rename() -> NoReturn

      Rename is not supported by this dataset.



   .. py:method:: upsert() -> NoReturn

      Upsert is not supported by this dataset.



   .. py:method:: purge() -> NoReturn

      Purge is not supported by this dataset.



   .. py:method:: list() -> NoReturn

      List is not supported by this dataset.



   .. py:method:: close() -> None

      Close the linked-service connection.



.. py:class:: XledgerDatasetSettings

   Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings`


   Settings for Xledger dataset operations.


   .. py:attribute:: entrypoint
      :type:  str

      Xledger entrypoint name targeted by dataset operations.


   .. py:attribute:: read
      :type:  XledgerReadSettings

      Settings for Xledger read operations.


   .. py:attribute:: create
      :type:  XledgerCreateSettings

      Settings for Xledger create operations.


   .. py:attribute:: update
      :type:  XledgerUpdateSettings

      Settings for Xledger update operations.


   .. py:attribute:: delete
      :type:  XledgerDeleteSettings

      Settings for Xledger delete operations.