Skip to content

[DOCS] Make Query DSL titles consistent #43935

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.

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

Merged
merged 3 commits into from
Jul 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions docs/reference/query-dsl.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,22 @@ Query clauses behave differently depending on whether they are used in

include::query-dsl/query_filter_context.asciidoc[]

include::query-dsl/match-all-query.asciidoc[]
include::query-dsl/compound-queries.asciidoc[]

include::query-dsl/full-text-queries.asciidoc[]

include::query-dsl/term-level-queries.asciidoc[]

include::query-dsl/compound-queries.asciidoc[]
include::query-dsl/geo-queries.asciidoc[]

include::query-dsl/joining-queries.asciidoc[]

include::query-dsl/geo-queries.asciidoc[]
include::query-dsl/match-all-query.asciidoc[]

include::query-dsl/span-queries.asciidoc[]

include::query-dsl/special-queries.asciidoc[]

include::query-dsl/span-queries.asciidoc[]
include::query-dsl/term-level-queries.asciidoc[]

include::query-dsl/minimum-should-match.asciidoc[]

include::query-dsl/multi-term-rewrite.asciidoc[]
include::query-dsl/multi-term-rewrite.asciidoc[]
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/bool-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-bool-query]]
=== Bool Query
=== Boolean query
++++
<titleabbrev>Boolean</titleabbrev>
++++

A query that matches documents matching boolean combinations of other
queries. The bool query maps to Lucene `BooleanQuery`. It is built using
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/boosting-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-boosting-query]]
=== Boosting Query
=== Boosting query
++++
<titleabbrev>Boosting</titleabbrev>
++++

Returns documents matching a `positive` query while reducing the
<<query-filter-context, relevance score>> of documents that also match a
Expand Down
27 changes: 11 additions & 16 deletions docs/reference/query-dsl/compound-queries.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,34 @@ filter context.

The queries in this group are:

<<query-dsl-constant-score-query,`constant_score` query>>::

A query which wraps another query, but executes it in filter context. All
matching documents are given the same ``constant'' `_score`.

<<query-dsl-bool-query,`bool` query>>::

The default query for combining multiple leaf or compound query clauses, as
`must`, `should`, `must_not`, or `filter` clauses. The `must` and `should`
clauses have their scores combined -- the more matching clauses, the better --
while the `must_not` and `filter` clauses are executed in filter context.

<<query-dsl-dis-max-query,`dis_max` query>>::
<<query-dsl-boosting-query,`boosting` query>>::
Return documents which match a `positive` query, but reduce the score of
documents which also match a `negative` query.

<<query-dsl-constant-score-query,`constant_score` query>>::
A query which wraps another query, but executes it in filter context. All
matching documents are given the same ``constant'' `_score`.

<<query-dsl-dis-max-query,`dis_max` query>>::
A query which accepts multiple queries, and returns any documents which match
any of the query clauses. While the `bool` query combines the scores from all
matching queries, the `dis_max` query uses the score of the single best-
matching query clause.

<<query-dsl-function-score-query,`function_score` query>>::

Modify the scores returned by the main query with functions to take into
account factors like popularity, recency, distance, or custom algorithms
implemented with scripting.

<<query-dsl-boosting-query,`boosting` query>>::

Return documents which match a `positive` query, but reduce the score of
documents which also match a `negative` query.


include::constant-score-query.asciidoc[]
include::bool-query.asciidoc[]
include::dis-max-query.asciidoc[]
include::function-score-query.asciidoc[]
include::boosting-query.asciidoc[]
include::constant-score-query.asciidoc[]
include::dis-max-query.asciidoc[]
include::function-score-query.asciidoc[]
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/constant-score-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-constant-score-query]]
=== Constant Score Query
=== Constant score query
++++
<titleabbrev>Constant score</titleabbrev>
++++

Wraps a <<query-dsl-bool-query, filter query>> and returns every matching
document with a <<query-filter-context, relevance score>> equal to the `boost`
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/dis-max-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-dis-max-query]]
=== Disjunction Max Query
=== Disjunction max query
++++
<titleabbrev>Disjunction max</titleabbrev>
++++

