Skip to content

Commit 9766044

Browse files
committed
Correct outdated information in _index docs. (#48436)
This PR makes the following updates: * Update the supported query types to include `prefix` and `wildcard`. * Specify that queries accept index aliases. * Clarify that when querying on a remote index name, the separator `:` must be present.
1 parent 3c6e5f0 commit 9766044

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

docs/reference/mapping/fields/index-field.asciidoc

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,11 @@
44
When performing queries across multiple indexes, it is sometimes desirable to
55
add query clauses that are associated with documents of only certain indexes.
66
The `_index` field allows matching on the index a document was indexed into.
7-
Its value is accessible in `term`, or `terms` queries, aggregations,
8-
scripts, and when sorting:
9-
10-
NOTE: The `_index` is exposed as a virtual field -- it is not added to the
11-
Lucene index as a real field. This means that you can use the `_index` field
12-
in a `term` or `terms` query (or any query that is rewritten to a `term`
13-
query, such as the `match`, `query_string` or `simple_query_string` query),
14-
but it does not support `prefix`, `wildcard`, `regexp`, or `fuzzy` queries.
7+
Its value is accessible in certain queries and aggregations, and when sorting
8+
or scripting:
159

1610
[source,console]
1711
--------------------------
18-
# Example documents
1912
PUT index_1/_doc/1
2013
{
2114
"text": "Document in index 1"
@@ -63,3 +56,20 @@ GET index_1,index_2/_search
6356
<2> Aggregating on the `_index` field
6457
<3> Sorting on the `_index` field
6558
<4> Accessing the `_index` field in scripts
59+
60+
The `_index` field is exposed virtually -- it is not added to the Lucene index
61+
as a real field. This means that you can use the `_index` field in a `term` or
62+
`terms` query (or any query that is rewritten to a `term` query, such as the
63+
`match`, `query_string` or `simple_query_string` query), as well as `prefix`
64+
and `wildcard` queries. However, it does not support `regexp` and `fuzzy`
65+
queries.
66+
67+
Queries on the `_index` field accept index aliases in addition to concrete
68+
index names.
69+
70+
NOTE: When specifying a remote index name such as `cluster_1:index_3`, the
71+
query must contain the separator character `:`. For example, a `wildcard` query
72+
on `cluster_*:index_3` would match documents from the remote index. However, a
73+
query on `cluster*index_1` is only matched against local indices, since no
74+
separator is present. This behavior aligns with the usual resolution rules for
75+
remote index names.

0 commit comments

Comments
 (0)