在PostgreSQL上使用SQLAlChemy创建全文搜索索引

问题描述

我需要使用SQLAlChemy在Python中创建PostgreSQL全文搜索索引。以下是我希望在SQL中实现的功能：

CREATE TABLE person ( id INTEGER PRIMARY KEY, name TEXT );
CREATE INDEX person_idx ON person USING GIN (to_tsvector('simple', name));

现在，在使用ORM时，如何使用SQLAlChemy完成第二部分：

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

---

解决方案

您可以使用__table_args__中的Index创建索引。此外，如果需要多个字段，我还使用一个函数创建ts_vector，使其更加整洁和可重用。类似以下内容：

from sqlalchemy.dialects import postgresql

def create_tsvector(*args):
    exp = args[0]
    for e in args[1:]:
        exp += ' ' + e
    return func.to_tsvector('english', exp)

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

    __ts_vector__ = create_tsvector(
        cast(func.coalesce(name, ''), postgresql.TEXT)
    )

    __table_args__ = (
        Index(
            'idx_person_fts',
            __ts_vector__,
            postgresql_using='gin'
        )
    )

---

更新： 使用索引的示例查询(根据注释更正)：

people = Person.query.filter(Person.__ts_vector__.match(expressions, postgresql_regconfig='english')).all()