cowbird.database.base
=====================

.. py:module:: cowbird.database.base


Classes
-------

.. autoapisummary::

   cowbird.database.base.DatabaseInterface


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

.. py:class:: DatabaseInterface(_: cowbird.typedefs.AnySettingsContainer)

   Return the unique identifier of db type matching settings.

   Database interface defining a minimum set of function mostly around store management.


   .. py:attribute:: __slots__
      :value: ['type']



   .. py:method:: _get_store_type(store_type: cowbird.typedefs.StoreSelector) -> str
      :staticmethod:



   .. py:method:: get_store(store_type: cowbird.typedefs.StoreSelector, *store_args: Any, **store_kwargs: Any) -> cowbird.database.stores.StoreInterface
      :abstractmethod:



   .. py:method:: reset_store(store_type: cowbird.typedefs.StoreSelector) -> cowbird.database.stores.StoreInterface
      :abstractmethod:



   .. py:method:: get_session() -> Any
      :abstractmethod:



   .. py:method:: get_information() -> cowbird.typedefs.JSON
      :abstractmethod:


      :returns: {'version': version, 'type': db_type}



   .. py:method:: is_ready() -> bool
      :abstractmethod: