Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pallets-eco/flask-alembic
Integrate Alembic with Flask.
https://github.com/pallets-eco/flask-alembic
alembic database flask flask-sqlalchemy flask-sqlalchemy-lite migrations python sqlalchemy
Last synced: 1 day ago
JSON representation
Integrate Alembic with Flask.
- Host: GitHub
- URL: https://github.com/pallets-eco/flask-alembic
- Owner: pallets-eco
- License: mit
- Created: 2019-08-22T21:06:00.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T15:59:36.000Z (2 months ago)
- Last Synced: 2024-09-30T00:14:12.440Z (about 2 months ago)
- Topics: alembic, database, flask, flask-sqlalchemy, flask-sqlalchemy-lite, migrations, python, sqlalchemy
- Language: Python
- Homepage: https://flask-alembic.readthedocs.io
- Size: 377 KB
- Stars: 43
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Flask-Alembic
Flask-Alembic is a [Flask][] extension that provides a configurable [Alembic][]
database migration environment. Supports [Flask-SQLAlchemy],
[Flask-SQLAlchemy-Lite], or plain [SQLAlchemy]. Supports Alembic's single and
multiple database templates.
[Flask]: https://flask.palletsprojects.com
[Alembic]: https://alembic.sqlalchemy.org
[SQLAlchemy]: https://www.sqlalchemy.org
[Flask-SQLAlchemy]: https://flask-sqlalchemy.palletsprojects.com
[Flask-SQLAlchemy-Lite]: https://flask-sqlalchemy-lite.readthedocs.io
## Pallets Community Ecosystem
> [!IMPORTANT]\
> This project is part of the Pallets Community Ecosystem. Pallets is the open
> source organization that maintains Flask; Pallets-Eco enables community
> maintenance of Flask extensions. If you are interested in helping maintain
> this project, please reach out on [the Pallets Discord server][discord].
>
> [discord]: https://discord.gg/pallets
## Basic Usage
You've created a Flask application and some models with Flask-SQLAlchemy. Now
start using Flask-Alembic:
```python
from flask_alembic import Alembic
# Intialize the extension
alembic = Alembic()
alembic.init_app(app)
```
Commands are added to the `flask` CLI:
```text
$ flask db --help
$ flask db revision "making changes"
$ flask db upgrade
```
You can also access Alembic's functionality from Python:
```python
with app.app_context():
# Auto-generate a migration
alembic.revision('making changes')
# Upgrade the database
alembic.upgrade()
# Access the internals
environment_context = alembic.env
```
## Differences from Alembic
- Configuration is taken from `Flask.config` instead of `alembic.ini` and
`env.py`.
- Engines and model/table metadata are taken from Flask-SQLAlchemy(-Lite) if
available, or can be configured manually.
- The migrations are stored directly in the `migrations` folder instead of the
`versions` folder.
- Provides the migration environment instead of `env.py` and exposes Alembic's
internal API objects.
- Differentiates between CLI commands and Python functions. The functions return
revision objects and don't print to stdout.
- Allows operating Alembic at any API level while the app is running, through
the exposed objects and functions.
- Adds a system for managing independent migration branches and makes it easier
to work with named branches.
- Does not (currently) support offline migrations. I don't plan to work on this
but am open to patches.
- Does not (currently) support async engines. I don't plan to work on this but
am open to patches.