ds_resource_plugin_py_lib.common.resource.dataset.enums
=======================================================

.. py:module:: ds_resource_plugin_py_lib.common.resource.dataset.enums

.. autoapi-nested-parse::

   **File:** ``enums.py``
   **Region:** ``ds_resource_plugin_py_lib/common/resource/dataset``

   Description
   -----------
   Enumerations for dataset operations.



Classes
-------

.. autoapisummary::

   ds_resource_plugin_py_lib.common.resource.dataset.enums.DatasetMethod


Module Contents
---------------

.. py:class:: DatasetMethod

   Bases: :py:obj:`enum.StrEnum`


   Allowed dataset operation names.


   .. py:attribute:: CREATE
      :value: 'create'


      Insert rows into the target. Atomic. Not idempotent.


   .. py:attribute:: READ
      :value: 'read'


      Read all data from the source into ``self.output``. Idempotent.


   .. py:attribute:: UPDATE
      :value: 'update'


      Update existing rows matched by identity columns. Atomic. Idempotent.


   .. py:attribute:: UPSERT
      :value: 'upsert'


      Insert or update rows matched by identity columns. Atomic. Idempotent.


   .. py:attribute:: DELETE
      :value: 'delete'


      Remove specific rows matched by identity columns. Atomic. Idempotent.


   .. py:attribute:: PURGE
      :value: 'purge'


      Remove all content from the target. Atomic. Idempotent.


   .. py:attribute:: LIST
      :value: 'list'


      Discover available resources and populate ``self.output``. Idempotent.


   .. py:attribute:: RENAME
      :value: 'rename'


      Rename a resource in the backend. Atomic. Not idempotent.


   .. py:method:: all_values() -> frozenset[str]
      :staticmethod:


      Return all operation method values as a frozen set.