mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
da89ff87bb
Changes: * Removes narrative around URI searches. These aren't commonly used in production. The `q` param is already covered in the search API docs: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html#search-api-query-params-q * Adds a common options section that highlights narrative docs for query DSL, aggregations, multi-index search, search fields, pagination, sorting, and async search. * Adds a `Search shard routing` page. Moves narrative docs for adaptive replica selection, preference, routing , and shard limits to that section. * Moves search timeout and cancellation content to the `Search your data` page. * Creates a `Search multiple data streams and indices` page. Moves related narrative docs for multi-target syntax searches and `indices_boost` to that page. * Removes narrative examples for the `search_type` parameters. Moves documentation for this parameter to the search API docs.
83 lines
1.6 KiB
Plaintext
83 lines
1.6 KiB
Plaintext
[[search]]
|
|
== Search APIs
|
|
|
|
Search APIs are used to search and aggregate data stored in {es} indices and
|
|
data streams. For an overview and related tutorials, see <<search-your-data>>.
|
|
|
|
Most search APIs support <<multi-index,multi-target syntax>>, with the
|
|
exception of the <<search-explain,explain API>>.
|
|
|
|
[discrete]
|
|
[[core-search-apis]]
|
|
=== Core search
|
|
|
|
* <<search-search>>
|
|
* <<search-multi-search>>
|
|
* <<async-search>>
|
|
* <<scroll-api>>
|
|
* <<clear-scroll-api>>
|
|
* <<search-suggesters>>
|
|
|
|
[discrete]
|
|
[[search-testing-apis]]
|
|
=== Search testing
|
|
|
|
* <<search-explain>>
|
|
* <<search-field-caps>>
|
|
* <<search-profile>>
|
|
* <<search-rank-eval>>
|
|
* <<search-shards>>
|
|
* <<search-validate>>
|
|
|
|
[discrete]
|
|
[[search-template-apis]]
|
|
=== Search templates
|
|
|
|
* <<search-template>>
|
|
* <<multi-search-template>>
|
|
|
|
[discrete]
|
|
[[eql-search-apis]]
|
|
=== EQL search
|
|
|
|
For an overview of EQL and related tutorials, see <<eql>>.
|
|
|
|
* <<eql-search-api>>
|
|
* <<get-async-eql-search-api>>
|
|
* <<delete-async-eql-search-api>>
|
|
|
|
|
|
include::search/search.asciidoc[]
|
|
|
|
include::search/async-search.asciidoc[]
|
|
|
|
include::search/scroll-api.asciidoc[]
|
|
|
|
include::search/clear-scroll-api.asciidoc[]
|
|
|
|
include::search/search-template.asciidoc[]
|
|
|
|
include::search/search-shards.asciidoc[]
|
|
|
|
include::search/suggesters.asciidoc[]
|
|
|
|
include::search/multi-search.asciidoc[]
|
|
|
|
include::eql/eql-search-api.asciidoc[]
|
|
|
|
include::eql/get-async-eql-search-api.asciidoc[]
|
|
|
|
include::eql/delete-async-eql-search-api.asciidoc[]
|
|
|
|
include::search/count.asciidoc[]
|
|
|
|
include::search/validate.asciidoc[]
|
|
|
|
include::search/explain.asciidoc[]
|
|
|
|
include::search/profile.asciidoc[]
|
|
|
|
include::search/field-caps.asciidoc[]
|
|
|
|
include::search/rank-eval.asciidoc[]
|