aim.digifeeds.database.main module

Fast API Main

The main document for Fast API

aim.digifeeds.database.main.add_item_status(barcode: str, status_name: str, db: ~sqlalchemy.orm.session.Session = Depends(dependency=<function get_db>, use_cache=True, scope=None)) → Item

Update a digifeeds item.

This is how to add a status to an existing item.

aim.digifeeds.database.main.create_item(barcode: str = Path(PydanticUndefined), db: ~sqlalchemy.orm.session.Session = Depends(dependency=<function get_db>, use_cache=True, scope=None)) → Item

Create a digifeeds item.

The item can be created with the barcode of the item and must not already exist.

aim.digifeeds.database.main.delete_item(barcode: str, db: ~sqlalchemy.orm.session.Session = Depends(dependency=<function get_db>, use_cache=True, scope=None)) → Item

aim.digifeeds.database.main.get_db()

aim.digifeeds.database.main.get_item(barcode: str = Path(PydanticUndefined), db: ~sqlalchemy.orm.session.Session = Depends(dependency=<function get_db>, use_cache=True, scope=None)) → Item

Get a digifeeds item.

The item can be fetched by the barcode of the item.

aim.digifeeds.database.main.get_items(offset: int = Query(0), limit: int = Query(50), filter: ~aim.digifeeds.database.schemas.ItemFilters = Query(None), q: str = Query(None), db: ~sqlalchemy.orm.session.Session = Depends(dependency=<function get_db>, use_cache=True, scope=None)) → PageOfItems

Get the digifeeds items.

These items can be filtered by whether or not their metadata is in Zephir, whether or not they are pending deletion, if they are not in alma, or all of them can be fetched.

aim.digifeeds.database.main.get_statuses(db: ~sqlalchemy.orm.session.Session = Depends(dependency=<function get_db>, use_cache=True, scope=None)) → list[Status]

Get digifeeds statuses.

Get a list of statuses.

aim.digifeeds.database.main.update_hathifiles_timestamp(barcode: str, timestamp: ~datetime.datetime, db: ~sqlalchemy.orm.session.Session = Depends(dependency=<function get_db>, use_cache=True, scope=None)) → Item