app.dal ======= .. py:module:: app.dal .. autoapi-nested-parse:: Data acess layer (DAL) between fastapi endpoint and sql database for user data. Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/app/dal/protocol_dal/index /autoapi/app/dal/result_dal/index /autoapi/app/dal/task_dal/index Functions --------- .. autoapisummary:: app.dal.get_user_data app.dal.update_user_data app.dal.get_user_from_token app.dal.get_all_users app.dal.add_user app.dal.delete_user_data Module Contents --------------- .. py:function:: get_user_data(username: str) -> app.db.UserSQL | None :async: Get user by username. Parameters ---------- username Username as entered by the user. Primary key in db. Returns ------- Database orm model of User or none .. py:function:: update_user_data(username: str, data: dict) -> app.db.UserSQL | None :async: Update existing user entry. Parameters ---------- username Primary key of the entry in db to be updated. data Data to be written. Does not need to contain all columns. Returns ------- Database orm model of updated user .. py:function:: get_user_from_token(access_token: str) -> app.db.UserSQL | None :async: Get user from token. Parameters ---------- token Token. Unique in database. Returns ------- The user as read from database or None if the token is not found. .. py:function:: get_all_users() -> list[app.db.UserSQL] :async: Get a list of all existing users. Returns ------- List of database orm models .. py:function:: add_user(user: app.db.UserSQL) :async: Create a new user entry in database. Parameters ---------- user UserSQL ORM model. Returns ------- User database entry .. py:function:: delete_user_data(username: str) -> bool :async: Delete user by username. Parameters ---------- username Username of the user to be deleted Returns ------- Success of deletion