OpenSearch/docs/reference/query-dsl
Jim Ferenczi 18866c4c0b
Make hits.total an object in the search response (#35849)
This commit changes the format of the `hits.total` in the search response to be an object with
a `value` and a `relation`. The `value` indicates the number of hits that match the query and the
`relation` indicates whether the number is accurate (in which case the relation is equals to `eq`)
or a lower bound of the total (in which case it is equals to `gte`).
This change also adds a parameter called `rest_total_hits_as_int` that can be used in the
search APIs to opt out from this change (retrieve the total hits as a number in the rest response).
Note that currently all search responses are accurate (`track_total_hits: true`) or they don't contain
`hits.total` (`track_total_hits: true`). We'll add a way to get a lower bound of the total hits in a
follow up (to allow numbers to be passed to `track_total_hits`).

Relates #33028
2018-12-05 19:49:06 +01:00
..
bool-query.asciidoc Remove the distinction between query and filter context in QueryBuilders (#35354) 2018-12-03 11:49:11 +01:00
boosting-query.asciidoc [Doc] Add clarification to boolean query (#32575) 2018-11-16 11:45:32 +09:00
common-terms-query.asciidoc Remove redundant 'minimum_should_match' 2018-06-27 10:11:07 +02:00
compound-queries.asciidoc Remove indices query (#21837) 2016-11-30 19:37:01 +01:00
constant-score-query.asciidoc Docs: Added link from bool and constant score query to filter context 2016-12-29 11:05:28 +01:00
dis-max-query.asciidoc Indentation error on example of dist_max (#22578) 2017-01-12 09:38:36 +01:00
exists-query.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
feature-query.asciidoc Add a `feature_vector` field. (#31102) 2018-06-07 10:05:37 +02:00
full-text-queries.asciidoc Unify headers for full text queries 2018-06-27 10:11:14 +02:00
function-score-query.asciidoc Forbid negative scores in functon_score query (#35709) 2018-11-22 06:08:48 -05:00
fuzzy-query.asciidoc Update Fuzzy Query docs to clarify default behavior re max_expansions (#30819) 2018-07-30 13:19:26 -07:00
geo-bounding-box-query.asciidoc Use geohash cell instead of just a corner in geo_bounding_box (#30698) 2018-05-24 14:46:15 -04:00
geo-distance-query.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
geo-polygon-query.asciidoc [Docs] Minor formatting and wording fixes (#35278) 2018-11-06 07:52:13 +01:00
geo-queries.asciidoc Minor corrections in geo-queries.asciidoc (#34314) 2018-10-05 17:12:18 +02:00
geo-shape-query.asciidoc Add support for indexed shape routing in geo_shape query (#30760) 2018-05-23 15:15:19 -04:00
has-child-query.asciidoc Improve wording 2018-02-15 15:31:00 +00:00
has-parent-query.asciidoc docs: describe parent/child performances 2017-10-26 11:49:13 +02:00
ids-query.asciidoc Remove legacy mapping code. (#29224) 2018-04-11 09:41:37 +02:00
joining-queries.asciidoc Remove usage of multi-types from the docs and added a page explaining type removal (#25543) 2017-07-05 12:30:19 +02:00
match-all-query.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
match-phrase-prefix-query.asciidoc Correct some spelling in match-phrase-prefix docs (#24956) 2017-05-30 09:02:01 -04:00
match-phrase-query.asciidoc Add support to match_phrase query for zero_terms_query. (#29598) 2018-04-19 11:25:27 -07:00
match-query.asciidoc [Docs] Update match-query.asciidoc (#33610) 2018-09-12 14:35:27 +02:00
minimum-should-match.asciidoc Query DSL: Remove filter parsers. 2015-05-07 20:14:34 +02:00
mlt-query.asciidoc [DOCS] Removed and params from MLT. Closes #28128 (#31370) 2018-06-19 13:48:13 -07:00
multi-match-query.asciidoc Make limit on number of expanded fields configurable (#35284) 2018-11-08 17:04:40 +01:00
multi-term-rewrite.asciidoc Remove parse field deprecations in query builders (#26711) 2017-09-20 16:22:21 +02:00
nested-query.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
parent-id-query.asciidoc Allow `_doc` as a type. (#27816) 2017-12-14 17:47:53 +01:00
percolate-query.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
prefix-query.asciidoc Remove parse field deprecations in query builders (#26711) 2017-09-20 16:22:21 +02:00
query-string-query.asciidoc Add `minimum_should_match` section to the query_string docs 2018-11-30 16:10:13 +01:00
query-string-syntax.asciidoc Fix docs build. 2018-06-05 14:55:40 +02:00
query_filter_context.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
range-query.asciidoc Docs: Add section about range query for range type (#35222) 2018-11-06 10:49:12 -05:00
regexp-query.asciidoc Reject regex search if regex string is too long (#28542) 2018-02-23 10:41:24 -08:00
regexp-syntax.asciidoc Update regexp-syntax.asciidoc (#20973) 2016-10-17 16:32:17 +02:00
script-query.asciidoc [Docs] Fix filter context in script-query.asciidoc (#35677) 2018-11-19 16:30:33 +01:00
script-score-query.asciidoc Add a new query type - ScriptScoreQuery (#34533) 2018-11-20 16:10:06 -05:00
simple-query-string-query.asciidoc Make limit on number of expanded fields configurable (#35284) 2018-11-08 17:04:40 +01:00
span-containing-query.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
span-field-masking-query.asciidoc Documentation for field_masking_span query (#20395) 2016-09-13 12:27:33 +01:00
span-first-query.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
span-multi-term-query.asciidoc Improve docs for index_prefixes option (#35778) 2018-11-22 09:20:46 +00:00
span-near-query.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
span-not-query.asciidoc [Docs]Corrected spelling errors. (#28976) 2018-03-19 10:22:40 -07:00
span-or-query.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
span-queries.asciidoc Throw a parsing exception when boost is set in span_or query (#28390) (#34112) 2018-11-26 12:15:59 -05:00
span-term-query.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
span-within-query.asciidoc Add back doc execution to query dsl. 2016-05-24 12:43:41 +02:00
special-queries.asciidoc Expose Lucene's FeatureField. (#30618) 2018-05-23 08:55:21 +02:00
term-level-queries.asciidoc [Docs] Add term query with normalizer example 2018-05-03 10:23:14 +02:00
term-query.asciidoc Documents applicability of term query to range type (#28166) 2018-01-18 17:19:01 -05:00
terms-query.asciidoc Fixed typo in search for wrong type (#28645) 2018-02-13 02:47:01 -05:00
terms-set-query.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
type-query.asciidoc Add a deprecation warning in the type query documentation. (#34017) 2018-09-24 16:30:38 -07:00
wildcard-query.asciidoc Update wildcard-query.asciidoc (#20057) 2016-08-18 14:04:46 +02:00
wrapper-query.asciidoc added docs for `wrapper` query. 2018-03-14 11:51:22 +01:00