Skip to content

Commit ec37a9c

Browse files
authored
[DOCS] Make Query DSL titles consistent (#43935)
1 parent e9620c2 commit ec37a9c

File tree

58 files changed

+310
-196
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+310
-196
lines changed

docs/reference/query-dsl.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,22 @@ Query clauses behave differently depending on whether they are used in
2929

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

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

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

36-
include::query-dsl/term-level-queries.asciidoc[]
37-
38-
include::query-dsl/compound-queries.asciidoc[]
36+
include::query-dsl/geo-queries.asciidoc[]
3937

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

42-
include::query-dsl/geo-queries.asciidoc[]
40+
include::query-dsl/match-all-query.asciidoc[]
41+
42+
include::query-dsl/span-queries.asciidoc[]
4343

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

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

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

50-
include::query-dsl/multi-term-rewrite.asciidoc[]
50+
include::query-dsl/multi-term-rewrite.asciidoc[]

docs/reference/query-dsl/bool-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-bool-query]]
2-
=== Bool Query
2+
=== Boolean query
3+
++++
4+
<titleabbrev>Boolean</titleabbrev>
5+
++++
36

47
A query that matches documents matching boolean combinations of other
58
queries. The bool query maps to Lucene `BooleanQuery`. It is built using

docs/reference/query-dsl/boosting-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-boosting-query]]
2-
=== Boosting Query
2+
=== Boosting query
3+
++++
4+
<titleabbrev>Boosting</titleabbrev>
5+
++++
36

47
Returns documents matching a `positive` query while reducing the
58
<<query-filter-context, relevance score>> of documents that also match a

docs/reference/query-dsl/compound-queries.asciidoc

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,34 @@ filter context.
77

88
The queries in this group are:
99

10-
<<query-dsl-constant-score-query,`constant_score` query>>::
11-
12-
A query which wraps another query, but executes it in filter context. All
13-
matching documents are given the same ``constant'' `_score`.
14-
1510
<<query-dsl-bool-query,`bool` query>>::
16-
1711
The default query for combining multiple leaf or compound query clauses, as
1812
`must`, `should`, `must_not`, or `filter` clauses. The `must` and `should`
1913
clauses have their scores combined -- the more matching clauses, the better --
2014
while the `must_not` and `filter` clauses are executed in filter context.
2115

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

20+
<<query-dsl-constant-score-query,`constant_score` query>>::
21+
A query which wraps another query, but executes it in filter context. All
22+
matching documents are given the same ``constant'' `_score`.
23+
24+
<<query-dsl-dis-max-query,`dis_max` query>>::
2425
A query which accepts multiple queries, and returns any documents which match
2526
any of the query clauses. While the `bool` query combines the scores from all
2627
matching queries, the `dis_max` query uses the score of the single best-
2728
matching query clause.
2829

2930
<<query-dsl-function-score-query,`function_score` query>>::
30-
3131
Modify the scores returned by the main query with functions to take into
3232
account factors like popularity, recency, distance, or custom algorithms
3333
implemented with scripting.
3434

35-
<<query-dsl-boosting-query,`boosting` query>>::
36-
37-
Return documents which match a `positive` query, but reduce the score of
38-
documents which also match a `negative` query.
39-
4035

41-
include::constant-score-query.asciidoc[]
4236
include::bool-query.asciidoc[]
43-
include::dis-max-query.asciidoc[]
44-
include::function-score-query.asciidoc[]
4537
include::boosting-query.asciidoc[]
38+
include::constant-score-query.asciidoc[]
39+
include::dis-max-query.asciidoc[]
40+
include::function-score-query.asciidoc[]

docs/reference/query-dsl/constant-score-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-constant-score-query]]
2-
=== Constant Score Query
2+
=== Constant score query
3+
++++
4+
<titleabbrev>Constant score</titleabbrev>
5+
++++
36

47
Wraps a <<query-dsl-bool-query, filter query>> and returns every matching
58
document with a <<query-filter-context, relevance score>> equal to the `boost`

docs/reference/query-dsl/dis-max-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-dis-max-query]]
2-
=== Disjunction Max Query
2+
=== Disjunction max query
3+
++++
4+
<titleabbrev>Disjunction max</titleabbrev>
5+
++++
36

47
Returns documents matching one or more wrapped queries, called query clauses or
58
clauses.

docs/reference/query-dsl/distance-feature-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-distance-feature-query]]
2-
=== Distance Feature Query
2+
=== Distance feature query
3+
++++
4+
<titleabbrev>Distance feature</titleabbrev>
5+
++++
36

