Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Fix percolate query headings #83988

Merged
merged 1 commit into from
Feb 15, 2022
Merged

[DOCS] Fix percolate query headings #83988

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions docs/reference/query-dsl/percolate-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ stored in an index. The `percolate` query itself
contains the document that will be used as query
to match with the stored queries.

[discrete]
=== Sample usage
==== Sample usage

TIP: To provide a simple example, this documentation uses one index,
`my-index-000001`, for both the percolate queries and documents. This setup can
Expand Down Expand Up @@ -124,7 +123,6 @@ The above request will yield the following response:
<2> The `_percolator_document_slot` field indicates which document has matched with this query.
Useful when percolating multiple document simultaneously.

[discrete]
==== Parameters

The following parameters are required when percolating a document:
Expand All @@ -150,7 +148,6 @@ In that case the `document` parameter can be substituted with the following para
`preference`:: Optionally, preference to be used to fetch document to percolate.
`version`:: Optionally, the expected version of the document to be fetched.

[discrete]
==== Percolating in a filter context

In case you are not interested in the score, better performance can be expected by wrapping
Expand Down Expand Up @@ -185,7 +182,6 @@ should be wrapped in a `constant_score` query or a `bool` query's filter clause.

Note that the `percolate` query never gets cached by the query cache.

[discrete]
==== Percolating multiple documents

The `percolate` query can match multiple documents simultaneously with the indexed percolator queries.
Expand Down Expand Up @@ -267,14 +263,12 @@ GET /my-index-000001/_search
<1> The `_percolator_document_slot` indicates that the first, second and last documents specified in the `percolate` query
are matching with this query.

[discrete]
==== Percolating an Existing Document

In order to percolate a newly indexed document, the `percolate` query can be used. Based on the response
from an index request, the `_id` and other meta information can be used to immediately percolate the newly added
document.

[discrete]
===== Example

Based on the previous example.
Expand Down Expand Up @@ -332,14 +326,12 @@ case the search request would fail with a version conflict error.

The search response returned is identical as in the previous example.

[discrete]
==== Percolate query and highlighting

The `percolate` query is handled in a special way when it comes to highlighting. The queries hits are used
to highlight the document that is provided in the `percolate` query. Whereas with regular highlighting the query in
the search request is used to highlight the hits.

[discrete]
===== Example

This example is based on the mapping of the first example.
Expand Down Expand Up @@ -557,7 +549,6 @@ The slightly different response:
<1> The highlight fields have been prefixed with the document slot they belong to,
in order to know which highlight field belongs to what document.

[discrete]
==== Specifying multiple percolate queries

It is possible to specify multiple `percolate` queries in a single search request:
Expand Down Expand Up @@ -643,7 +634,6 @@ The above search request returns a response similar to this:
<1> The `_percolator_document_slot_query1` percolator slot field indicates that these matched slots are from the `percolate`
query with `_name` parameter set to `query1`.

[discrete]
[[how-it-works]]
==== How it Works Under the Hood

Expand Down Expand Up @@ -691,6 +681,7 @@ a different index configuration, like the number of primary shards.

[[percolate-query-notes]]
==== Notes

===== Allow expensive queries
Percolate queries will not be executed if <<query-dsl-allow-expensive-queries, `search.allow_expensive_queries`>>
is set to false.