OpenSearch/docs/reference/search/search.asciidoc

[[search-search]]
=== Search

The search API allows you to execute a search query and get back search hits
that match the query. The query can either be provided using a simple
<<search-uri-request,query string as a parameter>>, or using a
<<search-request-body,request body>>.

["float",id="search-multi-index"]
==== Multi-Index

All search APIs can be applied across multiple indices with support for
the <<multi-index,multi index syntax>>. For
example, we can search on all documents within the twitter index:

[source,js]
--------------------------------------------------
GET /twitter/_search?q=user:kimchy
--------------------------------------------------
// CONSOLE
// TEST[setup:twitter]

We can also search all documents with a certain tag across several indices
(for example, when there is one index per user):

[source,js]
--------------------------------------------------
GET /kimchy,elasticsearch/_search?q=tag:wow
--------------------------------------------------
// CONSOLE
// TEST[s/^/PUT kimchy\nPUT elasticsearch\n/]

Or we can search across all available indices using `_all`:

[source,js]
---------------------------------------------------
GET /_all/_search?q=tag:wow
---------------------------------------------------
// CONSOLE
// TEST[setup:twitter]

[float]
[[search-partial-responses]]
==== Partial responses
To ensure fast responses, the search API will respond with partial results if one or more shards fail. See <<shard-failures, Shard failures>> for more information.
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`[[search-search]]`
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case. 2019-07-19 14:35:36 -04:00			`=== Search`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Fix minor typo (#18222) 2016-05-10 03:39:42 -04:00			`The search API allows you to execute a search query and get back search hits`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`that match the query. The query can either be provided using a simple`
			`<<search-uri-request,query string as a parameter>>, or using a`
			`<<search-request-body,request body>>.`

Remove references to multiple types in the search documentation. (#34625) 2018-10-19 12:47:34 -04:00			`["float",id="search-multi-index"]`
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case. 2019-07-19 14:35:36 -04:00			`==== Multi-Index`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Remove references to multiple types in the search documentation. (#34625) 2018-10-19 12:47:34 -04:00			`All search APIs can be applied across multiple indices with support for`
			`the <<multi-index,multi index syntax>>. For`
Deprecate filtering on `_type`. (#29468) As indices are only allowed to have one type now, and types are going away in the future, we should deprecate filtering by `_type`. Relates #15613 2018-04-13 03:07:51 -04:00			`example, we can search on all documents within the twitter index:`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			`[source,js]`
			`--------------------------------------------------`
CONSOLEify some search docs * search/search.asciidoc * search/request-body.asciidoc * search/explain.asciidoc * search/search-shards.asciidoc 2016-09-14 11:23:25 -04:00			`GET /twitter/_search?q=user:kimchy`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`--------------------------------------------------`
CONSOLEify some search docs * search/search.asciidoc * search/request-body.asciidoc * search/explain.asciidoc * search/search-shards.asciidoc 2016-09-14 11:23:25 -04:00			`// CONSOLE`
			`// TEST[setup:twitter]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Remove references to multiple types in the search documentation. (#34625) 2018-10-19 12:47:34 -04:00			`We can also search all documents with a certain tag across several indices`
			`(for example, when there is one index per user):`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			`[source,js]`
			`--------------------------------------------------`
Allow `_doc` as a type. (#27816) Allowing `_doc` as a type will enable users to make the transition to 7.0 smoother since the index APIs will be `PUT index/_doc/id` and `POST index/_doc`. This also moves most of the documentation to `_doc` as a type name. Closes #27750 Closes #27751 2017-12-14 11:47:53 -05:00			`GET /kimchy,elasticsearch/_search?q=tag:wow`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`--------------------------------------------------`
CONSOLEify some search docs * search/search.asciidoc * search/request-body.asciidoc * search/explain.asciidoc * search/search-shards.asciidoc 2016-09-14 11:23:25 -04:00			`// CONSOLE`
			`// TEST[s/^/PUT kimchy\nPUT elasticsearch\n/]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Remove references to multiple types in the search documentation. (#34625) 2018-10-19 12:47:34 -04:00			Or we can search across all available indices using `_all`:
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			`[source,js]`
Remove references to multiple types in the search documentation. (#34625) 2018-10-19 12:47:34 -04:00			`---------------------------------------------------`
Allow `_doc` as a type. (#27816) Allowing `_doc` as a type will enable users to make the transition to 7.0 smoother since the index APIs will be `PUT index/_doc/id` and `POST index/_doc`. This also moves most of the documentation to `_doc` as a type name. Closes #27750 Closes #27751 2017-12-14 11:47:53 -05:00			`GET /_all/_search?q=tag:wow`
Remove references to multiple types in the search documentation. (#34625) 2018-10-19 12:47:34 -04:00			`---------------------------------------------------`
CONSOLEify some search docs * search/search.asciidoc * search/request-body.asciidoc * search/explain.asciidoc * search/search-shards.asciidoc 2016-09-14 11:23:25 -04:00			`// CONSOLE`
[DOCS] Document 200 http code response for partial results (#40367) 2019-04-29 08:28:03 -04:00			`// TEST[setup:twitter]`

			`[float]`
			`[[search-partial-responses]]`
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case. 2019-07-19 14:35:36 -04:00			`==== Partial responses`
[DOCS] Document 200 http code response for partial results (#40367) 2019-04-29 08:28:03 -04:00			`To ensure fast responses, the search API will respond with partial results if one or more shards fail. See <<shard-failures, Shard failures>> for more information.`