2013-08-28 19:24:34 -04:00
|
|
|
[[mapping-id-field]]
|
2015-07-19 19:24:29 -04:00
|
|
|
=== `_id` field
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2017-07-05 10:09:31 -04:00
|
|
|
Each document has an `_id` that uniquely identifies it, which is indexed
|
|
|
|
so that documents can be looked up either with the <<docs-get,GET API>> or the
|
|
|
|
<<query-dsl-ids-query,`ids` query>>.
|
|
|
|
|
|
|
|
NOTE: This was not the case with pre-6.0 indices due to the fact that they
|
|
|
|
supported multiple types, so the `_type` and `_id` were merged into a composite
|
|
|
|
primary key called `_uid`.
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2016-04-28 07:35:35 -04:00
|
|
|
The value of the `_id` field is accessible in certain queries (`term`,
|
2017-05-09 10:33:52 -04:00
|
|
|
`terms`, `match`, `query_string`, `simple_query_string`).
|
2015-07-19 19:24:29 -04:00
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------
|
|
|
|
# Example documents
|
|
|
|
PUT my_index/my_type/1
|
|
|
|
{
|
|
|
|
"text": "Document with ID 1"
|
|
|
|
}
|
|
|
|
|
2016-08-23 07:32:14 -04:00
|
|
|
PUT my_index/my_type/2&refresh=true
|
2015-07-19 19:24:29 -04:00
|
|
|
{
|
|
|
|
"text": "Document with ID 2"
|
|
|
|
}
|
|
|
|
|
|
|
|
GET my_index/_search
|
|
|
|
{
|
|
|
|
"query": {
|
|
|
|
"terms": {
|
|
|
|
"_id": [ "1", "2" ] <1>
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------
|
2016-05-09 09:42:23 -04:00
|
|
|
// CONSOLE
|
2015-07-19 19:24:29 -04:00
|
|
|
|
|
|
|
<1> Querying on the `_id` field (also see the <<query-dsl-ids-query,`ids` query>>)
|
2017-05-09 10:33:52 -04:00
|
|
|
|
|
|
|
The value of the `_id` field is also accessible in aggregations or for sorting,
|
|
|
|
but doing so is discouraged as it requires to load a lot of data in memory. In
|
|
|
|
case sorting or aggregating on the `_id` field is required, it is advised to
|
|
|
|
duplicate the content of the `_id` field in another field that has `doc_values`
|
|
|
|
enabled.
|