ERPGulf

  • GitHub
  • Discuss
  • Twitter
  • Getting Started
    • Introduction
    • Installation
    • Prerequisites
    • Tutorial
    • Documentation
    • Guides
  • Basics
    • What is Frappe?
    • Why Frappe?
    • Architecture
    • Directory Structure
    • Apps
    • Sites
    • DocTypes
    • Users and Permissions
    • Asset Bundling
    • Static Assets
  • Desk (Admin UI)
    • Desk
    • Reports
    • Printing
    • Attachments
    • Scripting
    • Translations
    • Form Tours
  • Portal
    • Portal Pages
    • Web Forms
    • Blog Post
  • Python API
    • Document
    • Database
    • Jinja
    • Routing and Rendering
    • Language Resolution
    • Common Utilities
    • Response
    • Search
    • Hooks
    • REST API
    • Full Text Search
    • Dialog API
    • Query Builder
  • Javascript API
    • Form
    • Controls
    • List
    • Page
    • Tree
    • Common Utilities
    • Dialog API
    • Chart API
    • Scanner API
  • Integrations
    • Razorpay
    • LDAP Authentication
    • Google Drive
  • Bench CLI
    • What is Bench?
    • Bench Commands
    • Frappe Commands
    • Extending the CLI
  • Deployment
    • Database Migrations
    • Production Setup
    • Rate Limiting
  • Writing Tests
    • Server Side Tests
    • UI Tests
  • Help
    • Debugging
    • Profiling
    • Contribution Guidelines
  • Getting Started
    • Introduction
    • Installation
    • Prerequisites
    • Tutorial
    • Documentation
    • Guides
  • Basics
    • What is Frappe?
    • Why Frappe?
    • Architecture
    • Directory Structure
    • Apps
    • Sites
    • DocTypes
    • Users and Permissions
    • Asset Bundling
    • Static Assets
  • Desk (Admin UI)
    • Desk
    • Reports
    • Printing
    • Attachments
    • Scripting
    • Translations
    • Form Tours
  • Portal
    • Portal Pages
    • Web Forms
    • Blog Post
  • Python API
    • Document
    • Database
    • Jinja
    • Routing and Rendering
    • Language Resolution
    • Common Utilities
    • Response
    • Search
    • Hooks
    • REST API
    • Full Text Search
    • Dialog API
    • Query Builder
  • Javascript API
    • Form
    • Controls
    • List
    • Page
    • Tree
    • Common Utilities
    • Dialog API
    • Chart API
    • Scanner API
  • Integrations
    • Razorpay
    • LDAP Authentication
    • Google Drive
  • Bench CLI
    • What is Bench?
    • Bench Commands
    • Frappe Commands
    • Extending the CLI
  • Deployment
    • Database Migrations
    • Production Setup
    • Rate Limiting
  • Writing Tests
    • Server Side Tests
    • UI Tests
  • Help
    • Debugging
    • Profiling
    • Contribution Guidelines

FullTextSearch API Reference

Frappe Wrapper for Whoosh

update_index_by_name(self, doc_name)

Wraps update_index method, gets the document from name and updates the index. This function changes the current user and should only be run as administrator or in a background job.

Args:

  • self (object): FullTextSearch Instance
  • doc_name (str): name of the document to be updated

remove_document_from_index(self, doc_name)

Remove document from search index

Args:

  • self (object): FullTextSearch Instance
  • doc_name (str): name of the document to be removed

update_index(self, document)

Update search index for a document

Args:

  • self (object): FullTextSearch Instance
  • document (_dict): A dictionary with title, path and content

build_index(self)

Build index for all parsed documents

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

Search from the current index

Args:

  • text (str): String to search for
  • scope (str, optional): Scope to limit the search. Defaults to None.
  • limit (int, optional): Limit number of search results. Defaults to 20.

Returns:

  • [list(_dict)]: Search results
On this page
  • FullTextSearch API Reference
    • update_index_by_name(self, doc_name)
    • remove_document_from_index(self, doc_name)
    • update_index(self, document)
    • build_index(self)
    • search(self, text, scope=None, limit=20)
Accounting HR and Payroll Manufacturing Sales and Purchase CRM Projects HelpDesk Asset Management Website ERPNext 13 We're hiring Investors FAQ Certification ( ECA )
© © ERPGulf. Content licensed under CC-BY-SA 3.0.



ERPGulf is a customized version of ERPNext ( www.erpnext.com ) , localized for each Gulf countries and hosted and supported regionally

The ERPGulf code is licensed as GNU General Public License (v3) and the Documentation is licensed as Creative Commons (CC-BY-SA-3.0) and the copyright is owned by ERPGulf Pvt Ltd.

Contact support@erpgulf.com for any more details

Git Logo Vectors Free Downloadtwitter-logoFacebook Logo Icon of Flat style - Available in SVG, PNG, EPS, AI & Icon  fontsinstagram-logo (1) - PayGoMedium Logo Icon of Glyph style - Available in SVG, PNG, EPS, AI & Icon  fontsLinkedin Logo Icon of Glyph style - Available in SVG, PNG, EPS, AI & Icon  fonts






Built on Frappe