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

[[query-dsl-ids-query]]
=== Ids Query

Filters documents that only have the provided ids. Note, this query
uses the <<mapping-uid-field,_uid>> field.

[source,js]
--------------------------------------------------
GET /_search
{
    "query": {
        "ids" : {
            "type" : "_doc",
            "values" : ["1", "4", "100"]
        }
    }
}    
--------------------------------------------------
// CONSOLE

The `type` is optional and can be omitted, and can also accept an array
of values. If no type is specified, all types defined in the index mapping are tried.
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`[[query-dsl-ids-query]]`
Docs: Reorganised the Query DSL docs into families and explaing query vs filter context 2015-06-03 19:59:22 -04:00			`=== Ids Query`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Query DSL: Remove filter parsers. This commit makes queries and filters parsed the same way using the QueryParser abstraction. This allowed to remove duplicate code that we had for similar queries/filters such as `range`, `prefix` or `term`. 2015-05-05 02:27:52 -04:00			`Filters documents that only have the provided ids. Note, this query`
Docs: Cleanup meta field docs Meta fields were locked down to not allow exotic options to the underlying field types in #8143. This change fixes the docs to no longer refer to the old settings. closes #10879 2015-04-30 18:01:35 -04:00			`uses the <<mapping-uid-field,_uid>> field.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			`[source,js]`
			`--------------------------------------------------`
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1. 2016-05-24 05:58:43 -04:00			`GET /_search`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`{`
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1. 2016-05-24 05:58:43 -04:00			`"query": {`
			`"ids" : {`
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			`"type" : "_doc",`
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1. 2016-05-24 05:58:43 -04:00			`"values" : ["1", "4", "100"]`
			`}`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`}`
			`}`
			`--------------------------------------------------`
Add back doc execution to query dsl. Relates to #18211 This reverts commit 20aafb1196192d4f9f7faea8ce9a36b278e501a1. 2016-05-24 05:58:43 -04:00			`// CONSOLE`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			The `type` is optional and can be omitted, and can also accept an array
Docs: Cleanup meta field docs Meta fields were locked down to not allow exotic options to the underlying field types in #8143. This change fixes the docs to no longer refer to the old settings. closes #10879 2015-04-30 18:01:35 -04:00			`of values. If no type is specified, all types defined in the index mapping are tried.`