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

28 lines
584 B
Plaintext

[[query-dsl-ids-query]]
=== IDs
++++
<titleabbrev>IDs</titleabbrev>
++++
Returns documents based on their IDs. This query uses document IDs stored in
the <<mapping-id-field,`_id`>> field.
==== Example request
[source,console]
--------------------------------------------------
GET /_search
{
"query": {
"ids" : {
"values" : ["1", "4", "100"]
}
}
}
--------------------------------------------------
[[ids-query-top-level-parameters]]
==== Top-level parameters for `ids`
`values`::
(Required, array of strings) An array of <<mapping-id-field, document IDs>>.