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

[[query-dsl-indices-query]]
=== Indices Query

deprecated[5.0.0, Search on the '_index' field instead]

The `indices` query is useful in cases where a search is executed across
multiple indices. It allows to specify a list of index names and an inner
query that is only executed for indices matching names on that list.
For other indices that are searched, but that don't match entries
on the list, the alternative `no_match_query` is executed.

[source,js]
--------------------------------------------------
GET /_search
{
    "query": {
        "indices" : {
            "indices" : ["index1", "index2"],
            "query" : { "term" : { "tag" : "wow" } },
            "no_match_query" : { "term" : { "tag" : "kow" } }
        }
    }
}
--------------------------------------------------
// CONSOLE
// TEST[warning:indices query is deprecated. Instead search on the '_index' field]

You can use the `index` field to provide a single index.

`no_match_query` can also have "string" value of `none` (to match no
documents), and `all` (to match all). Defaults to `all`.

`query` is mandatory, as well as `indices` (or `index`).
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`[[query-dsl-indices-query]]`
Docs: Reorganised the Query DSL docs into families and explaing query vs filter context 2015-06-03 19:59:22 -04:00			`=== Indices Query`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Fail yaml tests and docs snippets that get unexpected warnings Adds `warnings` syntax to the yaml test that allows you to expect a `Warning` header that looks like: ``` - do: warnings: - '[index] is deprecated' - quotes are not required because yaml - but this argument is always a list, never a single string - no matter how many warnings you expect get: index: test type: test id: 1 ``` These are accessible from the docs with: ``` // TEST[warning:some warning] ``` This should help to force you to update the docs if you deprecate something. You must add the warnings marker to the docs or the build will fail. While you are there you should update the docs to add deprecation warnings visible in the rendered results. 2016-08-02 17:35:31 -04:00			`deprecated[5.0.0, Search on the '_index' field instead]`

Update indices-query.asciidoc The current description of the query seemed confusing to some people (e.g. https://twitter.com/wielinde/status/654582620630687744), this is just a proposal to simplify it. 2015-10-23 15:14:52 -04:00			The `indices` query is useful in cases where a search is executed across
			`multiple indices. It allows to specify a list of index names and an inner`
			`query that is only executed for indices matching names on that list.`
			`For other indices that are searched, but that don't match entries`
Update indices-query.asciidoc 2015-10-23 16:55:40 -04:00			on the list, the alternative `no_match_query` is executed.
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": {`
			`"indices" : {`
			`"indices" : ["index1", "index2"],`
			`"query" : { "term" : { "tag" : "wow" } },`
			`"no_match_query" : { "term" : { "tag" : "kow" } }`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`}`
			`}`
			`}`
			`--------------------------------------------------`
Fail yaml tests and docs snippets that get unexpected warnings Adds `warnings` syntax to the yaml test that allows you to expect a `Warning` header that looks like: ``` - do: warnings: - '[index] is deprecated' - quotes are not required because yaml - but this argument is always a list, never a single string - no matter how many warnings you expect get: index: test type: test id: 1 ``` These are accessible from the docs with: ``` // TEST[warning:some warning] ``` This should help to force you to update the docs if you deprecate something. You must add the warnings marker to the docs or the build will fail. While you are there you should update the docs to add deprecation warnings visible in the rendered results. 2016-08-02 17:35:31 -04:00			`// CONSOLE`
			`// TEST[warning:indices query is deprecated. Instead search on the '_index' field]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Indices query/filter skip parsing altogether for irrelevant indices when possible Closes #2416 2013-11-06 09:52:29 -05:00			You can use the `index` field to provide a single index.

Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`no_match_query` can also have "string" value of `none` (to match no
Indices query/filter skip parsing altogether for irrelevant indices when possible Closes #2416 2013-11-06 09:52:29 -05:00			documents), and `all` (to match all). Defaults to `all`.

Minor improvements to indices filter and query & updated docs Slightly simplified indices filter and query parsers code Trimmed down tests where possible 2013-11-14 09:53:13 -05:00			`query` is mandatory, as well as `indices` (or `index`).