postgresql - 使用具有唯一约束的 SQLAlchemy 的 on_conflict_do_update()

Question

我正在使用 SQLAlchemy 1.3.4 和 PostgreSQL 11.3。

我有以下(简化的)表定义:

class MyModel(Base):
    __tablename__ = 'mymodel'

    id = Column(Integer, primary_key=True)
    col1 = Column(Unicode, nullable=False)
    col2 = Column(Unicode, nullable=False)
    col3 = Column(Unicode, nullable=False)
    col4 = Column(Boolean)

    created_at = Column(DateTime(timezone=True), nullable=False)
    updated_at = Column(DateTime(timezone=True), nullable=False)

    __table_args__ = (
        Index('uq_mymodel_col1_col2_col3_col4',
              col1, col2, col3, col4,
              unique=True, postgresql_where=col4.isnot(None)),
        Index('uq_mymodel_col1_col2_col3',
              col1, col2, col3,
              unique=True, postgresql_where=col4.is_(None)),
    )

(我必须创建 2 个唯一索引而不是 UniqueConstraint，因为 UniqueConstraint 将允许多行具有相同的 (col1, col2, col3) 是 col4 是 null，这是我不想要的)

我正在尝试执行以下查询:

INSERT INTO mymodel (col1, col2, col3, col4, created_at, updated_at)
VALUES (%(col1)s, %(col2)s, %(col3)s, %(col4)s, %(created_at)s, %(updated_at)s)
ON CONFLICT DO UPDATE SET updated_at = %(param_1)s
RETURNING mymodel.id

虽然我不知道如何正确使用 SQLAlchemy 的 on_conflict_do_update()。 :-/

这是我尝试过的:

values = {…}

stmt = insert(MyModel.__table__).values(**values)
stmt = stmt.returning(MyModel.__table__.c.id)
stmt = stmt.on_conflict_do_update(set_={'updated_at': values['updated_at']})
result = dbsession.connection().execute(stmt)

但是 SQLAlchemy 提示:必须指定 constraint 或 index_elements，但不能同时指定两者，除非 DO NOTHING

我发现很不清楚如何使用 constraint 或 index_elements。

我尝试了一些东西，但无济于事。例如:

values = {…}

stmt = insert(MyModel.__table__).values(**values)
stmt = stmt.returning(MyModel.__table__.c.id)
stmt = stmt.on_conflict_do_update(constraint='uq_mymodel_col1_col2_col3_col4'
                                  set_={'updated_at': values['updated_at']})
result = dbsession.connection().execute(stmt)

但是这也不起作用:表“mymodel”的约束“uq_mymodel_col1_col2_col3_col4”不存在。但它确实存在。 (我什至从 pgsql 复制粘贴以确保我没有打错字)

无论如何，我有两个可能引发冲突的唯一约束，但 on_conflict_do_update() 似乎只接受一个。所以我也尝试像这样指定两者:

values = {…}

stmt = insert(MyModel.__table__).values(**values)
stmt = stmt.returning(MyModel.__table__.c.id)
stmt = stmt.on_conflict_do_update(constraint='uq_mymodel_col1_col2_col3_col4'
                                  set_={'updated_at': values['updated_at']})
stmt = stmt.on_conflict_do_update(constraint='uq_mymodel_col1_col2_col3'
                                  set_={'updated_at': values['updated_at']})
result = dbsession.connection().execute(stmt)

但我得到同样的错误，uq_mymodel_col1_col2_col3_col4 不存在。

此时我只是不知道如何执行上述查询，非常感谢您的帮助。

Answer 1

好的，我想我明白了。所以问题毕竟不是来自 SQLAlchemy，我实际上是在滥用 PostgreSQL。

首先，我上面粘贴的 SQL 查询不起作用，因为与 SQLAlchemy 一样，PostgreSQL 需要指定索引列或约束名称。

当我指定我的约束之一时，PostgreSQL 给了我与 SQLAlchemy 相同的错误。那是因为我的约束实际上不是约束，而是唯一索引。看起来它确实必须是一个唯一约束，而不是一个唯一索引。 (即使该索引与唯一约束具有相同的效果)

所以我重写了模型如下:

# Feel free to use the following code under the MIT license


class NullableBoolean(TypeDecorator):
    """A three-states boolean, which allows working with UNIQUE constraints

    In PostgreSQL, when making a composite UNIQUE constraint where one of the
    columns is a nullable boolean, then null values for that column are counted
    as always different.

    So if you have:

        class MyModel(Base):
            __tablename__ = 'mymodel'

            id = Column(Integer, primary_key=True)
            col1 = Column(Unicode, nullable=False)
            col2 = Column(Unicode, nullable=False)
            col3 = Column(Boolean)

            __table_args__ = (
                UniqueConstraint(col1, col2, col3,
                                 name='uq_mymodel_col1_col2_col3'),
            }

    Then you could INSERT multiple records which have the same (col1, col2)
    when col3 is None.

    If you want None to be considered a "proper" value that triggers the
    unicity constraint, then use this type instead of a nullable Boolean.
    """
    impl = Enum

    def __init__(self, **kwargs):
        kwargs['name'] = 'nullable_boolean_enum'

        super().__init__('true', 'false', 'unknown', **kwargs)

    def process_bind_param(self, value, dialect):
        """Convert the Python values into the SQL ones"""
        return {
            True: 'true',
            False: 'false',
            None: 'unknown',
        }[value]

    def process_result_value(self, value, dialect):
        """Convert the SQL values into the Python ones"""
        return {
            'true': True,
            'false': False,
            'unknown': None,
        }[value]


class MyModel(Base):
    __tablename__ = 'mymodel'

    id = Column(Integer, primary_key=True)
    col1 = Column(Unicode, nullable=False)
    col2 = Column(Unicode, nullable=False)
    col3 = Column(Unicode, nullable=False)
    col4 = Column(Boolean)

    created_at = Column(DateTime(timezone=True), nullable=False)
    updated_at = Column(DateTime(timezone=True), nullable=False)

    __table_args__ = (
        UniqueConstraint(col1, col2, col3, col4,
                         name='uq_mymodel_col1_col2_col3_col4')
    )

现在它似乎按预期工作。

希望对以后的人有所帮助。如果有人有更好的主意，我很感兴趣。 :)