Post

alembic setting

1
2
3
4
pip install alembic

# root ๋””๋ ‰ํ† ๋ฆฌ์— ํ•˜๋Š” ๊ฒƒ์„ ๊ถŒ์žฅ
alembic init alembic

alembic.ini ์„ค์ •

1
2
3
4
5
6
7
8
...
...
[alembic]
# init์œผ๋กœ ๋งŒ๋“  ํด๋” ์œ„์น˜
script_location = alembic

# env.py์—์„œ ์„ค์ •ํ•ด์•ผ python ํ™œ์šฉํ•ด์„œ ํ™˜๊ฒฝ๋ณ€์ˆ˜ import ๊ฐ€๋Šฅ
sqlalchemy.url = ..

alembic/env.py ์„ค์ •

  • ์ตœ์ƒ๋‹จ์— sys.path ๋“ฑ๋ก
1
2
3
4
5
import os, sys

sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
parent_dir = os.path.abspath(os.path.join(os.getcwd(), "..", ".."))
sys.path.append(parent_dir)
  • autogernate ์„ค์ • ๋ฐ sqlalchemy ์—ฐ๊ฒฐ
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
from alembic import context
from db.base import Base
from db import models

def get_url():
    from app.config import (
        DATABASE_HOST,
        DATABASE_NAME,
        DATABASE_PASSWORD,
        DATABASE_PORT,
        DATABASE_USER,
    )

    return f"mysql://{DATABASE_USER}:{DATABASE_PASSWORD}@{DATABASE_HOST}:{DATABASE_PORT}/{DATABASE_NAME}?charset=utf8"

config = context.config
# Interpret the config file for Python logging.
# This line sets up loggers basically.
fileConfig(config.config_file_name)

# autogernate ์ ์šฉ ์œ„ํ•œ ์„ธํŒ…
target_metadata = Base.metadata
  • migrations ํ•จ์ˆ˜ ์ˆ˜์ •
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def run_migrations_offline() -> None:
		...
		...
		...

def run_migrations_online():
    """Run migrations in 'online' mode.

    In this scenario we need to create an Engine
    and associate a connection with the context.

    """
    configuration = config.get_section(config.config_ini_section)
    configuration["sqlalchemy.url"] = get_url()
		# create_engine ๋Œ€์‹ ์— ๊ธฐ์กด engin์„ ์จ๋„ ๋˜์ง€ ์•Š์„๋ผ๋‚˜
    connectable = create_engine(
        get_url(),
        poolclass=pool.NullPool,
    )

    with connectable.connect() as connection:
        context.configure(
            connection=connection, target_metadata=target_metadata, compare_type=True
        )

        with context.begin_transaction():
            context.run_migrations()
  • Full Code
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
import os, sys

sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
parent_dir = os.path.abspath(os.path.join(os.getcwd(), "..", ".."))
sys.path.append(parent_dir)
from logging.config import fileConfig
from sqlalchemy import create_engine
from sqlalchemy import pool
from alembic import context
from db.base import Base
from db import models

def get_url():
    from app.config import (
        DATABASE_HOST,
        DATABASE_NAME,
        DATABASE_PASSWORD,
        DATABASE_PORT,
        DATABASE_USER,
    )

    return f"mysql://{DATABASE_USER}:{DATABASE_PASSWORD}@{DATABASE_HOST}:{DATABASE_PORT}/{DATABASE_NAME}?charset=utf8"

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config
# Interpret the config file for Python logging.
# This line sets up loggers basically.
fileConfig(config.config_file_name)

# autogernate ์ ์šฉ ์œ„ํ•œ ์„ธํŒ…
target_metadata = Base.metadata

# other values from the config, defined by the needs of env.py,
# can be acquired:
# my_important_option = config.get_main_option("my_important_option")
# ... etc.

def run_migrations_offline() -> None:
    """Run migrations in 'offline' mode.

    This configures the context with just a URL
    and not an Engine, though an Engine is acceptable
    here as well.  By skipping the Engine creation
    we don't even need a DBAPI to be available.

    Calls to context.execute() here emit the given string to the
    script output.

    """
    url = get_url()
    context.configure(
        url=url,
        target_metadata=target_metadata,
        literal_binds=True,
        dialect_opts={"paramstyle": "named"},
    )

    with context.begin_transaction():
        context.run_migrations()

def run_migrations_online():
    """Run migrations in 'online' mode.

    In this scenario we need to create an Engine
    and associate a connection with the context.

    """
    configuration = config.get_section(config.config_ini_section)
    configuration["sqlalchemy.url"] = get_url()
    connectable = create_engine(
        get_url(),
        poolclass=pool.NullPool,
    )

    with connectable.connect() as connection:
        context.configure(
            connection=connection, target_metadata=target_metadata, compare_type=True
        )

        with context.begin_transaction():
            context.run_migrations()

if context.is_offline_mode():
    run_migrations_offline()
else:
    run_migrations_online()
This post is licensed under CC BY 4.0 by the author.

ยฉ . Some rights reserved.

Using the Chirpy theme for Jekyll.