Skip to content

[8.16] [DOCS] Count API: clarify ways to specify search query (#120564) #120681

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

Merged
merged 1 commit into from
Jan 22, 2025
Merged

[8.16] [DOCS] Count API: clarify ways to specify search query (#120564) #120681

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/reference/rest-api/common-parms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ end::search-q[]

tag::query[]
`query`::
(Optional, <<query-dsl,query object>>) Defines the search definition using the
(Optional, <<query-dsl,query object>>) Defines the search query using
<<query-dsl,Query DSL>>.
end::query[]

Expand Down
19 changes: 10 additions & 9 deletions docs/reference/search/count.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ GET /my-index-000001/_count?q=user:kimchy
--------------------------------------------------
// TEST[setup:my_index]

NOTE: The query being sent in the body must be nested in a `query` key, same as
the <<search-search,search API>> works.


[[search-count-api-request]]
==== {api-request-title}

Expand All @@ -33,9 +29,12 @@ or alias.
==== {api-description-title}

The count API allows you to execute a query and get the number of matches for
that query. The query can either
be provided using a simple query string as a parameter, or using the
<<query-dsl,Query DSL>> defined within the request body.
that query. You can provide the query by either:

* Including the <<search-count-api-query-params,`q` query string parameter>>
* Defining <<query-dsl,Query DSL>> within the <<search-count-request-body,request body>>

Using both returns an error.

The count API supports <<api-multi-index,multi-target syntax>>. You can run a single
count API search across multiple data streams and indices.
Expand Down Expand Up @@ -86,6 +85,8 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=lenient]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=preference]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=search-q]
+
NOTE: If the `q` parameter is specified, the count API does not accept a <<search-count-request-body,request body>>.

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]

Expand Down Expand Up @@ -134,5 +135,5 @@ Both examples above do the same: count the number of documents in
}
--------------------------------------------------

The query is optional, and when not provided, it will use `match_all` to
count all the docs.
The query is optional. When no query is provided, the API uses <<query-dsl-match-all-query,`match_all`>> to
count all the documents.
Loading