Flask-SQLAlchemy和Alembic: Python web应用程序中迁移数据库的最佳实践（第二部分）-Python教程-PHP中文网

Flask-SQLAlchemy和Alembic: Python web应用程序中迁移数据库的最佳实践（第二部分）

PHPz

发布： 2023-06-17 20:34:38

原创

1350人浏览过

flask-sqlalchemy和alembic: python web应用程序中迁移数据库的最佳实践（第二部分）

在上一篇文章中，我们讨论了 Flask-SQLAlchemy 和 Alembic 是如何协作的。本文将主要介绍如何在一些基本的数据模型中添加和移除列，并对一些列修改类型或约束的方法。这些变化在实际的项目开发过程中非常常见。

列的添加和删除

在使用 Flask-SQLAlchemy 和 Alembic 进行数据库迁移时，添加和移除表的列非常常见。为了演示这个过程，我们将在以下示例 Person 模型中添加一些新列。

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class Person(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(255), nullable=False)
    age = db.Column(db.Integer)

    def __repr__(self):
        return '<Person %r>' % self.name

登录后复制

假设我们要添加两个新列，一个是出生日期（birthdate）以及一个布尔类型的列，表示这个人是否已经结婚（is_married）。我们可以使用以下命令生成迁移脚本：

立即学习“Python免费学习笔记（深入）”；

$ alembic revision -m "add birthdate, is_married columns to person"

登录后复制

接着，我们需要修改生成的.py迁移脚本文件，来添加新列。我们可以在 upgrade() 函数中使用 add_column()。

from alembic import op
import sqlalchemy as sa

def upgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.add_column('person', sa.Column('birthdate', sa.Date(), nullable=True))
    op.add_column('person', sa.Column('is_married', sa.Boolean(), nullable=True))
    # ### end Alembic commands ###

登录后复制

对于删除列，我们可以在相应的析构函数 degrade() 中使用 drop_column() 函数，从数据库模型中删除列。

def downgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.drop_column('person', 'birthdate')
    op.drop_column('person', 'is_married')
    # ### end Alembic commands ###

登录后复制

该迁移脚本的完整示例代码可以在下面找到。

"""add birthdate, is_married columns to person"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'eab2c4f1c9fb'
down_revision = '7cfae59c2402'
branch_labels = None
depends_on = None


def upgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.add_column('person', sa.Column('birthdate', sa.Date(), nullable=True))
    op.add_column('person', sa.Column('is_married', sa.Boolean(), nullable=True))
    # ### end Alembic commands ###


def downgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.drop_column('person', 'birthdate')
    op.drop_column('person', 'is_married')
    # ### end Alembic commands ###

登录后复制

列的类型更改和约束修改

在许多情况下，我们需要对列的类型和约束进行修改。假设我们想要将 Person 模型的 age 列类型从 INTEGER 更改为 SMALLINT。我们可以在生成的.py迁移脚本文件中使用 alter_column() 函数来实现。

def upgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.alter_column('person', 'age', existing_type=sa.Integer(),
               type_=sa.SmallInteger(), nullable=True)
    # ### end Alembic commands ###

登录后复制

我们还可以修改列上的约束。检查 Person 模型，我们注意到模型中没有唯一值约束。我们可以使用以下代码为 name 和 birthdate 列添加唯一值约束。

from alembic import op
import sqlalchemy as sa

def upgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.create_unique_constraint(op.f('uq_person_name'), 'person', ['name'])
    op.create_unique_constraint(op.f('uq_person_birthdate'), 'person', ['birthdate'])
    # ### end Alembic commands ###

登录后复制

如果我们以后需要取消惟一值约束，我们可以使用 drop_constraint() 函数。例如：

def downgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.drop_constraint(op.f('uq_person_name'), 'person', type_='unique')
    op.drop_constraint(op.f('uq_person_birthdate'), 'person', type_='unique')
    # ### end Alembic commands ###

登录后复制

本文介绍了一些常见的数据库模式变更类型，例如添加和删除列，更改列约束和更改列数据类型。它演示了如何使用 Flask-SQLAlchemy 和 Alembic 进行数据库迁移的最佳实践。这将帮助您更高效地管理数据库模式以及在团队环境中更容易地共享迁移文件。

参考链接：