core.database#

Database module for the auto-archiver that defines the interface for implementing database modules in the media archiving framework.

Module Contents#

class core.database.Database#

Bases: auto_archiver.core.BaseModule

Base class for implementing database modules in the media archiving framework.

Subclasses must implement the fetch and done methods to define platform-specific behavior.

started(item: auto_archiver.core.Metadata) → None#: signals the DB that the given item archival has started

failed(item: auto_archiver.core.Metadata, reason: str) → None#: update DB accordingly for failure

aborted(item: auto_archiver.core.Metadata) → None#: abort notification if user cancelled after start

fetch(item: auto_archiver.core.Metadata) → auto_archiver.core.Metadata | bool#: check and fetch if the given item has been archived already, each database should handle its own caching, and configuration mechanisms

abstract done(item: auto_archiver.core.Metadata, cached: bool = False) → None#: archival result ready - should be saved to DB