如何在Flask+SQLAlchemy中使用ExcludeConstraint实现范围不重叠约束

现有代码核心问题 #

• 数据库选型错误：IntRangeType范围类型、ExcludeConstraint排他约束、GIST索引均为PostgreSQL独有的特性，你当前使用的SQLite数据库完全不支持上述能力，必须切换为PostgreSQL数据库。
• 约束定义位置错误：ExcludeConstraint属于表级约束，不能作为列参数传入db.Column，必须在模型的__table_args__属性中声明。

完整可运行实现 #

前置依赖安装 #

pip install flask flask-sqlalchemy sqlalchemy-utils psycopg2-binary

代码实现 #

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from sqlalchemy.dialects.postgresql import ExcludeConstraint
from sqlalchemy_utils import IntRangeType
from sqlalchemy.exc import IntegrityError

app = Flask(__name__)
# 替换为你自己的PostgreSQL连接信息：postgresql://用户名:密码@地址:端口/数据库名
app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://postgres:123456@localhost/test_db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)


class TestModel(db.Model):
    __tablename__ = 'test'

    id = db.Column(db.Integer, primary_key=True)
    intrange = db.Column(IntRangeType, nullable=False)

    # 表级约束声明位置
    __table_args__ = (
        ExcludeConstraint(
            ('intrange', '&&'),
            name='unique_intrange_constraint',
            using='gist'
        ),
    )

# 初始化数据库表，首次运行执行即可
with app.app_context():
    db.create_all()

使用示例 #

with app.app_context():
    # 插入第一个范围：等效于整数闭区间[10,20]（IntRangeType默认左闭右开，故上限写21）
    range1 = TestModel(intrange=(10, 21))
    db.session.add(range1)
    db.session.commit()

    # 插入合法范围[21,40]，执行成功
    range2 = TestModel(intrange=(21, 41))
    db.session.add(range2)
    db.session.commit()

    # 插入重叠范围[5,15]，触发排他约束报错
    try:
        range3 = TestModel(intrange=(5, 16))
        db.session.add(range3)
        db.session.commit()
    except IntegrityError:
        db.session.rollback()
        print("插入失败：范围与已有记录重叠")

边界注意事项 #

IntRangeType默认使用左闭右开规则，如果你要表示整数闭区间[a,b]，传入范围时需要将上限设置为b+1，否则会出现边界判断不符合预期的问题。

内容的提问来源于stack exchange，提问作者user2156115