root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/mapping/fields/id-field.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

47 lines
1.3 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-29 07:24:34 +08:00
[[mapping-id-field]]
Docs: Refactored the mapping meta-fields docs
2015-07-20 07:24:29 +08:00
=== `_id` field
Migrated documentation into the main repo
2013-08-29 07:24:34 +08:00
Fix the documentation to state that the `_id` field is indexed. (#25540)
2017-07-05 22:09:31 +08: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
Clarify field data cache behavior in docs (#64375) * Clarify that field data cache includes global ordinals * Describe that the cache should be cleared once the limit is reached * Clarify that the `_id` field does not supported aggregations anymore * Fold the `fielddata` mapping parameter page into the `text field docs * Improve cross-linking
2020-11-21 05:53:23 +08:00
<<query-dsl-ids-query,`ids` query>>. The `_id` can either be assigned at
indexing time, or a unique `_id` can be generated by {es}. This field is not
configurable in the mappings.
Fix the documentation to state that the `_id` field is indexed. (#25540)
2017-07-05 22:09:31 +08:00
Clarify field data cache behavior in docs (#64375) * Clarify that field data cache includes global ordinals * Describe that the cache should be cleared once the limit is reached * Clarify that the `_id` field does not supported aggregations anymore * Fold the `fielddata` mapping parameter page into the `text field docs * Improve cross-linking
2020-11-21 05:53:23 +08:00
The value of the `_id` field is accessible in queries such as `term`,
`terms`, `match`, and `query_string`.
Docs: Refactored the mapping meta-fields docs
2015-07-20 07:24:29 +08:00
[DOCS] Change // CONSOLE comments to [source,console] (#46441)
2019-09-06 22:55:16 +08:00
[source,console]
Docs: Refactored the mapping meta-fields docs
2015-07-20 07:24:29 +08:00
--------------------------
# Example documents
[DOCS] Update my-index examples (#60132) Changes the following example index names to `my-index-000001` for consistency: * `my-index` * `my_index` * `myindex`
2020-07-28 02:46:39 +08:00
PUT my-index-000001/_doc/1
Docs: Refactored the mapping meta-fields docs
2015-07-20 07:24:29 +08:00
{
"text": "Document with ID 1"
}
[DOCS] Update my-index examples (#60132) Changes the following example index names to `my-index-000001` for consistency: * `my-index` * `my_index` * `myindex`
2020-07-28 02:46:39 +08:00
PUT my-index-000001/_doc/2?refresh=true
Docs: Refactored the mapping meta-fields docs
2015-07-20 07:24:29 +08:00
{
"text": "Document with ID 2"
}
[DOCS] Update my-index examples (#60132) Changes the following example index names to `my-index-000001` for consistency: * `my-index` * `my_index` * `myindex`
2020-07-28 02:46:39 +08:00
GET my-index-000001/_search
Docs: Refactored the mapping meta-fields docs
2015-07-20 07:24:29 +08:00
{
"query": {
"terms": {
"_id": [ "1", "2" ] <1>
}
}
}
--------------------------
<1> Querying on the `_id` field (also see the <<query-dsl-ids-query,`ids` query>>)
Identify documents by their `_id`. (#24460) Now that indices have a single type by default, we can move to the next step and identify documents using their `_id` rather than the `_uid`. One notable change in this commit is that I made deletions implicitly create types. This helps with the live version map in the case that documents are deleted before the first type is introduced. Otherwise there would be no way to differenciate `DELETE index/foo/1` followed by `PUT index/foo/1` from `DELETE index/bar/1` followed by `PUT index/foo/1`, even though those are different if versioning is involved.
2017-05-09 22:33:52 +08:00
Clarify field data cache behavior in docs (#64375) * Clarify that field data cache includes global ordinals * Describe that the cache should be cleared once the limit is reached * Clarify that the `_id` field does not supported aggregations anymore * Fold the `fielddata` mapping parameter page into the `text field docs * Improve cross-linking
2020-11-21 05:53:23 +08:00
The `_id` field is restricted from use in aggregations, sorting, and scripting.
In case sorting or aggregating on the `_id` field is required, it is advised to
duplicate the content of the `_id` field into another field that has
`doc_values` enabled.
[DOCS] Update id-field.asciidoc (#42482) Adding a note around the size limit for `_id`
2019-07-15 21:39:20 +08:00
[NOTE]
==================================================
`_id` is limited to 512 bytes in size and larger values will be rejected.
==================================================