mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-16 03:40:23 +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
50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# Ormar
|
|
|
|
**FastAPI Users** provides the necessary tools to work with ormar.
|
|
|
|
## Installation
|
|
|
|
Install the database driver that corresponds to your DBMS:
|
|
|
|
```sh
|
|
pip install asyncpg psycopg2
|
|
```
|
|
|
|
```sh
|
|
pip install aiomysql pymysql
|
|
```
|
|
|
|
```sh
|
|
pip install aiosqlite
|
|
```
|
|
|
|
For the sake of this tutorial from now on, we'll use a simple SQLite database.
|
|
|
|
## Setup User table
|
|
|
|
Let's declare our User ORM model.
|
|
|
|
```py hl_lines="12-16"
|
|
--8<-- "docs/src/db_ormar.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!
|
|
|
|
## 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="23-24"
|
|
--8<-- "docs/src/db_ormar.py"
|
|
```
|
|
|
|
Notice that we pass a reference to your [`UserDB` model](../models.md).
|
|
|
|
!!! warning
|
|
In production, it's strongly recommended to setup a migration system to
|
|
update your SQL schemas. See
|
|
[Alembic](https://alembic.sqlalchemy.org/en/latest/).
|