ds_provider_mock_py_lib.enums
=============================

.. py:module:: ds_provider_mock_py_lib.enums

.. autoapi-nested-parse::

   **File:** ``enums.py``
   **Region:** ``ds_provider_mock_py_lib/enums``

   Constants for the mock provider.

   .. rubric:: Example

   >>> ResourceType.LINKED_SERVICE
   'ds.resource.linked-service.mock'
   >>> ResourceType.DATASET
   'ds.resource.dataset.mock'
   >>> ConnectBehaviour.OK
   'ok'



Classes
-------

.. autoapisummary::

   ds_provider_mock_py_lib.enums.ResourceType
   ds_provider_mock_py_lib.enums.ConnectBehaviour
   ds_provider_mock_py_lib.enums.ColumnKind
   ds_provider_mock_py_lib.enums.RowOp
   ds_provider_mock_py_lib.enums.RaiseAs


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

.. py:class:: ResourceType

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


   Resource type identifiers for the mock provider.


   .. py:attribute:: LINKED_SERVICE
      :value: 'ds.resource.linked-service.mock'



   .. py:attribute:: DATASET
      :value: 'ds.resource.dataset.mock'



.. py:class:: ConnectBehaviour

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


   What ``connect()`` does. Values are lowercase per the linked-service contract.


   .. py:attribute:: OK
      :value: 'ok'



   .. py:attribute:: CONNECTION_ERROR
      :value: 'connection_error'



   .. py:attribute:: AUTHENTICATION_ERROR
      :value: 'authentication_error'



   .. py:attribute:: AUTHORIZATION_ERROR
      :value: 'authorization_error'



.. py:class:: ColumnKind

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


   Synthetic column value generators used by ``MockDataset``.


   .. py:attribute:: SEQUENCE
      :value: 'sequence'



   .. py:attribute:: CONSTANT
      :value: 'constant'



   .. py:attribute:: TEXT
      :value: 'text'



   .. py:attribute:: RANDOM_INT
      :value: 'random_int'



   .. py:attribute:: RANDOM_FLOAT
      :value: 'random_float'



   .. py:attribute:: BOOL
      :value: 'bool'



   .. py:attribute:: TIMESTAMP
      :value: 'timestamp'



   .. py:attribute:: ENUM
      :value: 'enum'



.. py:class:: RowOp

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


   Intended row kind for incremental generation and operation metadata.

   These are not gold merge opcodes. Gold decides from primary key and row
   hash:

   - ``insert``: new unique primary key
   - ``update``: existing primary key, changed column values (hash changes)
   - ``noop``: existing primary key, identical row (same hash)


   .. py:attribute:: INSERT
      :value: 'insert'



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



   .. py:attribute:: NOOP
      :value: 'noop'



.. py:class:: RaiseAs

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


   Which contract exception a dataset-level injected failure raises.


   .. py:attribute:: READ_ERROR
      :value: 'read_error'



   .. py:attribute:: CONNECTION_ERROR
      :value: 'connection_error'