sqlalchemy / sqlalchemy/alembic

Cookbook recipe for automatic schema migrations for trivial changes

Open
#470 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature Tier 1
Dominant language
Python
Stars
4.4k
Forks
375
PR merge metrics
No merged PRs in 30d

Description

Migrated issue, originally created by Jake Hunsaker (@turboturtle)

This feature request is for a cookbook recipe to automatically run a migration against trivial schema changes (i.e. add/drop columns, at most add/drop a table) so that an end user never has to run an alembic command themselves.

Reference https://groups.google.com/forum/#!topic/sqlalchemy-alembic/6Wf6_FcemM4 - the main idea has been fleshed out and what would be needed seems to have been identified. At this point it would be primarily making sure the API can do this without changes it seems.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Google Groups discussion and the Alembic API context for running migrations without a command-line invocation. Produce a cookbook recipe covering trivial add/drop column changes and, at most, adding or dropping a table, with the documented result allowing end users to avoid running an Alembic command themselves.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, sqlalchemy
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.