Flask로 웹 개발 진행 시 SQLAlchemy(Flask-SQLAlchemy)를 사용해 ORM구조를 구성할 때 데이터를 저장할 DB의 구조를 직접 확인하며 진행하는 것은 상당히 귀찮고 어려운 일입니다.
Django에는 내장된 inspectdb라는 명령어를 통해 Django와 일치하는 DB Model구조를 만들어주지만 SQLAlchemy 자체에 내장된 automap은 우리가 상상하는 모델 구조를 바로 만들어주지는 않습니다.
따라서 다른 패키지를 고려해볼 필요가 있습니다.
flask-sqlacodegen
flask-sqlacodegen은 기존 DB를 Flask-SQLAlchemy에서 사용하는 Model 형식으로 변환해 보여주는 패키지입니다. 기존 sqlacodegen에서 포크해 Flask-SQLAlchemy에 맞게 기본 설정이 갖추어져있어 편리합니다.
(psycopg2 모듈 필요)
설치하기
설치는 pip로 간단하게 진행해 주세요.
글쓰는 시점 최신버전은 1.1.6.1입니다.
글쓴것과 같은 버전으로 설치하려면 flask-sqlacodegen==1.1.6.1 로 설치해 주세요.
# 최신 버전 설치하기 pip install flask-sqlacodegen # 글쓴 시점과 같게 설치하려면 # pip install flask-sqlacodegen==1.1.6.1
설치가 완료되면 명령줄에서 flask-sqlacodegen라는 명령어를 사용할 수 있습니다.
주의: sqlacodegen이 이미 깔려있다면 다른 가상환경(virtuale / venv)를 만드시고 진행해 주세요. sqlacodegen이 깔려있으면 --flask이 동작하지 않습니다.
DB 구조 뜯어내기
flask-sqlacodegen는 sqlacodegen과 거의 동일한 문법을 사용합니다.(포크를 뜬 프로젝트니까요!)
flask-sqlacodegen 명령어로 DB를 지정하면 구조를 알 수 있습니다.
SQLite의 경우
flask-sqlacodegen "sqlite:///db.sqlite3" --flask > models.py # 상대경로, 현재 위치의 db.sqlite3
SQLite는 로컬에 있는 DB의 위치를 지정하면 됩니다.
위 명령어를 실행하면 models.py파일 안에 db.sqlite3 DB의 모델이 정리됩니다.
SQLite의 경우
flask-sqlacodegen "postgresql://{id}:{pw}@127.0.0.1:5432/postgres" --flask > models.py