How to integrate Django with a legacy database

Django は新しいアプリケーションを開発するのに最適ですが、レガシーなデータベースと統合することも可能です。Django には、それを自動化するいくつかのユーティリティが含まれています。

このドキュメントは チュートリアル に書かれているような、Django についての基本的な知識を持っていることを想定しています。

Django のセットアップが完了したら、次の一般的なプロセスに従うことで、既存のデータベースと統合することができます。

Django に既存データベースのパラメータを与える

まず、Django に既存のデータベース接続のパラメータとデータベースの名前を教えてあげる必要があります。そのために、設定ファイルの DATABASES を編集して、'default' 接続の以下のキーに対して値を設定します。

モデルを自動生成する

Django comes with a utility called inspectdb that can create models by introspecting an existing database. You can view the output by running this command:

$ python manage.py inspectdb

Save this as a file by using standard Unix output redirection:

$ python manage.py inspectdb > models.py

This feature is meant as a shortcut, not as definitive model generation. See the documentation of inspectdb for more information.

Once you've cleaned up your models, name the file models.py and put it in the Python package that holds your app. Then add the app to your INSTALLED_APPS setting.

By default, inspectdb creates unmanaged models. That is, managed = False in the model's Meta class tells Django not to manage each table's creation, modification, and deletion:

class Person(models.Model):
    id = models.IntegerField(primary_key=True)
    first_name = models.CharField(max_length=70)
    class Meta:
       managed = False
       db_table = 'CENSUS_PERSONS'

If you do want to allow Django to manage the table's lifecycle, you'll need to change the managed option above to True (or remove it because True is its default value).

Install the core Django tables

Next, run the migrate command to install any extra needed database records such as admin permissions and content types:

$ python manage.py migrate

テストと修正

Those are the basic steps -- from here you'll want to tweak the models Django generated until they work the way you'd like. Try accessing your data via the Django database API, and try editing objects via Django's admin site, and edit the models file accordingly.