alanlv / fastapi-multitenant-example-app

Based on Multitenancy with FastAPI, SQLAlchemy and PostgreSQL

Main differences: Alembic behavior. All tables are created using migrations. Each tenant schema has his own alembic_version table with information about current migration revision.

---

⚠️This is a proof of concept only. More mature version available in this repository

---

Workflow

• FastAPI runs on each startup migration d6ba8c13303e (create default Tables in PG public schema if not exists)

  • Can be run manual: alembic -x tenant=public upgrade d6ba8c13303e

• Create new schema (ex: a) and store information about it: ``GET /create?name=a&schema=a&host=a`

• Apply all migrations: GET /upgrade?schema=a

  • manual test alembic -x dry_run=True -x tenant=a upgrade head
  • Manual run: alembic -x tenant=a upgrade head

Alembic

Auto generowanie modelu

alembic revision --autogenerate -m "Add description"

Ręczne utworzenie migracji

alembic revision -m "Add manual change"

Uruchomienie wszystkich migracji:

alembic upgrade head

Rollback migracji

alembic downgrade -1

pyTest

(.venv) fastapi-multitenant-example-app$ coverage run -m pytest -v tests && coverage report -m

coverage html

Postgres

CREATE TABLE shared.shared_users (
    id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
    email varchar(256) UNIQUE NOT NULL,  
    tenant_id int NOT NULL,
	is_active bool NOT NULL DEFAULT false,
    created_at timestamptz NOT NULL DEFAULT timezone('utc', now()),
    updated_at timestamptz
);

CREATE TABLE tenant_default.users (
    id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
    email varchar(256) UNIQUE,  
    first_name varchar(100),
    last_name varchar(100),
    user_role_id int,
    created_at timestamptz,
    updated_at timestamptz
);

CREATE TABLE tenant_default.permissions (
    id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
    uuid uuid UNIQUE,
    account_id int,
    name varchar(100),
    title varchar(100),
    description varchar(100)
);


CREATE TABLE tenant_default.roles (
    id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
    role_name varchar(100),
    role_description varchar(100)
);

CREATE TABLE tenant_default.roles_permissions_link (
    role_id int,
    permission_id int,
    PRIMARY KEY(role_id, permission_id)
);

ALTER TABLE tenant_default.roles_permissions_link ADD CONSTRAINT roles_permissions_link_fk FOREIGN KEY (permission_id) REFERENCES tenant_default.permissions(id);
ALTER TABLE tenant_default.roles_permissions_link ADD CONSTRAINT roles_permissions_link_fk_1 FOREIGN KEY (role_id) REFERENCES tenant_default.roles(id);
ALTER TABLE tenant_default.users ADD CONSTRAINT role_FK FOREIGN KEY (user_role_id) REFERENCES tenant_default.roles(id);