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
|
|
|
|
2015-07-19 19:24:29 -04:00
|
|
|
Each document indexed is associated with a <<mapping-type-field,`_type`>> (see
|
2015-08-06 11:24:29 -04:00
|
|
|
<<mapping-type>>) and an <<mapping-id-field,`_id`>>. The `_id` field is not
|
|
|
|
indexed as its value can be derived automatically from the
|
2015-07-19 19:24:29 -04:00
|
|
|
<<mapping-uid-field,`_uid`>> field.
|
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`,
|
|
|
|
`terms`, `match`, `query_string`, `simple_query_string`) and scripts, but
|
|
|
|
_not_ in aggregations or when sorting, where the <<mapping-uid-field,`_uid`>>
|
|
|
|
field should be used instead:
|
2015-07-19 19:24:29 -04:00
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------
|
|
|
|
# Example documents
|
|
|
|
PUT my_index/my_type/1
|
|
|
|
{
|
|
|
|
"text": "Document with ID 1"
|
|
|
|
}
|
|
|
|
|
|
|
|
PUT my_index/my_type/2
|
|
|
|
{
|
|
|
|
"text": "Document with ID 2"
|
|
|
|
}
|
|
|
|
|
|
|
|
GET my_index/_search
|
|
|
|
{
|
|
|
|
"query": {
|
|
|
|
"terms": {
|
|
|
|
"_id": [ "1", "2" ] <1>
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"script_fields": {
|
|
|
|
"UID": {
|
|
|
|
"script": "doc['_id']" <2>
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------
|
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>>)
|
|
|
|
<2> Accessing the `_id` field in scripts (inline scripts must be <<enable-dynamic-scripting,enabled>> for this example to work)
|
2013-08-28 19:24:34 -04:00
|
|
|
|