fastapi-users/docs/configuration/databases/ormar.md

Ormar

FastAPI Users provides the necessary tools to work with ormar.

Installation

Install the database driver that corresponds to your DBMS:

pip install asyncpg psycopg2

pip install aiomysql pymysql

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.

{!./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.

{!./src/db_ormar.py!}

Notice that we pass a reference to your UserDB model.

!!! warning In production, it's strongly recommended to setup a migration system to update your SQL schemas. See Alembic.