🚀 Roadmap

[tiangolo]

Description

This is a tentative roadmap, I will update it as things evolve. Some things might be discarded, others might be added later. I didn't want to make it fully public as it could raise expectations, but it seems it would be more beneficial for the community to know all the ideas and objectives.

Work on this is alternated (and sometimes mixed) with work on Typer, SQLModel, Asyncer, and others.

Answering questions, issues, and PRs is also intermixed with this, but as in some cases one of these features would solve several issues or questions, or potentially solve something done by one or more PRs, in many cases I focus on this a bit more than on answering specific issues, questions, PRs.

Maintenance

The word "maintenance" or "maintainer" doesn't have a very strict definition, and it probably varies a lot from perspective.

A lot of the work related to maintaining FastAPI is done by contributors by answering questions, reviewing PRs, etc.

You can help me ensure each existing PR is in shape (has tests, solves the problem, etc.). Make sure you filter out the translation PRs (most of them) unless you speak the language and can review them.

Security

When there are security issues, those are handled with the highest priority. Those are normally not handled in issues and PRs but in emails, it's not public until the security disclosure is made, in most cases (always, up to now) with the version that fixes them.

Roadmap

Now, here's the current high-level tentative roadmap:

• Support for the latest SQLAlchemy before 2.0 ⬆️ Upgrade support for SQLAlchemy 1.4.49, update tests #519
• Support for the latest Pydantic before 2.0 ✨ Add support for all Field parameters from Pydantic 1.9.0 and above, make Pydantic 1.9.0 the minimum required version #440
• Support for SQLAlchemy 2.0. ✨ Upgrade SQLAlchemy to 2.0, including initial work by farahats9 #700
• Support for Pydantic 2.0.
• Async tools and docs.
• Integrated migrations (using Alembic).
• Integrated CLI for migrations (using Typer).
• Integrated model generation from existing DBs.
• Reference (Code API) docs

All this is intermixed with reviews for PRs, issues, and discussions.

[Zaffer]

This is great news! So excited to start using these new features. I'm curious how you are planning in integrating Alembic?

[AntonDeMeester]

Is the goal to support both Pydantic v1 and v2 and SQL Alchemy v1 and v2? Or only v1+v1 and v2+v2? The combination of both will become difficult.

[honglei]

@AntonDeMeester @tiangolo Only support SQLAlchemy v1.4 with 2.0-style and v2.0?

[hyperknot]

Is there a branch of this project or a starter template for using FastAPI latest + SQLAlchemy 2 + Pydantic 2?

I'm starting a new project with FastAPI latest + SQLAlchemy 2 and I'm not sure what would be the right way to set it up? Should I just avoid SQLModel altogether?

[honglei]

@hyperknot Try #632

[hyperknot]

Thanks @honglei.

I've also found

• https://chaoticengineer.hashnode.dev/fastapi-sqlalchemy and
• https://github.com/rhoboro/async-fastapi-sqlalchemy

I'll personally not use SQLModel. It introduces way too much logic for a simple type checking functionality for me.

Duplicating a small amount of code in the codebase is much more maintainable than introducing an external dependency with a lot of logic involved.

[joshTax]

You can help me ensure each existing PR is in shape (has tests, solves the problem, etc.)

🫡

So glad to see signs of life in this amazing project.

[chamithdulshanadl]

We are using fast API with SQL Model for our microservices. And planning to add Llama index which needs SQLAlchemy above 1.4.41. But does not support by current SQL Model versions (required: >=1.4.17,<=1.4.41).

@tiangolo Need your kind help.

[Matthieu-LAURENT39]

Are the items on the roadmaps features you plan to implement yourself, or are they open for PRs?

In any case, this is really exciting! I can't wait to be able to use a Pydantic v2 + SQLModel (with all the great SQLAlchemy 2 features) + FastAPI stack!

[gmos]

Fully agree. Have other stuff already upgraded to pydantic 2.x.x and SqlAlchemy 2.x.x and cannot introduce SQLModel to the mix. From: Matthieu LAURENT ***@***.***> Sent: Tuesday, 24 October 2023 15:21 To: tiangolo/sqlmodel ***@***.***> Cc: Subscribed ***@***.***> Subject: Re: [tiangolo/sqlmodel] 🚀 Roadmap (Issue #654) Are the items on the roadmaps features you plan to implement yourself, or are they open for PRs? In any case, this is really exciting! I can't wait to be able to use a Pydantic v2 + SQLModel (with all the great SQLAlchemy 2 features) + FastAPI stack! — Reply to this email directly, view it on GitHub<#654 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AALUWECMEPO3K523RRZFZ3DYA66DLAVCNFSM6AAAAAA5TK2VBOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONZXGE4TEOJRGE>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.******@***.***>>