配置

对于自动生成的搜索触发器、索引和搜索向量列，SQLAlchemy-Searchable 提供了许多定制选项。

全局配置选项

可以通过将以下配置选项传递给 make_searchable() 函数，将它们全局定义

search_trigger_name

定义搜索数据库触发器的名称。默认命名约定为 "{table}_{column}_trigger"。

search_trigger_function_name

定义数据库搜索向量更新函数的名称。默认命名约定为 {table}_{column}_update。

regconfig

这是决定用于搜索的语言配置的 PostgreSQL 文本搜索配置。默认设置是 "pg_catalog.english"。

以下是利用这些选项的示例

make_searchable(Base.metadata, options={"regconfig": "pg_catalog.finnish"})

更改搜索向量的目录

在某些情况下，您可能希望将搜索向量的默认语言配置切换为另一种语言。您可以通过提供 regconfig 参数来为 TSVectorType 实现此目的。在以下示例中，我们使用芬兰语代替默认英语

class Article(Base):
    __tablename__ = "article"

    name = sa.Column(sa.Text(255))
    search_vector = TSVectorType("name", regconfig="pg_catalog.finnish")

加权搜索结果

为了进一步细化搜索结果，可以应用 PostgreSQL 的 术语加权系统（从 A 到 D）。此示例演示了如何优先考虑在文章标题中找到的术语，而不是在内容中找到的术语

class Article(Base):
    __tablename__ = "article"

    id = sa.Column(sa.Integer, primary_key=True)
    title = sa.Column(sa.String(255))
    content = sa.Column(sa.Text)
    search_vector = sa.Column(
        TSVectorType("title", "content", weights={"title": "A", "content": "B"})
    )

请记住，在使用加权搜索词时，您需要使用 sort=True 选项进行搜索

query = search(sa.select(Article), "search text", sort=True)

每个类具有多个搜索向量

在模型需要多个搜索向量的示例中，SQLAlchemy-Searchable 对你而言绰绰有余。以下是如何为 Article 类设置多个搜索向量的

class Article(Base):
    __tablename__ = "article"

    id = sa.Column(sa.Integer, primary_key=True)
    name = sa.Column(sa.String(255))
    content = sa.Column(sa.Text)
    description = sa.Column(sa.Text)
    simple_search_vector = sa.Column(TSVectorType("name"))

    fat_search_vector = sa.Column(TSVectorType("name", "content", "description"))

然后可以在执行查询时选择使用哪个搜索向量

query = search(sa.select(Article), "first", vector=Article.fat_search_vector)

组合搜索向量

有时你可能需要同时从多个表中进行搜索。这可以通过使用组合搜索向量实现。考虑以下模型定义，其中每篇文章具有一个类别

import sqlalchemy as sa
from sqlalchemy.orm import declarative_base
from sqlalchemy_utils.types import TSVectorType

Base = declarative_base()


class Category(Base):
    __tablename__ = "category"

    id = sa.Column(sa.Integer, primary_key=True)
    name = sa.Column(sa.String(255))
    search_vector = sa.Column(TSVectorType("name"))


class Article(Base):
    __tablename__ = "article"

    id = sa.Column(sa.Integer, primary_key=True)
    name = sa.Column(sa.String(255))
    content = sa.Column(sa.Text)
    search_vector = sa.Column(TSVectorType("name", "content"))
    category_id = sa.Column(sa.Integer, sa.ForeignKey(Category.id))
    category = sa.orm.relationship(Category)

现在考虑一种情况，我们希望找到文章内容或名称或类别名称中包含单词“矩阵”的所有文章。这可以通过以下方式实现

combined_search_vector = Article.search_vector | Category.search_vector
query = search(
    sa.select(Article).join(Category), "matrix", vector=combined_search_vector
)

在使用左连接时，此查询会变得稍微复杂一些。然后，你必须考虑到使用 coalesce 函数而 Category.search_vector 可能为 None 的情况

combined_search_vector = Article.search_vector | sa.func.coalesce(
    Category.search_vector, ""
)