Peewee 可以使用 SQLite 的 FTS5（全文搜索）辅助函数 highlight() 吗？

Question

1. SQLite 的 FTS5 支持highlight()。该辅助函数返回全文搜索查询结果的标签：参见official documentation。

2. Peewee 的 code on Github, in the <sqlite_ext.py> module 也提到了 highlight()，虽然只是顺便提及。

   内置辅助功能：

   • bm25(tbl[, weight_0, ... weight_n])
   • highlight(tbl, col_idx, prefix, suffix)
   • sn-p(tbl, col_idx, prefix, suffix, ?, max_tokens)

3. 尽管 Peewee 已经支持 bm25() 和 rank() 作为现有的 FTS5 辅助功能，但我在 Peewee 的文档中没有找到示例代码或对 highlight() 的引用。

4. 除非我遗漏了什么，否则如何在我的 Python 代码中将 FTS5 highlight() 与 Peewee 一起使用？ （如果这很重要，我正在使用 Django。）

Answer 1

是的，只需在全文搜索查询中选择 fn.highlight(...)。

class Post(FTS5Model):
    title = SearchField()
    content = SearchField()
    class Meta:
        database = db

db.create_tables([Post])

Post.create(title='alpha', content='this is post alpha')
Post.create(title='beta', content='this is post beta')
Post.create(title='delta', content='this is post delta')

query = (Post
         .select(fn.highlight(Post._meta.entity, 1, '[', ']').alias('hi'))
         .where(Post.match('post')))
print(query.sql())
for row in query:
    print(row.hi)

请注意，我们必须使用Post._meta.entity 作为第一个参数，以避免使用表的别名 - Sqlite 特别是明确使用 FTS 表名。

打印：

this is [post] alpha
this is [post] beta
this is [post] delta