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

28 lines
616 B
Plaintext

[[query-dsl-ids-query]]
=== Ids Query
Returns documents based on their IDs. This query uses document IDs stored in
the <<mapping-id-field,`_id`>> field.
==== Example request
[source,js]
--------------------------------------------------
GET /_search
{
"query": {
"ids" : {
"values" : ["1", "4", "100"]
}
}
}
--------------------------------------------------
// CONSOLE
[[ids-query-top-level-parameters]]
==== Top-level parameters for `ids`
[cols="v,v",options="header"]
|======
|Parameter |Description
|`values` |An array of <<mapping-id-field, document IDs>>.
|======