No changes detected in Alembic autogeneration of migrations with Flask-SQLAlchemy
Alembic cannot automatically detect table or column renames. By default it will not look for column type changes either, but the compare_type
option can be enabled for this.
Excerpt from the Alembic documentation:
Autogenerate will by default detect:
- Table additions, removals.
- Column additions, removals.
- Change of nullable status on columns.
Autogenerate can optionally detect:
- Change of column type. This will occur if you set
compare_type=True
onEnvironmentContext.configure()
. The feature works well in most cases, but is off by default so that it can be tested on the target schema first. It can also be customized by passing a callable here; see the function’s documentation for details. - Change of server default. This will occur if you set
compare_server_default=True
onEnvironmentContext.configure()
. This feature works well for simple cases but cannot always produce accurate results. The Postgresql backend will actually invoke the “detected” and “metadata” values against the database to determine equivalence. The feature is off by default so that it can be tested on the target schema first. Like type comparison, it can also be customized by passing a callable; see the function’s documentation for details.
Autogenerate can not detect:
- Changes of table name. These will come out as an add/drop of two different tables, and should be hand-edited into a name change instead.
- Changes of column name. Like table name changes, these are detected as a column add/drop pair, which is not at all the same as a name change.
- Special SQLAlchemy types such as
Enum
when generated on a backend which doesn’t supportENUM
directly - this because the representation of such a type in the non-supporting database, i.e. aCHAR+CHECK
constraint, could be any kind ofCHAR+CHECK
. For SQLAlchemy to determine that this is actually anENUM
would only be a guess, something that’s generally a bad idea. To implement your own “guessing” function here, use thesqlalchemy.events.DDLEvents.column_reflect()
event to alter the SQLAlchemy type passed for certain columns and possiblysqlalchemy.events.DDLEvents.after_parent_attach()
to intercept unwantedCHECK
constraints.
Autogenerate can’t currently, but will eventually detect:
- Free-standing constraint additions, removals, like
CHECK
,UNIQUE
,FOREIGN KEY
- these aren’t yet implemented. Right now you’ll get constraints within new tables, PK and FK constraints for the “downgrade” to a previously existing table, and theCHECK
constraints generated with a SQLAlchemy “schema” typesBoolean
,Enum
. - Index additions, removals - not yet implemented.
- Sequence additions, removals - not yet implemented.
UPDATE: some of the items in this last list are supported in the Alembic 0.7.x releases.
My mistake was to try creating my initial migration with the db already in the final state, thinking it would notice it had no existing versions and base it on the models. I got empty versions until I deleted all tables in the db and then it worked fine.
I also faced this issue and using this way to solve that:
open the migrations/env.py
file, and on def run_migrations_online()
function look at the context.configure
, on Alembic 1.0.8
it should look like this:
with connectable.connect() as connection:
context.configure(
connection=connection,
target_metadata=target_metadata,
process_revision_directives=process_revision_directives,
**current_app.extensions['migrate'].configure_args,
)
Just remove or comment theprocess_revision_directives=process_revision_directives
and then add the compare_type=True
on that.
Like this:
with connectable.connect() as connection:
context.configure(
connection=connection,
target_metadata=target_metadata,
# process_revision_directives=process_revision_directives,
**current_app.extensions['migrate'].configure_args,
compare_type=True
)