gsheet_db
=========

.. py:module:: gsheet_db


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/gsheet_db/gsheet_db/index




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

.. py:class:: GsheetsDb

   Bases: :py:obj:`auto_archiver.core.Database`


   NB: only works if GsheetFeeder is used.
   could be updated in the future to support non-GsheetFeeder metadata


   .. py:method:: started(item: auto_archiver.core.Metadata) -> None

      signals the DB that the given item archival has started



   .. py:method:: failed(item: auto_archiver.core.Metadata, reason: str) -> None

      update DB accordingly for failure



   .. py:method:: aborted(item: auto_archiver.core.Metadata) -> None

      abort notification if user cancelled after start



   .. py:method:: fetch(item: auto_archiver.core.Metadata) -> Union[auto_archiver.core.Metadata, bool]

      check if the given item has been archived already



   .. py:method:: done(item: auto_archiver.core.Metadata, cached: bool = False) -> None

      archival result ready - should be saved to DB