quickwit-oss/tantivy

Make the behavior of an empty query configurable in `QueryParser`

Open

#386 opened on Aug 20, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (8,354 stars) (499 forks)batch import
enhancementgood first issuehelp wanted

Description

In some use case, most of the time, people want an empty query to match nothing, but for some analytics use case, it might make more sense for empty query to match all documents.

Add a setter ".set_empty_query_match_all(should_match_all: bool)" to the QueryParser to enforce the non default behavior. (Also add a getter .get_empty_query_match_all() to read this property).

Contributor guide

Tech stack
rust
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingbasic knowledge of Tantivy QueryParser
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Locate the QueryParser struct in the Tantivy source code (likely in src/query/query parser.rs or similar). Add a boolean field `empty query match all` with a setter and getter. Modify the `parse query` or equivalent method to check this flag when an empty query is encountered. Ensure that the default behavior (empty query matches nothing) remains unchanged unless the setter is called with `true`. Test the changes by writing unit tests for both behaviors.