Jak wykonać wstawki i aktualizacje w skrypcie aktualizacji Alembic?


99

Muszę zmienić dane podczas aktualizacji Alembic.

Obecnie mam tabelę graczy w pierwszej wersji:

def upgrade():
    op.create_table('player',
        sa.Column('id', sa.Integer(), nullable=False),
        sa.Column('name', sa.Unicode(length=200), nullable=False),
        sa.Column('position', sa.Unicode(length=200), nullable=True),
        sa.Column('team', sa.Unicode(length=100), nullable=True)
        sa.PrimaryKeyConstraint('id')
    )

Chcę wprowadzić tabelę „drużyn”. Stworzyłem drugą wersję:

def upgrade():
    op.create_table('teams',
        sa.Column('id', sa.Integer(), nullable=False),
        sa.Column('name', sa.String(length=80), nullable=False)
    )
    op.add_column('players', sa.Column('team_id', sa.Integer(), nullable=False))

Chciałbym, aby druga migracja również dodała następujące dane:

  1. Wypełnij tabelę zespołów:

    INSERT INTO teams (name) SELECT DISTINCT team FROM players;
    
  2. Zaktualizuj Players.team_id na podstawie nazwy Players.team:

    UPDATE players AS p JOIN teams AS t SET p.team_id = t.id WHERE p.team = t.name;
    

Jak wykonać wstawki i aktualizacje w skrypcie aktualizacji?

Odpowiedzi:


155

To, o co prosisz, to migracja danych , w przeciwieństwie do migracji schematu, która jest najbardziej rozpowszechniona w dokumentach Alembic.

Ta odpowiedź zakłada, że ​​do definiowania modeli używasz deklaratywnego (w przeciwieństwie do klas-mapowania-tabeli lub rdzenia). Dostosowanie tego do innych form powinno być stosunkowo proste.

Zauważ, że Alembic zapewnia kilka podstawowych funkcji danych: op.bulk_insert()i op.execute(). Jeśli operacje są dość minimalne, użyj ich. Jeśli migracja wymaga relacji lub innych złożonych interakcji, wolę korzystać z pełnej mocy modeli i sesji opisanych poniżej.

Poniżej znajduje się przykład skryptu migracji, który konfiguruje niektóre deklaratywne modele, które będą używane do manipulowania danymi w sesji. Kluczowe punkty to:

  1. Zdefiniuj podstawowe modele, których potrzebujesz, wraz z potrzebnymi kolumnami. Nie potrzebujesz każdej kolumny, tylko klucz podstawowy i te, których będziesz używać.

  2. W ramach funkcji aktualizacji użyj, op.get_bind()aby uzyskać bieżące połączenie i zrób z nim sesję.

    • Lub użyj bind.execute()niższego poziomu SQLAlchemy do bezpośredniego pisania zapytań SQL. Jest to przydatne w przypadku prostych migracji.
  3. Korzystaj z modeli i sesji w normalny sposób w swojej aplikacji.

"""create teams table

Revision ID: 169ad57156f0
Revises: 29b4c2bfce6d
Create Date: 2014-06-25 09:00:06.784170
"""

revision = '169ad57156f0'
down_revision = '29b4c2bfce6d'

from alembic import op
import sqlalchemy as sa
from sqlalchemy import orm
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()


class Player(Base):
    __tablename__ = 'players'

    id = sa.Column(sa.Integer, primary_key=True)
    name = sa.Column(sa.String, nullable=False)
    team_name = sa.Column('team', sa.String, nullable=False)
    team_id = sa.Column(sa.Integer, sa.ForeignKey('teams.id'), nullable=False)

    team = orm.relationship('Team', backref='players')


class Team(Base):
    __tablename__ = 'teams'

    id = sa.Column(sa.Integer, primary_key=True)
    name = sa.Column(sa.String, nullable=False, unique=True)


def upgrade():
    bind = op.get_bind()
    session = orm.Session(bind=bind)

    # create the teams table and the players.team_id column
    Team.__table__.create(bind)
    op.add_column('players', sa.Column('team_id', sa.ForeignKey('teams.id'), nullable=False)

    # create teams for each team name
    teams = {name: Team(name=name) for name in session.query(Player.team).distinct()}
    session.add_all(teams.values())

    # set player team based on team name
    for player in session.query(Player):
        player.team = teams[player.team_name]

    session.commit()

    # don't need team name now that team relationship is set
    op.drop_column('players', 'team')


def downgrade():
    bind = op.get_bind()
    session = orm.Session(bind=bind)

    # re-add the players.team column
    op.add_column('players', sa.Column('team', sa.String, nullable=False)

    # set players.team based on team relationship
    for player in session.query(Player):
        player.team_name = player.team.name

    session.commit()

    op.drop_column('players', 'team_id')
    op.drop_table('teams')

Migracja definiuje oddzielne modele, ponieważ modele w kodzie reprezentują bieżący stan bazy danych, podczas gdy migracje reprezentują kroki po drodze . Twoja baza danych może znajdować się w dowolnym stanie wzdłuż tej ścieżki, więc modele mogą jeszcze nie zostać zsynchronizowane z bazą danych. O ile nie jesteś bardzo ostrożny, używanie rzeczywistych modeli bezpośrednio spowoduje problemy z brakującymi kolumnami, nieprawidłowymi danymi itp. Bardziej przejrzyste jest wyraźne określenie, jakich kolumn i modeli będziesz używać podczas migracji.


12

Możesz również użyć bezpośredniego SQL, patrz ( Alembic Operation Reference ), jak w poniższym przykładzie:

from alembic import op

# revision identifiers, used by Alembic.
revision = '1ce7873ac4ced2'
down_revision = '1cea0ac4ced2'
branch_labels = None
depends_on = None


def upgrade():
    # ### commands made by andrew ###
    op.execute('UPDATE STOCK SET IN_STOCK = -1 WHERE IN_STOCK IS NULL')
    # ### end Alembic commands ###


def downgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    pass
    # ### end Alembic commands ###

W przypadku, zawsze chciałem przeczytać instrukcję SQL z pliku zewnętrznego, a następnie przekazać go op.executew upgrade(), czy istnieje sposób, aby zapewnić domyślny szablon, który będzie używany przez alembic revisionpolecenie (domyślnym ciała dla wygenerowanego .pypliku)?
Quentin

1
Nie znam @Quentin. To ciekawy pomysł.
Martlark

6

Zalecam używanie podstawowych instrukcji SQLAlchemy przy użyciu tabeli ad-hoc, zgodnie z opisem w oficjalnej dokumentacji , ponieważ umożliwia ona korzystanie z agnostycznego języka SQL i pisma w języku Python, a także jest niezależna. SQLAlchemy Core jest najlepszym z obu światów dla skryptów migracji.

Oto przykład koncepcji:

from sqlalchemy.sql import table, column
from sqlalchemy import String
from alembic import op

account = table('account',
    column('name', String)
)
op.execute(
    account.update().\\
    where(account.c.name==op.inline_literal('account 1')).\\
        values({'name':op.inline_literal('account 2')})
        )

# If insert is required
from sqlalchemy.sql import insert
from sqlalchemy import orm

session = orm.Session(bind=bind)
bind = op.get_bind()

data = {
    "name": "John",
}
ret = session.execute(insert(account).values(data))
# for use in other insert calls
account_id = ret.lastrowid
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.