autogenerate and sync migrations with models #8239
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@wardi, everything works like a charm with a core and can be merged, but autogeneration for plugins doesn't work right now. The only problem is missing metadata in the alembic template. With metadata, plugins can use autogeneration as well. But I think you should use an addition to plugin migrations. Just like you did for core migrations with There is always a chance that somebody will use different table-naming convention. But we'll document the fact that metadata must be updated in existing migration scripts and can also mention this filter and its implications. And for plugins we can use Here's the patch with my suggestion: diff --git a/ckanext/activity/migration/activity/env.py b/ckanext/activity/migration/activity/env.py
index 4709aa4b1..ff9af0414 100644
--- a/ckanext/activity/migration/activity/env.py
+++ b/ckanext/activity/migration/activity/env.py
@@ -4,6 +4,7 @@ from __future__ import with_statement
from alembic import context
from sqlalchemy import engine_from_config, pool
from logging.config import fileConfig
+from ckan.model.meta import metadata
import os
@@ -20,7 +21,7 @@ fileConfig(config.config_file_name)
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
-target_metadata = None
+target_metadata = metadata
# other values from the config, defined by the needs of env.py,
# can be acquired:
@@ -30,6 +31,12 @@ target_metadata = None
name = os.path.basename(os.path.dirname(__file__))
+def include_object(object, object_name, type_, reflected, compare_to):
+ if type_ == "table":
+ return object_name.startswith(name)
+ return True
+
+
def run_migrations_offline():
"""Run migrations in 'offline' mode.
@@ -46,7 +53,8 @@ def run_migrations_offline():
url = config.get_main_option(u"sqlalchemy.url")
context.configure(
url=url, target_metadata=target_metadata, literal_binds=True,
- version_table=u'{}_alembic_version'.format(name)
+ version_table=u'{}_alembic_version'.format(name),
+ include_object=include_object,
)
with context.begin_transaction():
@@ -69,7 +77,8 @@ def run_migrations_online():
context.configure(
connection=connection,
target_metadata=target_metadata,
- version_table=u'{}_alembic_version'.format(name)
+ version_table=u'{}_alembic_version'.format(name),
+ include_object=include_object,
)
with context.begin_transaction():
diff --git a/contrib/alembic/generic/env.py b/contrib/alembic/generic/env.py
index 009368218..bb2fcd412 100644
--- a/contrib/alembic/generic/env.py
+++ b/contrib/alembic/generic/env.py
@@ -4,6 +4,7 @@ from __future__ import with_statement
from alembic import context
from sqlalchemy import engine_from_config, pool
from logging.config import fileConfig
+from ckan.model.meta import metadata
import os
@@ -19,7 +20,7 @@ fileConfig(config.config_file_name)
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
-target_metadata = None
+target_metadata = metadata
# other values from the config, defined by the needs of env.py,
# can be acquired:
@@ -29,6 +30,12 @@ target_metadata = None
name = os.path.basename(os.path.dirname(__file__))
+def include_object(object, object_name, type_, reflected, compare_to):
+ if type_ == "table":
+ return object_name.startswith(name)
+ return True
+
+
def run_migrations_offline():
"""Run migrations in 'offline' mode.
@@ -45,7 +52,8 @@ def run_migrations_offline():
url = config.get_main_option(u"sqlalchemy.url")
context.configure(
url=url, target_metadata=target_metadata, literal_binds=True,
- version_table=u'{}_alembic_version'.format(name)
+ version_table=u'{}_alembic_version'.format(name),
+ include_object=include_object,
)
with context.begin_transaction():
@@ -68,7 +76,8 @@ def run_migrations_online():
context.configure(
connection=connection,
target_metadata=target_metadata,
- version_table=u'{}_alembic_version'.format(name)
+ version_table=u'{}_alembic_version'.format(name),
+ include_object=include_object,
)
with context.begin_transaction(): |
|
@amercader WDYT about including this change in 2.11? |
|
sure, this is definitely useful |
|
/backport please |
|
Successfully created backport PR for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #8238
Proposed fixes:
ckan generate migration --autogeneratealembic featureFeatures: