Alembic. 동적으로 DB 접속 정보 만들기

일반적으로 DB 접속 정보는 코드 형상 관리 도구에 포함되지 않아야하지만, Alembic에서 일반적으로 DB 접속 정보를 저장하게 되는 alembic.ini 파일을 DB 접속 정보 때문에 코드 형상 관리 도구에 포함하지 않고 개발자들이 공유하는 방식으로 이용하면 배보다 배꼽이 큰 상황이 될 수 있다. 또한, 개발 환경 별로 DB가 나누어져 있을 경우 Section을 나누어 서로 다른 DB 접속 정보를 넣어줄 수도 있어야 한다.

alembic.ini를 이용해 일반적인 Configuration들은 공유하되 DB 접속 정보과 같이 코드 형상 관리 도구에 포함되지 않아야 하는 정보들을 섹션 별로 관리할 수 있는 방법들은 다음과 같다.

env.py에서 alembic.ini로 인자 넘기기

1. alembic.ini에 가려랴 할 정보를 Interpolation string(%(some_value)s)으로 작성

// In alembic.ini,
[some-section]
...
sqlalchemy.url = postgresql://%(DB_USER)s:%(DB_PW)s@%(DB_HOST)s:%(DB_PORT)s/%(DB_NAME)s
...

2. env.py에 Interpolation string에 들어가야 할 정보를 넘겨주기

# In env.py,
from alembic import context


config = context.config
section = config.config_ini_section
config.set_section_option(section, "DB_USER", os.environ.get("SOME_SECTION_DB_USER"))
config.set_section_option(section, "DB_PW", os.environ.get("SOME_SECTION_DB_PW"))
...

env.py에서 Configuration 만들기

# In env.py,
from alembic import context


config = context.config
section = config.config_ini_section
config.set_section_option(section, "sqlalchemy.url", os.environ.get("SOME_SECTION_DB_URL"))

잘못된 내용, 오타, 부정확한 문장 등 어떤 피드백이든 환영합니다. 감사합니다.

---

Refrences

- https://stackoverflow.com/questions/22178339/is-it-possible-to-store-the-alembic-connect-string-outside-of-alembic-ini/55190497#55190497