mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-15 11:11:16 +08:00
c4de66b81c
* Implement Transport classes * Implement authentication strategy classes * Revamp authentication with Transport and Strategy * Revamp strategy and OAuth so that they can use a callable dependency * Update docstring * Make ErrorCode a proper Enum and cleanup unused OpenAPI utils * Remove useless check * Tweak typing in authenticator * Update docs * Improve logout/destroy token logic * Update docs * Update docs * Update docs and full examples * Apply formatting to examples * Update OAuth doc and examples * Add migration doc * Implement Redis session token * Add Redis Session documentation * RedisSession -> Redis * Fix links in docs
70 lines
2.3 KiB
Markdown
70 lines
2.3 KiB
Markdown
# Tortoise ORM
|
|
|
|
**FastAPI Users** provides the necessary tools to work with Tortoise ORM.
|
|
|
|
## Installation
|
|
|
|
Install the database driver that corresponds to your DBMS:
|
|
|
|
```sh
|
|
pip install asyncpg
|
|
```
|
|
|
|
```sh
|
|
pip install aiomysql
|
|
```
|
|
|
|
```sh
|
|
pip install aiosqlite
|
|
```
|
|
|
|
For the sake of this tutorial from now on, we'll use a simple SQLite databse.
|
|
|
|
## Setup User table and model
|
|
|
|
Let's declare our User ORM model.
|
|
|
|
```py hl_lines="18 19"
|
|
--8<-- "docs/src/db_tortoise_model.py"
|
|
```
|
|
|
|
As you can see, **FastAPI Users** provides an abstract model that will include base fields for our User table. You can of course add you own fields there to fit to your needs!
|
|
|
|
In order to make the Pydantic model and the Tortoise ORM model working well together, you'll have to add a mixin and some configuration options to your `UserDB` model. Tortoise ORM provides [utilities to ease the integration with Pydantic](https://tortoise-orm.readthedocs.io/en/latest/contrib/pydantic.html) and we'll use them here.
|
|
|
|
```py hl_lines="22 23 24 25 26"
|
|
--8<-- "docs/src/db_tortoise_model.py"
|
|
```
|
|
|
|
The `PydanticModel` mixin adds methods used internally by Tortoise ORM to the Pydantic model so that it can easily transform it back to an ORM model. It expects then that you provide the property `orig_model` which should point to the **User ORM model we defined just above**.
|
|
|
|
## Create the database adapter
|
|
|
|
The database adapter of **FastAPI Users** makes the link between your database configuration and the users logic. It should be generated by a FastAPI dependency.
|
|
|
|
```py hl_lines="8 9"
|
|
--8<-- "docs/src/db_tortoise_adapter.py"
|
|
```
|
|
|
|
Notice that we pass a reference to your [`UserDB` model](../models.md).
|
|
|
|
## Register Tortoise
|
|
|
|
For using Tortoise ORM we must register our models and database.
|
|
|
|
Tortoise ORM supports integration with FastAPI out-of-the-box. It will automatically bind startup and shutdown events.
|
|
|
|
```py
|
|
from tortoise.contrib.fastapi import register_tortoise
|
|
|
|
register_tortoise(
|
|
app,
|
|
db_url=DATABASE_URL,
|
|
modules={"models": ["models"]},
|
|
generate_schemas=True,
|
|
)
|
|
```
|
|
|
|
!!! warning
|
|
In production, it's strongly recommended to setup a migration system to update your SQL schemas. See [https://tortoise-orm.readthedocs.io/en/latest/migration.html](https://tortoise-orm.readthedocs.io/en/latest/migration.html).
|