app.dal#
Data acess layer (DAL) between fastapi endpoint and sql database for user data.
Submodules#
Functions#
|
Get user by username. |
|
Update existing user entry. |
|
Get user from token. |
|
Get a list of all existing users. |
|
Create a new user entry in database. |
|
Delete user by username. |
Module Contents#
- async app.dal.get_user_data(username: str) app.db.UserSQL | None#
Get user by username.
Parameters#
- username
Username as entered by the user. Primary key in db.
Returns#
Database orm model of User or none
- async app.dal.update_user_data(username: str, data: dict) app.db.UserSQL | None#
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
- async app.dal.get_user_from_token(access_token: str) app.db.UserSQL | None#
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.
- async app.dal.get_all_users() list[app.db.UserSQL]#
Get a list of all existing users.
Returns#
List of database orm models
- async app.dal.add_user(user: app.db.UserSQL)#
Create a new user entry in database.
Parameters#
- user
UserSQL ORM model.
Returns#
User database entry