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>>.
|
|
|
|
|
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
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2015-07-19 19:24:29 -04:00
|
|
|
--------------------------
|
|
|
|
# Example documents
|
2020-07-27 15:58:26 -04:00
|
|
|
PUT my-index-000001/_doc/1
|
2015-07-19 19:24:29 -04:00
|
|
|
{
|
|
|
|
"text": "Document with ID 1"
|
|
|
|
}
|
|
|
|
|
2020-07-27 15:58:26 -04:00
|
|
|
PUT my-index-000001/_doc/2?refresh=true
|
2015-07-19 19:24:29 -04:00
|
|
|
{
|
|
|
|
"text": "Document with ID 2"
|
|
|
|
}
|
|
|
|
|
2020-07-27 15:58:26 -04:00
|
|
|
GET my-index-000001/_search
|
2015-07-19 19:24:29 -04:00
|
|
|
{
|
|
|
|
"query": {
|
|
|
|
"terms": {
|
|
|
|
"_id": [ "1", "2" ] <1>
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
<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.
|
2019-07-15 09:39:20 -04:00
|
|
|
|
|
|
|
|
|
|
|
[NOTE]
|
|
|
|
==================================================
|
|
|
|
`_id` is limited to 512 bytes in size and larger values will be rejected.
|
|
|
|
==================================================
|