frappe-core-search

Implement search functionality in Frappe systems with Whoosh and SQLite FTS5 backends.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/nathanabay/epc_bespo --skill frappe-core-search-nathanabay
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: frappe-core-search
Source: https://github.com/nathanabay/epc_bespo/tree/main/skills-frappe/core/frappe-core-search
Command: npx skills add https://github.com/nathanabay/epc_bespo --skill frappe-core-search-nathanabay

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Facilitates the integration of comprehensive search capabilities within Frappe applications, ensuring efficient data retrieval and user-friendly search interfaces.

Core Features & Use Cases

  • Link Field Search: Configure efficient autocomplete and custom search queries for link fields, enhancing user navigation.
  • Global Search: Enable permission-filtered cross-doctype search for desk and web users, with index rebuilding and indexing controls.
  • Full-Text Search Support: Integrate advanced full-text search using Whoosh or SQLiteSearch (v15+) for website content and internal data.
  • Customization & Extension: Override default queries, implement custom scoring, and fine-tune indexing behavior for tailored search experiences.
  • Use Case: A company wants real-time link field suggestions and global search across multiple modules to improve data discoverability.

Quick Start

Use search functions to index your data, customize queries for specific DocTypes, and update search settings directly through hooks and configuration.

Frequently Asked Questions about frappe-core-search

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I implement link field autocomplete and custom search queries in Frappe?

To implement link field search in Frappe, you configure efficient autocomplete and custom queries for link fields. This enhances user navigation by providing tailored, real-time suggestions based on custom logic.

How does global search handle permission-filtered cross-doctype search in Frappe?

Global search in Frappe enables permission-filtered cross-doctype search for desk and web users. It manages index rebuilding and indexing controls to ensure secure, efficient data retrieval across multiple modules.

Does Frappe full-text search support Whoosh and SQLite FTS5 backends?

Yes, Frappe full-text search supports both Whoosh and SQLite FTS5 backends. You can integrate these engines for website content and internal data to provide advanced search capabilities across your application.

Can I override default search queries and implement custom scoring in Frappe?

Yes, you can override default search queries and implement custom scoring in Frappe. The framework allows you to fine-tune indexing behavior and customize search logic to deliver tailored experiences for enterprise requirements.

What is the best way to index data and update search settings in Frappe v14-v16?

The best way to index data in Frappe v14-v16 is using the framework's search functions through hooks and configuration. This lets you update search settings, customize DocType queries, and maintain extensibility.

When should I use custom search logic versus default global indexing in Frappe?

Use custom search logic when you need tailored autocomplete, specific scoring, or fine-tuned indexing for enterprise requirements. Use default global indexing for standard, permission-filtered cross-doctype search without custom queries.