47
The `distance_feature` query is a specialized query that only works
58
on <<date, `date`>>, <<date_nanos, `date_nanos`>> or <<geo-point,`geo_point`>>

docs/reference/query-dsl/exists-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-exists-query]]
2-
=== Exists Query
2+
=== Exists query
3+
++++
4+
<titleabbrev>Exists</titleabbrev>
5+
++++
36

47
Returns documents that contain an indexed value for a field.
58

docs/reference/query-dsl/full-text-queries.asciidoc

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,56 +7,49 @@ the field during indexing.
77

88
The queries in this group are:
99

10+
<<query-dsl-intervals-query,`intervals` query>>::
11+
A full text query that allows fine-grained control of the ordering and
12+
proximity of matching terms.
13+
1014
<<query-dsl-match-query,`match` query>>::
15+
The standard query for performing full text queries, including fuzzy matching
16+
and phrase or proximity queries.
1117

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

1522
<<query-dsl-match-query-phrase,`match_phrase` query>>::
16-
17-
Like the `match` query but used for matching exact phrases or word proximity matches.
23+
Like the `match` query but used for matching exact phrases or word proximity matches.
1824

1925
<<query-dsl-match-query-phrase-prefix,`match_phrase_prefix` query>>::
20-
21-
Like the `match_phrase` query, but does a wildcard search on the final word.
22-
23-
<<query-dsl-match-bool-prefix-query,`match_bool_prefix` query>>::
24-
25-
Creates a `bool` query that matches each term as a `term` query, except for
26-
the last term, which is matched as a `prefix` query
27-
26+
Like the `match_phrase` query, but does a wildcard search on the final word.
27+
2828
<<query-dsl-multi-match-query,`multi_match` query>>::
29-
30-
The multi-field version of the `match` query.
29+
The multi-field version of the `match` query.
3130

3231
<<query-dsl-query-string-query,`query_string` query>>::
33-
34-
Supports the compact Lucene <<query-string-syntax,query string syntax>>,
35-
allowing you to specify AND|OR|NOT conditions and multi-field search
36-
within a single query string. For expert users only.
32+
Supports the compact Lucene <<query-string-syntax,query string syntax>>,
33+
allowing you to specify AND|OR|NOT conditions and multi-field search
34+
within a single query string. For expert users only.
3735

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

40-
A simpler, more robust version of the `query_string` syntax suitable
41-
for exposing directly to users.
42-
43-
<<query-dsl-intervals-query,`intervals` query>>::
4440

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

4843
include::match-query.asciidoc[]
4944

45+
include::match-bool-prefix-query.asciidoc[]
46+
5047
include::match-phrase-query.asciidoc[]
5148

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

54-
include::match-bool-prefix-query.asciidoc[]
55-
5651
include::multi-match-query.asciidoc[]
5752

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

60-
include::simple-query-string-query.asciidoc[]
61-
62-
include::intervals-query.asciidoc[]
55+
include::simple-query-string-query.asciidoc[]

docs/reference/query-dsl/function-score-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-function-score-query]]
2-
=== Function Score Query
2+
=== Function score query
3+
++++
4+
<titleabbrev>Function score</titleabbrev>
5+
++++
36

47
The `function_score` allows you to modify the score of documents that are
58
retrieved by a query. This can be useful if, for example, a score

docs/reference/query-dsl/fuzzy-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-fuzzy-query]]
2-
=== Fuzzy Query
2+
=== Fuzzy query
3+
++++
4+
<titleabbrev>Fuzzy</titleabbrev>
5+
++++
36

47
The fuzzy query uses similarity based on Levenshtein edit distance.
58

docs/reference/query-dsl/geo-bounding-box-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-geo-bounding-box-query]]
2-
=== Geo Bounding Box Query
2+
=== Geo-bounding box query
3+
++++
4+
<titleabbrev>Geo-bounding box</titleabbrev>
5+
++++
36

47
A query allowing to filter hits based on a point location using a
58
bounding box. Assuming the following indexed document:

docs/reference/query-dsl/geo-distance-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-geo-distance-query]]
2-
=== Geo Distance Query
2+
=== Geo-distance query
3+
++++
4+
<titleabbrev>Geo-distance</titleabbrev>
5+
++++
36

47
Filters documents that include only hits that exists within a specific
58
distance from a geo point. Assuming the following mapping and indexed

