Docs: Cleanup meta field docs

Meta fields were locked down to not allow exotic options to the
underlying field types in #8143. This change fixes the docs
to no longer refer to the old settings.

closes #10879
This commit is contained in:
Ryan Ernst 2015-04-30 15:01:35 -07:00
parent e7540e9598
commit e29492ce94
8 changed files with 12 additions and 82 deletions

View File

@ -4,6 +4,3 @@
The `_field_names` field indexes the field names of a document, which can later The `_field_names` field indexes the field names of a document, which can later
be used to search for documents based on the fields that they contain typically be used to search for documents based on the fields that they contain typically
using the `exists` and `missing` filters. using the `exists` and `missing` filters.
`_field_names` is indexed by default for indices that have been created after
Elasticsearch 1.3.0.

View File

@ -2,26 +2,10 @@
=== `_id` === `_id`
Each document indexed is associated with an id and a type. The `_id` Each document indexed is associated with an id and a type. The `_id`
field can be used to index just the id, and possible also store it. By field allows accessing only the id of a document.
default it is not indexed and not stored (thus, not created).
Note, even though the `_id` is not indexed, all the APIs still work Note, even though the `_id` is not indexed, all the APIs still work
(since they work with the `_uid` field), as well as fetching by ids (since they work with the `_uid` field), as well as fetching by ids
using `term`, `terms` or `prefix` queries/filters (including the using `term`, `terms` or `prefix` queries/filters (including the
specific `ids` query/filter). specific `ids` query/filter).
The `_id` field can be enabled to be indexed, and possibly stored,
using the appropriate mapping attributes:
[source,js]
--------------------------------------------------
{
"tweet" : {
"_id" : {
"index" : "not_analyzed",
"store" : true
}
}
}
--------------------------------------------------

View File

@ -2,16 +2,7 @@
=== `_routing` === `_routing`
The routing field allows to control the `_routing` aspect when indexing The routing field allows to control the `_routing` aspect when indexing
data and explicit routing control is required. data and explicit routing control is required. It is stored and indexed.
[float]
==== store / index
The first thing the `_routing` mapping does is to store the routing
value provided (`store` set to `true`) and index it (`index` set to
`not_analyzed`). The reason why the routing is stored by default is so
reindexing data will be possible if the routing value is completely
external and not part of the docs.
[float] [float]
==== required ==== required
@ -20,9 +11,7 @@ Another aspect of the `_routing` mapping is the ability to define it as
required by setting `required` to `true`. This is very important to set required by setting `required` to `true`. This is very important to set
when using routing features, as it allows different APIs to make use of when using routing features, as it allows different APIs to make use of
it. For example, an index operation will be rejected if no routing value it. For example, an index operation will be rejected if no routing value
has been provided (or derived from the doc). A delete operation will be has been provided.
broadcasted to all shards if no routing value is provided and `_routing`
is required.
[float] [float]
==== id uniqueness ==== id uniqueness

View File

@ -13,14 +13,3 @@ the mapping to:
} }
} }
-------------------------------------------------- --------------------------------------------------
In order to also store it, use:
[source,js]
--------------------------------------------------
{
"tweet" : {
"_size" : {"enabled" : true, "store" : true }
}
}
--------------------------------------------------

View File

@ -1,31 +1,7 @@
[[mapping-type-field]] [[mapping-type-field]]
=== `_type` === `_type`
Each document indexed is associated with an id and a type. The type, Each document indexed is associated with an id and a type. The `_type`
when indexing, is automatically indexed into a `_type` field. By field allows accessing only the type of a document. It is indexed
default, the `_type` field is indexed (but *not* analyzed) and not to allow quickly filtering on type, for example, when performing
stored. This means that the `_type` field can be queried. a search request on a single or multiple types.
The `_type` field can be stored as well, for example:
[source,js]
--------------------------------------------------
{
"tweet" : {
"_type" : {"store" : true}
}
}
--------------------------------------------------
The `_type` field can also not be indexed, and all the APIs will still
work except for specific queries (term queries / filters) or aggregations
done on the `_type` field.
[source,js]
--------------------------------------------------
{
"tweet" : {
"_type" : {"index" : "no"}
}
}
--------------------------------------------------

View File

@ -6,6 +6,5 @@ Each document indexed is associated with an id and a type, the internal
is composed of the type and the id (meaning that different types can is composed of the type and the id (meaning that different types can
have the same id and still maintain uniqueness). have the same id and still maintain uniqueness).
The `_uid` field is automatically used when `_type` is not indexed to The `_uid` field is for type based filtering, as well as for
perform type based filtering, and does not require the `_id` to be lookups of `_id` and `_type`.
indexed.

View File

@ -2,9 +2,7 @@
== Ids Query == Ids Query
Filters documents that only have the provided ids. Note, this query Filters documents that only have the provided ids. Note, this query
does not require the <<mapping-id-field,_id>> uses the <<mapping-uid-field,_uid>> field.
field to be indexed since it works using the
<<mapping-uid-field,_uid>> field.
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -17,4 +15,4 @@ field to be indexed since it works using the
-------------------------------------------------- --------------------------------------------------
The `type` is optional and can be omitted, and can also accept an array The `type` is optional and can be omitted, and can also accept an array
of values. of values. If no type is specified, all types defined in the index mapping are tried.

View File

@ -1,9 +1,7 @@
[[query-dsl-type-query]] [[query-dsl-type-query]]
== Type Query == Type Query
Filters documents matching the provided document / mapping type. Note, Filters documents matching the provided document / mapping type.
this query can work even when the `_type` field is not indexed (using
the <<mapping-uid-field,_uid>> field).
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------