Frappe Framework
API FullTextSearch
FullTextSearch enveloppe Whoosh pour indexer un document, retirer une fiche, reconstruire l’index et chercher un texte.
À quoi sert cette API
L’API FullTextSearch est l’enveloppe Frappe de Whoosh. Les méthodes ci-dessous s’appellent sur une instance FullTextSearch.
Méthodes
update_index_by_name(doc_name)
Enveloppe update_index : elle charge le document par son nom, puis met à jour l’index. Elle change l’utilisateur courant. Elle ne doit être lancée qu’en tant qu’administrateur, ou dans une tâche de fond.
remove_document_from_index(doc_name)
Retire le document de l’index de recherche. doc_name est le nom du document à retirer.
update_index(document)
Met à jour l’index pour un document. document est un dictionnaire qui contient title, path et content.
build_index()
Construit l’index de tous les documents déjà analysés.
search(text, scope=None, limit=20)
Cherche dans l’index courant.
| Argument | Rôle |
|---|---|
text | Chaîne recherchée |
scope | Périmètre facultatif. Par défaut, None. |
limit | Nombre maximal de résultats. Par défaut, 20. |
La méthode renvoie une liste de dictionnaires, les résultats de la recherche.
Point d’attention
update_index_by_name change l’utilisateur courant. La source la réserve à l’administrateur ou à une tâche de fond. update_index attend déjà un dictionnaire titre, chemin et contenu : il ne charge pas le document lui-même.