b5b0bbbb01
* add tortoise to dependencies * add tortoise as optional dependency in pyproject.toml * add tortoise support (tests needed) * Add tortoise support (also defined orm_mode in pydantic model * tests for tortoise support * format by black * docs for tortoise * delete type annotations * delete underscore * do it in 1 line * add 1 line before yield * fix in docs * fix bug and add annotation for test * Tweak documentation and fix Tortoise error about id update * Improve Tortoise coverage by using get instead of filter * Fix Pipfile.lock
1.2 KiB
Tortoise ORM
FastAPI Users provides the necessary tools to work with Tortoise ORM.
Installation
Install the database driver that corresponds to your DBMS:
pip install asyncpg
pip install aiomysql
pip install aiosqlite
For the sake of this tutorial from now on, we'll use a simple SQLite databse.
Setup User table
Let's declare our User model.
{!./src/db_tortoise.py!}
As you can see, FastAPI Users provides a mixin that will include base fields for our User table. You can of course add you own fields there to fit to your needs!
Create the database adapter
The database adapter of FastAPI Users makes the link between your database configuration and the users logic. Create it like this.
{!./src/db_tortoise.py!}
Register Tortoise
For using Tortoise ORM we must register our models and database.
Tortoise ORM supports integration with Starlette/FastAPI out-of-the-box. It will automatically bind startup and shutdown events.
{!./src/db_tortoise.py!}
Next steps
We will now configure an authentication method.