Skip to content
You're not viewing the latest version. Click here to go to latest.

# 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 and model

Let's declare our User ORM model.

    from fastapi_users import models
    from fastapi_users.db import TortoiseBaseUserModel
    from tortoise.contrib.pydantic import PydanticModel

    class User(models.BaseUser):
        pass

    class UserCreate(models.BaseUserCreate):
        pass

    class UserUpdate(models.BaseUserUpdate):
        pass

    class UserModel(TortoiseBaseUserModel):
        pass

    class UserDB(User, models.BaseUserDB, PydanticModel):
        class Config:
            orm_mode = True
            orig_model = UserModel

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 and we'll use them here.

    from fastapi_users import models
    from fastapi_users.db import TortoiseBaseUserModel
    from tortoise.contrib.pydantic import PydanticModel

    class User(models.BaseUser):
        pass

    class UserCreate(models.BaseUserCreate):
        pass

    class UserUpdate(models.BaseUserUpdate):
        pass

    class UserModel(TortoiseBaseUserModel):
        pass

    class UserDB(User, models.BaseUserDB, PydanticModel):
        class Config:
            orm_mode = True
            orig_model = UserModel

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.

    from fastapi_users.db import TortoiseUserDatabase

    from .models import UserDB, UserModel

    DATABASE_URL = "sqlite://./test.db"

    async def get_user_db():
        yield TortoiseUserDatabase(UserDB, UserModel)

Notice that we pass a reference to your `UserDB` model.

## 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.

    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.

Back to top