Returns documents matching one or more wrapped queries, called query clauses or
clauses.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/distance-feature-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-distance-feature-query]]
=== Distance Feature Query
=== Distance feature query
++++
<titleabbrev>Distance feature</titleabbrev>
++++

The `distance_feature` query is a specialized query that only works
on <<date, `date`>>, <<date_nanos, `date_nanos`>> or <<geo-point,`geo_point`>>
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/exists-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-exists-query]]
=== Exists Query
=== Exists query
++++
<titleabbrev>Exists</titleabbrev>
++++

Returns documents that contain an indexed value for a field.

Expand Down
51 changes: 22 additions & 29 deletions docs/reference/query-dsl/full-text-queries.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,56 +7,49 @@ the field during indexing.

The queries in this group are:

<<query-dsl-intervals-query,`intervals` query>>::
A full text query that allows fine-grained control of the ordering and
proximity of matching terms.

<<query-dsl-match-query,`match` query>>::
The standard query for performing full text queries, including fuzzy matching
and phrase or proximity queries.

The standard query for performing full text queries, including fuzzy matching
and phrase or proximity queries.
<<query-dsl-match-bool-prefix-query,`match_bool_prefix` query>>::
Creates a `bool` query that matches each term as a `term` query, except for
the last term, which is matched as a `prefix` query

<<query-dsl-match-query-phrase,`match_phrase` query>>::

Like the `match` query but used for matching exact phrases or word proximity matches.
Like the `match` query but used for matching exact phrases or word proximity matches.

<<query-dsl-match-query-phrase-prefix,`match_phrase_prefix` query>>::

Like the `match_phrase` query, but does a wildcard search on the final word.

<<query-dsl-match-bool-prefix-query,`match_bool_prefix` query>>::

Creates a `bool` query that matches each term as a `term` query, except for
the last term, which is matched as a `prefix` query

Like the `match_phrase` query, but does a wildcard search on the final word.

<<query-dsl-multi-match-query,`multi_match` query>>::

The multi-field version of the `match` query.
The multi-field version of the `match` query.

<<query-dsl-query-string-query,`query_string` query>>::

Supports the compact Lucene <<query-string-syntax,query string syntax>>,
allowing you to specify AND|OR|NOT conditions and multi-field search
within a single query string. For expert users only.
Supports the compact Lucene <<query-string-syntax,query string syntax>>,
allowing you to specify AND|OR|NOT conditions and multi-field search
within a single query string. For expert users only.

<<query-dsl-simple-query-string-query,`simple_query_string` query>>::
A simpler, more robust version of the `query_string` syntax suitable
for exposing directly to users.

A simpler, more robust version of the `query_string` syntax suitable
for exposing directly to users.

<<query-dsl-intervals-query,`intervals` query>>::

A full text query that allows fine-grained control of the ordering and
proximity of matching terms
include::intervals-query.asciidoc[]

include::match-query.asciidoc[]

include::match-bool-prefix-query.asciidoc[]

include::match-phrase-query.asciidoc[]

include::match-phrase-prefix-query.asciidoc[]

include::match-bool-prefix-query.asciidoc[]

include::multi-match-query.asciidoc[]

include::query-string-query.asciidoc[]

include::simple-query-string-query.asciidoc[]

include::intervals-query.asciidoc[]
include::simple-query-string-query.asciidoc[]
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/function-score-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-function-score-query]]
=== Function Score Query
=== Function score query
++++
<titleabbrev>Function score</titleabbrev>
++++

The `function_score` allows you to modify the score of documents that are
retrieved by a query. This can be useful if, for example, a score
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/fuzzy-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-fuzzy-query]]
=== Fuzzy Query
=== Fuzzy query
++++
<titleabbrev>Fuzzy</titleabbrev>
++++

The fuzzy query uses similarity based on Levenshtein edit distance.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/geo-bounding-box-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-geo-bounding-box-query]]
=== Geo Bounding Box Query
=== Geo-bounding box query
++++
<titleabbrev>Geo-bounding box</titleabbrev>
++++

A query allowing to filter hits based on a point location using a
bounding box. Assuming the following indexed document:
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/geo-distance-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-geo-distance-query]]
=== Geo Distance Query
=== Geo-distance query
++++
<titleabbrev>Geo-distance</titleabbrev>
++++

