如何以编程方式为Django中的给定模型生成CREATE TABLE SQL语句?

时间:2018-02-07 14:32:21

标签: python sql django migration

我需要以编程方式为我的Django应用程序中的给定非托管模型生成CREATE TABLE语句(managed = False

由于我正在处理遗留数据库,因此我不想创建迁移并使用sqlmigrate

./manage.py sql命令对此有用,但已在Django 1.8

中删除

你知道其他选择吗?

2 个答案:

答案 0 :(得分:2)

不幸的是,似乎没有简单的方法可以做到这一点,但为了你的运气,我刚刚成功地为你挖掘了django迁徙丛林的内部。

只需:

  1. 将代码保存到get_sql_create_table.py(例如)
  2. 执行$ export DJANGO_SETTINGS_MODULE=yourproject.settings
  3. 使用python get_sql_create_table.py yourapp.yourmodel
  4. 启动脚本

    它应该输出你需要的东西。

    希望它有所帮助!

    import django
    django.setup()
    
    from django.db.migrations.state import ModelState
    from django.db.migrations import operations
    from django.db.migrations.migration import Migration
    from django.db import connections
    from django.db.migrations.state import ProjectState
    
    def get_create_sql_for_model(model):
    
        model_state = ModelState.from_model(model)
    
        # Create a fake migration with the CreateModel operation
        cm = operations.CreateModel(name=model_state.name, fields=model_state.fields)
        migration = Migration("fake_migration", "app")
        migration.operations.append(cm)
    
        # Let the migration framework think that the project is in an initial state
        state = ProjectState()
    
        # Get the SQL through the schema_editor bound to the connection
        connection = connections['default']
        with connection.schema_editor(collect_sql=True, atomic=migration.atomic) as schema_editor:
            state = migration.apply(state, schema_editor, collect_sql=True)
    
        # return the CREATE TABLE statement
        return "\n".join(schema_editor.collected_sql)
    
    if __name__ == "__main__":
    
        import importlib
        import sys
    
        if len(sys.argv) < 2:
            print("Usage: {} <app.model>".format(sys.argv[0]))
            sys.exit(100)
    
        app, model_name = sys.argv[1].split('.')
    
        models = importlib.import_module("{}.models".format(app))
        model = getattr(models, model_name)
        rv = get_create_sql_for_model(model)
        print(rv)
    

答案 1 :(得分:2)

如所建议的,我对此案发表了完整的答案,该问题可能暗示。

假设您有一个外部数据库表,您决定将其作为Django模型进行访问,因此将其描述为非托管模型(Meta: managed = False)。 稍后,您需要能够在代码中创建它,例如,使用本地数据库进行一些测试。显然,Django不会迁移非托管模型,因此不会在测试数据库中创建它。 可以使用Django API解决此问题,而无需使用原始SQL-SchemaEditor。请参阅下面的更完整的示例,但作为简短答案,您将使用以下示例:

   from django.db import connections

   with connections['db_to_create_a_table_in'].schema_editor() as schema_editor:
        schema_editor.create_model(YourUnmanagedModelClass)

一个实际例子:

# your_app/models/your_model.py

from django.db import models

class IntegrationView(models.Model):
    """A read-only model to access a view in some external DB."""

    Meta:
        managed = False
        db_table = 'integration_view'

    name = models.CharField(
        db_column='object_name',
        max_length=255,
        primaty_key=True,
        verbose_name='Object Name',
    )
    some_value = models.CharField(
        db_column='some_object_value',
        max_length=255,
        blank=True,
        null=True,
        verbose_name='Some Object Value',
    )

    # Depending on the situation it might be a good idea to redefine
    # some methods as a NOOP as a safety-net.
    # Note, that it's not completely safe this way, but might help with some
    # silly mistakes in user code

    def save(self, *args, **kwargs):
        """Preventing data modification."""
        pass

    def delete(self, *args, **kwargs):
        """Preventing data deletion."""
        pass

现在,假设您需要能够通过Django创建此模型,例如进行一些测试。

# your_app/tests/some_test.py

# This will allow to access the `SchemaEditor` for the DB
from django.db import connections
from django.test import TestCase
from your_app.models.your_model import IntegrationView

class SomeLogicTestCase(TestCase):
    """Tests some logic, that uses `IntegrationView`."""

    # Since it is assumed, that the `IntegrationView` is read-only for the
    # the case being described it's a good idea to put setup logic in class 
    # setup fixture, that will run only once for the whole test case
    @classmethod
    def setUpClass(cls):
        """Prepares `IntegrationView` mock data for the test case."""

        # This is the actual part, that will create the table in the DB
        # for the unmanaged model (Any model in fact, but managed models will
        # have their tables created already by the Django testing framework)
        # Note: Here we're able to choose which DB, defined in your settings,
        # will be used to create the table

        with connections['external_db'].schema_editor() as schema_editor:
            schema_editor.create_model(IntegrationView)

        # That's all you need, after the execution of this statements
        # a DB table for `IntegrationView` will be created in the DB
        # defined as `external_db`.

        # Now suppose we need to add some mock data...
        # Again, if we consider the table to be read-only, the data can be 
        # defined here, otherwise it's better to do it in `setUp()` method.

        # Remember `IntegrationView.save()` is overridden as a NOOP, so simple
        # calls to `IntegrationView.save()` or `IntegrationView.objects.create()`
        # won't do anything, so we need to "Improvise. Adapt. Overcome."

        # One way is to use the `save()` method of the base class,
        # but provide the instance of our class
        integration_view = IntegrationView(
            name='Biggus Dickus',
            some_value='Something really important.',
        )
        super(IntegrationView, integration_view).save(using='external_db')

        # Another one is to use the `bulk_create()`, which doesn't use
        # `save()` internally, and in fact is a better solution
        # if we're creating many records

        IntegrationView.objects.using('external_db').bulk_create([
            IntegrationView(
                name='Sillius Soddus',
                some_value='Something important',
            ),
            IntegrationView(
                name='Naughtius Maximus',
                some_value='Whatever',
            ),
        ])

    # Don't forget to clean after
    @classmethod
    def tearDownClass(cls):
        with connections['external_db'].schema_editor() as schema_editor:
            schema_editor.delete_model(IntegrationView)

    def test_some_logic_using_data_from_integration_view(self):
         self.assertTrue(IntegrationView.objects.using('external_db').filter(
             name='Biggus Dickus',
         ))

为了使示例更完整...由于我们使用的是多个数据库(defaultexternal_db),Django将尝试在两个数据库上运行迁移以进行测试,到目前为止,数据库设置中没有选项可以防止这种情况。因此,我们必须使用自定义的DB路由器进行测试。

 # your_app/tests/base.py

class PreventMigrationsDBRouter:
    """DB router to prevent migrations for specific DBs during tests."""
    _NO_MIGRATION_DBS = {'external_db', }

    def allow_migrate(self, db, app_label, model_name=None, **hints):
        """Actually disallows migrations for specific DBs."""
        return db not in self._NO_MIGRATION_DBS

以及上述情况的测试设置文件示例:

# settings/test.py

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.oracle',
        'NAME': 'db_name',
        'USER': 'username',
        'HOST': 'localhost',
        'PASSWORD': 'password',
        'PORT': '1521',
    },
    # For production here we would have settings to connect to the external DB,
    # but for testing purposes we could get by with an SQLite DB 
    'external_db': {
        'ENGINE': 'django.db.backends.sqlite3',
    },
}

# Not necessary to use a router in production config, since if the DB 
# is unspecified explicitly for some action Django will use the `default` DB
DATABASE_ROUTERS = ['your_app.tests.base.PreventMigrationsDBRouter', ]

希望这个详细的新Django用户友好示例可以帮助某人并节省他们的时间。