Repository navigation
🚀 Roadmap #654
Description
Activity
- pinned this issue
on Oct 4, 2023 This is great news! So excited to start using these new features. I'm curious how you are planning in integrating Alembic?
Reacted by andylinzie, Chase Sterling, Arthur Harduim, Broden Wanner, bird-9, Stefnir, PelicanQ, Tony Wang, Akira Yu, Uday and 20 moreIs 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.
Reacted by Honglei, andylinzie and Max@AntonDeMeester @tiangolo Only support SQLAlchemy v1.4 with 2.0-style and v2.0?
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?
Reacted by andylinzie, Stefnir, Stephan Schielke, mmx86, Akira Yu, John Pocock, Hector Fabio Jimenez Saldarriaga, danyd555, Stev Leibelt and Uno Yakshi@hyperknot Try #632
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.
Reacted by Rodrigo Stange Tessinari, Noel, JyotirmayS, Tkeby and rubbie kelvinReacted by Benedikt Radtke, Andres Bermeo and TkebyYou 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.
Reacted by Robin, Honglei, andylinzie, A N, Thijs van Nierop, Ankit Arya, benedikt-bartscher, Jose Eduardo Laruta Espejo, Arthur Harduim, Sean and 4 moreWe 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.
Reacted by sherichev, andylinzie and Matthias PlatzerAre 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!
- 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: ***@***.******@***.***>>Reacted by Dima Tisnek and Hector Fabio Jimenez Saldarriaga
Take a look at this.
Reacted by Alan FregtmanSince the dev dependency, FastAPI, no longer supports Python 3.7 from version 0.104.0 onwards, will SQLModel also need to drop support for Python 3.7 in the future? If so, it would likely be a massive undertaking. It should be included in the roadmap together.
Reacted by andylinzie and 张千军When dealing with relational models,sqlalchemy only needs to define relationships on one side,sqlmodel needs to define relationships on both sides, and the complexity of the model class is very difficult to deal with. The screen full of relationships makes my brain a little hot, especially the many-to-many relationships, even if the model class is written according to the documentation, it becomes extremely complex.
Reacted by Stuart AxonI am looking forward for SQLAlchemy v2 support. This should enable ClickHouse columnar storage.
Reacted by andylinzie, Valentin, Sean, Marco, Ronald Das, nikdavis, Acent0r and Simon FridReacted by Dima Tisnek, Matthieu LAURENT and Nate Martinez19 remaining items
@tepelbaum I know it's two months later, but I wound up having to work on a minimal implementation of sqlmodel and alembic, so I published it to github. I'd actually be interested to keep maintaining this example or something like it, if it's helpful.
Reacted by Thomas Epelbaum, JD Solanki and Mike KarolowReacted by Paul Brussee, JD Solanki and andylinziemigration is seems already finished in official template repo full-stack-fastapi-template
and here is the READMEReacted by Atticus Zeller, John Pocock, Kyle Smith and Anibal Sólonhere's an example repo with albemic + sqlmodel setup https://github.com/iloveitaly/python-starter-template
Any plans of adding support for GeoAlchemy 2.(Using SQLAlchemy with Spatial Databases).its becoming hard to satrt new projects without using SQLModel again.
Reacted by Jesse and Kyle Krcmaric@tiangolo How can we support you in term of
- community
- development
- release management
- financial
to have a new sqlmodel release ?
SqlModel is a great project an the model unification from the db to the api is a real game-changer, and a robustness improvement for all classical SaaS with the API-first logic. but some issues (alias management, pydantic v2 full support, ...) are painful in a daily usage.
Reacted by Atle Krogstad Berg, Kevin A. Mitchell, Paxon Fischer, Matt Giles, Felix, sunkunxi, JD Solanki, Jack Collins, Dude29, James Wu and 5 more@tiangolo How can we support you in term of
- community
- development
- release management
- financial
to have a new sqlmodel release ?
SqlModel is a great project an the model unification from the db to the api is a real game-changer, and a robustness improvement for all classical SaaS with the API-first logic. but some issues (alias management, pydantic v2 full support, ...) are painful in a daily usage.
I completely agree. SQLModel is a fantastic tool provides great developing experience.
However, I've noticed that the pace of updates and the review process for Pull Requests have been a bit slow recently. There are many valuable community contributions waiting to be merged.(such as #1226 ).
I know maintaining an open-source project takes a lot of work, but I really hope this tool keeps growing and doing well. I’d be super excited to help out with SQLModel’s development any way I can (from SqlModel community).
Reacted by Dude29, AliceYuuuuuu, Matt Giles, James Wu, elonzh, lwrabetz, Erik Fubel, Christian Staudt and Ekoé JeanI am a bit hesitant about using the library. Although I know it's just a thin wrapper around Pydantic and SQLAlchemy (which I believe is significant), many of the opinions I've read express mixed feelings about the library's stability and future. I truly hope that this library not only survives but also thrives.
Reacted by Dude29, Uno Yakshi, andylinzie, Matt Giles, Elisiário Couto, jchen-ssgllc, Luca Faggianelli, Enrique Botía, James Wu, Lirone S. and 10 moreIt's the best ORM option out there. Would love to see active development on this: please let us know how we can help!
I've started pulling all of the additional stuff I've needed to make SQLModel fully functional to me into this repo: https://github.com/iloveitaly/activemodel
Reacted by andylinzie, Matt Giles, Luca Faggianelli, Enrique Botía, Tim and Victor Motadoes anyone have ETA on the migrations feature
Reacted by Lucas Schneider, Bear_03, Goldy, elonzh, TuringSolutions, Omar Mokhtar, Jason D'Amour, Fabian Nonnenmacher, Ygor Lemos, Leonardo Freitas and 2 more@vmskonakanchi looks like there is a pull request/689 pending already. Maybe you can fix the existing merge conflicts?
Reacted by Vamsi KonakanchiThanks for the suggestion, @stevleibelt! I took a pass at reviving #689 against the current
main.What I completed:
- Resolved the merge conflicts.
- Preserved the current uv/PDM tooling and CI.
- Updated the deprecated entry-point loading.
- Verified the migration CLI tests, lint checks, and
sqlmodel migrations --help.
I initially opened #2061, but it was automatically closed because the implementation modifies
pyproject.tomlanduv.lock, which require maintainer approval.To get guidance on the preferred packaging direction, I opened Discussion #2062. It asks whether this should use core dependencies, an optional extra, or a docs/template-only approach.
I’m happy to adapt the implementation based on that guidance.
Reacted by Stev Leibelt, Aliaksei Urbanski and Leonardo Saurweindoes anyone have ETA on the migrations feature
I'd love migrations to be a first class feature as well! I have alembic configured on this example template and it's working great if you want to point AI at something to copy.
does anyone have ETA on the migrations feature
I'd love migrations to be a first class feature as well! I have alembic configured on this example template and it's working great if you want to point AI at something to copy.
We do have a PR against this feature, it's in discussion , take a look at it
Question: SQLModel is in pre release 0.0.# stage but its widely used. Is it possible that if a breaking change is to be introduced, then adopt the system of bumping the MINOR number.
I do want to auto accept point releases but breaking changes is something that i could guard against if we did adopt this. This is in relation to the 0.0.45 release.
As far as I understand semantic versioning that is the reason why this project is still below a major release @pete312 . Expect breaking changes until version 1.0.0 is created.
With this written, I am using fastapi and typer in many places since years and from this projects, breaking changes are always well communicated with an "do this and all is fine"-howto section included.Either wait for a major release or subscribe to the release notification here. I don't see there is another option without slowing down the development until version 1.0.0.
Kind regards,
Stev
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:
Fieldparameters from Pydantic1.9.0and above, make Pydantic1.9.0the minimum required version #440All this is intermixed with reviews for PRs, issues, and discussions.