在Alembic迁移期间更新列内容

时间:2017-04-01 05:53:42

标签: python-3.x alembic sqlalchemy-migrate

假设我的db模型包含一个对象User

Base = declarative_base() 

class User(Base):                                                               
    __tablename__ = 'users'                                                     

    id = Column(String(32), primary_key=True, default=...) 
    name = Column(Unicode(100))                                             

我的数据库包含一个带有 n 行的users表。在某些时候,我决定将name拆分为firstnamelastname,在alembic upgrade head期间,我希望我的数据也可以迁移。

自动生成的Alembic迁移如下:

def upgrade():
    op.add_column('users', sa.Column('lastname', sa.Unicode(length=50), nullable=True))
    op.add_column('users', sa.Column('firstname', sa.Unicode(length=50), nullable=True))

    # Assuming that the two new columns have been committed and exist at
    # this point, I would like to iterate over all rows of the name column,
    # split the string, write it into the new firstname and lastname rows,
    # and once that has completed, continue to delete the name column.

    op.drop_column('users', 'name')                                             

def downgrade():
    op.add_column('users', sa.Column('name', sa.Unicode(length=100), nullable=True))

    # Do the reverse of the above.

    op.drop_column('users', 'firstname')                                        
    op.drop_column('users', 'lastname')

这个问题似乎存在多种或多或少的hacky解决方案。 This onethis one都建议在迁移期间使用execute()bulk_insert()执行原始SQL语句。 This (incomplete) solution导入当前的数据库模型,但该模型更改时该方法很脆弱。

如何在Alembic迁移期间迁移和修改列数据的现有内容?建议的方式是什么,它在哪里记录?

2 个答案:

答案 0 :(得分:8)

norbertpy’s answer中提出的解决方案起初听起来不错,但我认为它有一个基本缺陷:它会在步骤之间引入多个事务,数据库将处于一个时髦,不一致的状态。对我来说,看起来很奇怪(参见my comment)工具将在没有DB数据的情况下迁移DB模式;两者紧密地捆绑在一起将它们分开。

经过一些讨论和几次对话(参见this Gist中的代码段),我决定采用以下解决方案:

def upgrade():

    # Schema migration: add all the new columns.
    op.add_column('users', sa.Column('lastname', sa.Unicode(length=50), nullable=True))
    op.add_column('users', sa.Column('firstname', sa.Unicode(length=50), nullable=True))

    # Data migration: takes a few steps...
    # Declare ORM table views. Note that the view contains old and new columns!        
    t_users = sa.Table(
        'users',
        sa.MetaData(),
        sa.Column('id', sa.String(32)),
        sa.Column('name', sa.Unicode(length=100)), # Old column.
        sa.Column('lastname', sa.Unicode(length=50)), # Two new columns.
        sa.Column('firstname', sa.Unicode(length=50)),
        )
    # Use Alchemy's connection and transaction to noodle over the data.
    connection = op.get_bind()
    # Select all existing names that need migrating.
    results = connection.execute(sa.select([
        t_users.c.id,
        t_users.c.name,
        ])).fetchall()
    # Iterate over all selected data tuples.
    for id_, name in results:
        # Split the existing name into first and last.
        firstname, lastname = name.rsplit(' ', 1)
        # Update the new columns.
        connection.execute(t_users.update().where(t_users.c.id == id_).values(
            lastname=lastname,
            firstname=firstname,
            ))

    # Schema migration: drop the old column.
    op.drop_column('users', 'name')                                             

关于此解决方案的两条评论:

  1. 如引用的Gist所述,较新版本的Alembic符号略有不同。
  2. 根据数据库驱动程序的不同,代码的行为可能会有所不同。显然,MySQL 将上述代码作为单个事务处理(参见“Statements That Cause an Implicit Commit”)。所以你必须检查你的数据库实现。
  3. downgrade()功能可以类似地实现。

    附录。有关将架构迁移与数据迁移配对的示例,请参阅Alembic Cookbook中的Conditional Migration Elements部分。

答案 1 :(得分:4)

alembic是架构迁移工具,而不是数据迁移。虽然它也可以这样使用。这就是为什么你在这方面找不到很多文档的原因。也就是说,我会创建三个单独的修订:

  1. 在不删除firstname
  2. 的情况下添加lastnamename
  3. 就像在应用中一样阅读所有用户并分割其名称,然后更新firstlast。 e.g。

    for user in session.query(User).all():
        user.firstname, user.lastname = user.name.split(' ')
    session.commit()
    
  4. 删除name