litestar-org / litestar

Production-ready, Light, Flexible and Extensible ASGI API framework | Effortlessly Build Performant APIs
https://litestar.dev/
MIT License
5.52k stars 378 forks source link

Docs: Add a small guide on database migrations #2748

Open AgarwalPragy opened 11 months ago

AgarwalPragy commented 11 months ago

Summary

Litestar is a database-agnostic micro-framework.

Still, both beginner and seasoned devs would first look at the official Litestar docs to see if there is a recommended way of setting up the database. This expectation becomes more relevant since Litestar does provide plugins to work with SQLAlchemy.

While the current docs include the database setup, it doesn't include migrations.

A small guide on how to setup alembic migrations while using the various SQLAlchemy plugins that Litestar provides will be awesome!


[!NOTE]
While we are open for sponsoring on GitHub Sponsors and OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh Litestar dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.

Fund with Polar

Yacobolo commented 2 months ago

This would be much appreciated. Just read through the docs and was missing this 🔥