Why Percolate queries (reverse search) in Elasticsearch? - Purpose & Use Cases

The Big Idea

What if you could instantly know which saved searches match any new piece of data without running each search one by one?

The Scenario

Imagine you have hundreds of saved search rules and you want to find out which rules match a new document you just received. Doing this by checking each rule one by one manually is like searching for a needle in a haystack.

The Problem

Manually comparing a new document against many saved queries is slow and error-prone. It wastes time and computing power because you have to run each query separately, and it's easy to miss matches or make mistakes.

The Solution

Percolate queries let you reverse the process: instead of running many queries on new data, you register your queries once, then send new documents to find which queries match instantly. This saves time and makes searching efficient and reliable.

Before vs After

✗ Before

for query in saved_queries:
    if query.matches(new_document):
        print('Match found')

✓ After

POST /my_index/_percolate
{
  "doc": { "field": "value" }
}

What It Enables

It enables instant matching of new documents against many saved queries, making real-time alerting and filtering possible.

Real Life Example

A news website wants to notify users when articles match their interests. Using percolate queries, the site quickly finds which user queries match each new article and sends alerts immediately.

Key Takeaways

Manual matching of documents to queries is slow and inefficient.

Percolate queries reverse the search process for fast matching.

This technique supports real-time notifications and filtering.

Practice

1.

What is the main purpose of a percolate query in Elasticsearch?

easy

A. To find stored queries that match a new document

B. To update documents in an index

C. To delete documents based on a condition

D. To aggregate data by terms

Solution

1. Step 1: Understand percolate query concept

   A percolate query is used to find stored queries that match a new document, reversing the usual search direction.

2. Step 2: Compare options with concept

   The other options describe other Elasticsearch operations, not percolate queries.

3. Final Answer:

   To find stored queries that match a new document -> Option A

4. Quick Check:

   Percolate query = find matching stored queries [OK]

Hint: Percolate queries match queries to documents, not documents to queries [OK]

Common Mistakes:

• Confusing percolate query with regular search
• Thinking it updates or deletes documents
• Mixing it with aggregation queries

2.

Which mapping type must be included in an Elasticsearch index to use percolate queries?

{
  "mappings": {
    "properties": {
      "query": {
        "type": "???"
      }
    }
  }
}

easy

A. "percolator"

B. "text"

C. "keyword"

D. "nested"

Solution

1. Step 1: Identify required field type for percolate queries

   Elasticsearch requires a special field type called "percolator" to store queries for percolate queries.

2. Step 2: Match options with required type

   Only "percolator" uses "percolator" type; others are for different purposes.

3. Final Answer:

   "percolator" -> Option A

4. Quick Check:

   Percolate field type = "percolator" [OK]

Hint: Use "percolator" type for storing queries in mapping [OK]

Common Mistakes:

• Using "text" or "keyword" instead of "percolator"
• Confusing nested type with percolator
• Omitting the percolator field in mapping

3.

Given the following percolate query, what will it return?

{
  "query": {
    "percolate": {
      "field": "query",
      "document": {
        "message": "Elasticsearch alerting"
      }
    }
  }
}

Assuming the index has stored queries matching documents containing "alerting".

medium

A. Documents containing the word "alerting"

B. An error because "document" is missing an ID

C. All documents in the index

D. Stored queries that match the document with message "Elasticsearch alerting"

Solution

1. Step 1: Understand percolate query behavior

   The percolate query matches stored queries against the provided document, returning matching stored queries.

2. Step 2: Analyze the given query

   The query uses "document" with a message field; it will find stored queries matching this document's content.

3. Final Answer:

   Stored queries that match the document with message "Elasticsearch alerting" -> Option D

4. Quick Check:

   Percolate query returns matching stored queries [OK]

Hint: Percolate queries return stored queries matching the input document [OK]

Common Mistakes:

• Thinking it returns documents instead of queries
• Assuming document ID is required for percolate query
• Confusing percolate with regular search

4.

Identify the error in this percolate query:

{
  "query": {
    "percolate": {
      "field": "query"
      "document": {
        "content": "Test document"
      }
    }
  }
}

medium

A. "field" should be "query_field"

B. Missing comma between "field" and "document" fields

C. "document" must include an "id" field

D. Percolate query cannot use 'content' field in document

Solution

1. Step 1: Check JSON syntax in query

   Between "field" and "document" keys, a comma is missing, causing invalid JSON.

2. Step 2: Validate other parts

   "field" name is correct, "document" can omit "id", and "content" is valid as document content.

3. Final Answer:

   Missing comma between "field" and "document" fields -> Option B

4. Quick Check:

   JSON syntax error = missing comma [OK]

Hint: Check commas between JSON fields carefully [OK]

Common Mistakes:

• Forgetting commas between JSON keys
• Assuming document must have an ID
• Changing field names unnecessarily

5.

You want to build an alert system that triggers when new documents match any stored queries. Which steps are necessary to implement this using percolate queries?

hard

A. Use aggregation queries on documents to find alerts

B. Store documents in a normal index, then run a regular search for alerts

C. Create an index with a percolator field, store queries, then percolate new documents against stored queries

D. Create a nested field for queries and filter documents manually

Solution

1. Step 1: Setup index with percolator field

   Define an index mapping with a "percolator" type field to store queries for reverse matching.

2. Step 2: Store queries and percolate new documents

   Index the alert queries into the percolator field, then use percolate queries to check if new documents match any stored queries.

3. Final Answer:

   Create an index with a percolator field, store queries, then percolate new documents against stored queries -> Option C

4. Quick Check:

   Percolate queries enable alerting by matching docs to stored queries [OK]

Hint: Store queries in percolator field, then percolate new docs [OK]

Common Mistakes:

• Using regular search instead of percolate queries
• Not defining percolator field in mapping
• Trying to use aggregations for alerting