fastapi-nplusone 0.1.0

A middlewere to help find n+1 queries in sqlalchemy.

FastAPI / SQLAlchemy N+1 query middleware

A FastAPI middleware to find N+1 queries in development. This middleware helps developers identify and fix N+1 query issues in their FastAPI applications. It provides logging information to help locate the query and the number of N+1 query occurrences.

This middleware should probably not be used in production, but it can be useful during development and testing.

Installation

Pip Install:

pip install fastapi-nplusone

UV install:

uv install fastapi-nplusone

Poetry install:

poetry add fastapi-nplusone

Usage

This middleware while suitable to run in production should probably be limited to development and tesring. The code snippet below shows how to add the middleware to your application.

from fastapi import FastAPI
from fastapi_nplusone import NPlusOneMiddleware

app = FastAPI()
if not app.debug:
    app.add_middleware(NPlusOneMiddleware)

Example Output:

WARNING:fastapi_nplusone:Potential N+1 query detected on GET /api/changes: Query executed 3 times. Normalized query: SELECT change.id AS change_id

Tests

To run the tests:

uv run pytest ./tests