[Django]Django의 Inspectdb을 이용해 외부 DB에 대해 ORM를 써보자!

Django를 하다보면 외부 DB의 정보를 가져와서 사용해야할 경우가 있는데 sql문으로 외부 DB를 가져오기에는 장고의 ORM기능이 너무 아까울때가 있다.

Django에서는 다행히도 외부 DB에 대해 inspectdb라는 기능을 제공하고 있다. inspectdb를 사용하면 실제 DB를 만들지는 않고 외부 DB를 가져와 model로 만들어주는 정말 편리한 기능이다.

기본적으로 inspectdb를 사용할려면 외부 DB에 대한 접속 정보가 있어야한다. 이는 settings.py의 DATABASE를 설정해주면 된다. 장고를 처음 생성하면 DATABASE가 default로 되어 있을 것이다. 여기에 원하는 이름의 외부 DB 접속 정보를 넣어주면 된다.

# settings.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': '',
        'USER': '',
        'PASSWORD': '',
        'HOST': '',
        'PORT': '3306'
    },
    'external': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': '',
        'USER': '',
        'PASSWORD': '',
        'HOST': '',
    }
}

여기서 external이라는 이름으로 추가를 했는데 이름은 마음대로 지어도 된다.

이제 inspectdb를 사용해보자. users라는 앱 안에 models.py에 저장하도록 해보자.

$ python manage.py inspectdb > 'users/models.py' --database 'external'

이렇게 하면 users 앱 안의 models.py에 외부 Table이 model 형태로 이쁘게 저장되어 있을 것이다.
이렇게 가져온 Table를 ORM으로 사용하기 위해서는 다음과 같이 하면 됩니다. MyUser라는 모델은 외부 DB에 있는 테이블 명으로 inspectdb 명령어로 통해 자동 생성된 모델이다.

# users/views.py
from users.models import MyUser
# using을 이용해 앞서 설정한 external 이름을 넣어주면 된다.
queryset = MyUser.objects.using('external').all()

inspectdb는 엄청 편리한 기능이긴 하지만 몇가지 주의해야할 점이 있다.

1. 기본적으로 관계형 테이블만 가능하다. 하지만 MySql의 ` bit 타입은 제대로 가지고 오지 못하는 등 여러 문제가 있긴 하다.
2. 외부 테이블의 Primary Key를 간혹 제대로 못 가져올 경우가 있다. 그럴 경우, 생성된 모델의 필드에 primary_key=True를 추가해줘야 한다.
3. 가지고 온 외부 테이블 구조를 변경하고 싶다면 Meta 클래스의 managed=False를 True로 바꿔주면 된다.