在 Alembic 迁移期间更新列内容

Question

假设我的数据库模型包含一个对象User：

Base = declarative_base() 

class User(Base):                                                               
    __tablename__ = 'users'                                                     

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

我的数据库包含一个带有 n 行的 users 表。在某些时候，我决定将name 拆分为firstname 和lastname，并在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 one 和 this one 都建议使用 execute() 和 bulk_insert() 在迁移期间执行原始 SQL 语句。 This (incomplete) solution 导入当前的数据库模型，但是当模型发生变化时，这种方法很脆弱。

如何在 Alembic 迁移期间迁移和修改列数据的现有内容？推荐的方法是什么，它记录在哪里？

Answer 1

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

1. 添加firstname和lastname而不删除name

2. 像在应用程序中一样读取所有用户并拆分他们的名称，然后更新first 和last。例如

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

3. 删除name

Answer 2

norbertpy’s answer 中提出的解决方案一开始听起来不错，但我认为它有一个根本缺陷：它会引入多个事务——在这些步骤之间，数据库将处于时髦、不一致的状态。我也觉得奇怪（见my comment），一个工具会在没有数据库数据的情况下迁移数据库的模式；两者联系得太紧密，无法分开。

经过一番摸索和几次对话（参见this Gist 中的代码 sn-ps），我决定采用以下解决方案：

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. 根据 DB 驱动程序，代码的行为可能会有所不同。显然，MySQL 不 将上述代码作为单个事务处理（请参阅“Statements That Cause an Implicit Commit”）。因此，您必须检查您的数据库实施。

downgrade() 函数可以类似地实现。

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