Filters documents that include only hits that exists within a specific
distance from a geo point. Assuming the following mapping and indexed
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/geo-polygon-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-geo-polygon-query]]
=== Geo Polygon Query
=== Geo-polygon query
++++
<titleabbrev>Geo-polygon</titleabbrev>
++++

A query returning hits that only fall within a polygon of
points. Here is an example:
Expand Down
21 changes: 8 additions & 13 deletions docs/reference/query-dsl/geo-queries.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,24 @@ lines, circles, polygons, multi-polygons, etc.

The queries in this group are:

<<query-dsl-geo-shape-query,`geo_shape`>> query::

Finds documents with geo-shapes which either intersect, are contained by, or
do not intersect with the specified geo-shape.

<<query-dsl-geo-bounding-box-query,`geo_bounding_box`>> query::

Finds documents with geo-points that fall into the specified rectangle.
Finds documents with geo-points that fall into the specified rectangle.

<<query-dsl-geo-distance-query,`geo_distance`>> query::

Finds documents with geo-points within the specified distance of a central
point.
Finds documents with geo-points within the specified distance of a central point.

<<query-dsl-geo-polygon-query,`geo_polygon`>> query::
Find documents with geo-points within the specified polygon.

Find documents with geo-points within the specified polygon.

<<query-dsl-geo-shape-query,`geo_shape`>> query::
Finds documents with geo-shapes which either intersect, are contained by, or do not intersect with the specified
geo-shape.

include::geo-shape-query.asciidoc[]

include::geo-bounding-box-query.asciidoc[]

include::geo-distance-query.asciidoc[]

include::geo-polygon-query.asciidoc[]

include::geo-shape-query.asciidoc[]
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/geo-shape-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-geo-shape-query]]
=== GeoShape Query
=== Geo-shape query
++++
<titleabbrev>Geo-shape</titleabbrev>
++++

Filter documents indexed using the `geo_shape` type.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/has-child-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-has-child-query]]
=== Has Child Query
=== Has child query
++++
<titleabbrev>Has child</titleabbrev>
++++

The `has_child` filter accepts a query and the child type to run against, and
results in parent documents that have child docs matching the query. Here is
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/has-parent-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-has-parent-query]]
=== Has Parent Query
=== Has parent query
++++
<titleabbrev>Has parent</titleabbrev>
++++

The `has_parent` query accepts a query and a parent type. The query is
executed in the parent document space, which is specified by the parent
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/query-dsl/ids-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
[[query-dsl-ids-query]]
=== Ids Query
=== IDs
++++
<titleabbrev>IDs</titleabbrev>
++++

Returns documents based on their IDs. This query uses document IDs stored in
the <<mapping-id-field,`_id`>> field.

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/query-dsl/intervals-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-intervals-query]]
=== Intervals query
++++
<titleabbrev>Intervals</titleabbrev>
++++

An `intervals` query allows fine-grained control over the order and proximity of
matching terms. Matching rules are constructed from a small set of definitions,
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/query-dsl/joining-queries.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ prohibitively expensive. Instead, Elasticsearch offers two forms of join
which are designed to scale horizontally.

<<query-dsl-nested-query,`nested` query>>::

Documents may contain fields of type <<nested,`nested`>>. These
fields are used to index arrays of objects, where each object can be queried
(with the `nested` query) as an independent document.

<<query-dsl-has-child-query,`has_child`>> and <<query-dsl-has-parent-query,`has_parent`>> queries::

A <<parent-join,`join` field relationship>> can exist between
documents within a single index. The `has_child` query returns parent
documents whose child documents match the specified query, while the
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/match-all-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-match-all-query]]
== Match All Query
== Match all query
++++
<titleabbrev>Match all</titleabbrev>
++++

The most simple query, which matches all documents, giving them all a `_score`
of `1.0`.
Expand Down
5 changes: 4 additions & 1 deletion docs/reference/query-dsl/match-bool-prefix-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[query-dsl-match-bool-prefix-query]]
=== Match Bool Prefix Query
=== Match boolean prefix query
++++
<titleabbrev>Match boolean prefix</titleabbrev>
++++

A `match_bool_prefix` query analyzes its input and constructs a
<<query-dsl-bool-query,`bool` query>> from the terms. Each term except the last
Expand Down
Loading