docs/reference/query-dsl/geo-polygon-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-geo-polygon-query]]
2-
=== Geo Polygon Query
2+
=== Geo-polygon query
3+
++++
4+
<titleabbrev>Geo-polygon</titleabbrev>
5+
++++
36

47
A query returning hits that only fall within a polygon of
58
points. Here is an example:

docs/reference/query-dsl/geo-queries.asciidoc

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,24 @@ lines, circles, polygons, multi-polygons, etc.
88

99
The queries in this group are:
1010

11-
<<query-dsl-geo-shape-query,`geo_shape`>> query::
12-
13-
Finds documents with geo-shapes which either intersect, are contained by, or
14-
do not intersect with the specified geo-shape.
15-
1611
<<query-dsl-geo-bounding-box-query,`geo_bounding_box`>> query::
17-
18-
Finds documents with geo-points that fall into the specified rectangle.
12+
Finds documents with geo-points that fall into the specified rectangle.
1913

2014
<<query-dsl-geo-distance-query,`geo_distance`>> query::
21-
22-
Finds documents with geo-points within the specified distance of a central
23-
point.
15+
Finds documents with geo-points within the specified distance of a central point.
2416

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

27-
Find documents with geo-points within the specified polygon.
28-
20+
<<query-dsl-geo-shape-query,`geo_shape`>> query::
21+
Finds documents with geo-shapes which either intersect, are contained by, or do not intersect with the specified
22+
geo-shape.
2923

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

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

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

3629
include::geo-polygon-query.asciidoc[]
30+
31+
include::geo-shape-query.asciidoc[]

docs/reference/query-dsl/geo-shape-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-geo-shape-query]]
2-
=== GeoShape Query
2+
=== Geo-shape query
3+
++++
4+
<titleabbrev>Geo-shape</titleabbrev>
5+
++++
36

47
Filter documents indexed using the `geo_shape` type.
58

docs/reference/query-dsl/has-child-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-has-child-query]]
2-
=== Has Child Query
2+
=== Has child query
3+
++++
4+
<titleabbrev>Has child</titleabbrev>
5+
++++
36

47
Returns parent documents whose <<parent-join,joined>> child documents match a
58
provided query. You can create parent-child relationships between documents in

docs/reference/query-dsl/has-parent-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-has-parent-query]]
2-
=== Has Parent Query
2+
=== Has parent query
3+
++++
4+
<titleabbrev>Has parent</titleabbrev>
5+
++++
36

47
The `has_parent` query accepts a query and a parent type. The query is
58
executed in the parent document space, which is specified by the parent

docs/reference/query-dsl/ids-query.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
[[query-dsl-ids-query]]
2-
=== Ids Query
2+
=== IDs
3+
++++
4+
<titleabbrev>IDs</titleabbrev>
5+
++++
6+
37
Returns documents based on their IDs. This query uses document IDs stored in
48
the <<mapping-id-field,`_id`>> field.
59

docs/reference/query-dsl/intervals-query.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-intervals-query]]
22
=== Intervals query
3+
++++
4+
<titleabbrev>Intervals</titleabbrev>
5+
++++
36

47
An `intervals` query allows fine-grained control over the order and proximity of
58
matching terms. Matching rules are constructed from a small set of definitions,

docs/reference/query-dsl/joining-queries.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@ prohibitively expensive. Instead, Elasticsearch offers two forms of join
66
which are designed to scale horizontally.
77

88
<<query-dsl-nested-query,`nested` query>>::
9-
109
Documents may contain fields of type <<nested,`nested`>>. These
1110
fields are used to index arrays of objects, where each object can be queried
1211
(with the `nested` query) as an independent document.
1312

1413
<<query-dsl-has-child-query,`has_child`>> and <<query-dsl-has-parent-query,`has_parent`>> queries::
15-
1614
A <<parent-join,`join` field relationship>> can exist between
1715
documents within a single index. The `has_child` query returns parent
1816
documents whose child documents match the specified query, while the

docs/reference/query-dsl/match-all-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-match-all-query]]
2-
== Match All Query
2+
== Match all query
3+
++++
4+
<titleabbrev>Match all</titleabbrev>
5+
++++
36

47
The most simple query, which matches all documents, giving them all a `_score`
58
of `1.0`.

docs/reference/query-dsl/match-bool-prefix-query.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[query-dsl-match-bool-prefix-query]]
2-
=== Match Bool Prefix Query
2+
=== Match boolean prefix query
3+
++++
4+
<titleabbrev>Match boolean prefix</titleabbrev>
5+
++++
36

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

0 commit comments

Comments
 (0)