全文搜索API

用于 Whoosh 的 Frappe 封装器

update_index_by_name(self, doc_name)

封装 update_index 方法,根据名称获取文档并更新索引。此函数会更改当前用户,应仅以管理员身份运行或在后台任务中运行。

参数:

  • self (对象):全文搜索实例
  • doc_name (字符串):要更新的文档名称

remove_document_from_index(self, doc_name)

从搜索索引中移除文档

参数:

  • self (对象):全文搜索实例
  • doc_name (字符串):要移除的文档名称

update_index(self, document)

更新文档的搜索索引

参数:

  • self (对象):全文搜索实例
  • document (字典):包含标题、路径和内容的字典

build_index(self)

为所有已解析的文档构建索引

search(self, text, scope=None, limit=20)

从当前索引中进行搜索

参数:

  • text (字符串):要搜索的文本
  • scope (字符串,可选):限制搜索范围。默认为 None。
  • limit (整数,可选):限制搜索结果数量。默认为 20。

返回:

  • [列表(字典)]:搜索结果