ds_provider_xledger_py_lib.dataset.xledger ========================================== .. py:module:: ds_provider_xledger_py_lib.dataset.xledger .. autoapi-nested-parse:: **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 ---------- .. autoapisummary:: ds_provider_xledger_py_lib.dataset.xledger.logger ds_provider_xledger_py_lib.dataset.xledger.XledgerDatasetSettingsType ds_provider_xledger_py_lib.dataset.xledger.XledgerLinkedServiceType Classes ------- .. autoapisummary:: ds_provider_xledger_py_lib.dataset.xledger.XledgerReadSettings ds_provider_xledger_py_lib.dataset.xledger.XledgerCreateSettings ds_provider_xledger_py_lib.dataset.xledger.XledgerUpdateSettings ds_provider_xledger_py_lib.dataset.xledger.XledgerDeleteSettings ds_provider_xledger_py_lib.dataset.xledger.XledgerDatasetSettings ds_provider_xledger_py_lib.dataset.xledger.XledgerDataset Module Contents --------------- .. py:data:: logger .. py:class:: XledgerReadSettings Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings` Settings for Xledger read operations. .. py:attribute:: first :type: int :value: 1000 The number of records to return. .. py:attribute:: last :type: int | None :value: None The last record to return. .. py:attribute:: before :type: str | None :value: None The cursor to return the previous page of results. .. py:attribute:: after :type: str | None :value: None The cursor to return the next page of results. .. py:attribute:: filter :type: dict[str, Any] | None :value: None The filter to apply to the query. .. py:attribute:: owner_set :type: ds_provider_xledger_py_lib.enums.OwnerSet | None :value: None The owner set to return. .. py:attribute:: object_status :type: ds_provider_xledger_py_lib.enums.ObjectStatus | None :value: None The object status to return. .. py:attribute:: columns :type: list[str] | None :value: None The columns to return. .. py:attribute:: pagination :type: bool :value: False Whether to return pagination information. .. py:class:: XledgerCreateSettings Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings` Settings for Xledger create operations. .. py:attribute:: return_columns :type: list[str] | None :value: None The columns to return. .. py:class:: XledgerUpdateSettings Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings` Settings for Xledger update operations. .. py:attribute:: return_columns :type: list[str] | None :value: None The columns to return. .. py:class:: XledgerDeleteSettings Bases: :py:obj:`ds_resource_plugin_py_lib.common.resource.dataset.DatasetSettings` Settings for Xledger delete operations. .. py:attribute:: return_columns :type: list[str] | None :value: None The columns to return. .. 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. .. py:data:: XledgerDatasetSettingsType .. py:data:: XledgerLinkedServiceType .. 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.