diff --git a/docs/reference/mapping/fields/all-field.asciidoc b/docs/reference/mapping/fields/all-field.asciidoc index 137e129bbb35d..a6e9533148674 100644 --- a/docs/reference/mapping/fields/all-field.asciidoc +++ b/docs/reference/mapping/fields/all-field.asciidoc @@ -33,7 +33,7 @@ Here is a sample mapping: "type" : "object", "dynamic" : false, "properties" : { - "first" : {"type" : "string", "store" : true , "include_in_all" : false}, + "first" : {"type" : "string", include_in_all" : false}, "last" : {"type" : "string", "index" : "not_analyzed"} } }, @@ -43,7 +43,7 @@ Here is a sample mapping: "properties" : { "first" : { "properties" : { - "location" : {"type" : "string", "store" : true, "index_name" : "firstLocation"} + "location" : {"type" : "string" } } }, "last" : { diff --git a/docs/reference/mapping/types/array-type.asciidoc b/docs/reference/mapping/types/array-type.asciidoc index 3f887b1c6f73e..e86676f461078 100644 --- a/docs/reference/mapping/types/array-type.asciidoc +++ b/docs/reference/mapping/types/array-type.asciidoc @@ -38,7 +38,7 @@ is a sample explicit mapping: "tweet" : { "properties" : { "message" : {"type" : "string"}, - "tags" : {"type" : "string", "index_name" : "tag"}, + "tags" : {"type" : "string" }, "lists" : { "properties" : { "name" : {"type" : "string"}, @@ -67,8 +67,3 @@ the fact that the following JSON document is perfectly fine: } -------------------------------------------------- -Note also, that thanks to the fact that we used the `index_name` to use -the non plural form (`tag` instead of `tags`), we can actually refer to -the field using the `index_name` as well. For example, we can execute a -query using `tweet.tags:wow` or `tweet.tag:wow`. We could, of course, -name the field as `tag` and skip the `index_name` all together). diff --git a/docs/reference/mapping/types/core-types.asciidoc b/docs/reference/mapping/types/core-types.asciidoc index 219f4fc1fecb0..70e5583367d11 100644 --- a/docs/reference/mapping/types/core-types.asciidoc +++ b/docs/reference/mapping/types/core-types.asciidoc @@ -83,9 +83,6 @@ The following table lists all the attributes that can be used with the [cols="<,<",options="header",] |======================================================================= |Attribute |Description -|`index_name` |The name of the field that will be stored in the index. -Defaults to the property/field name. - |`store` |Set to `true` to actually store the field in the index, `false` to not store it. Defaults to `false` (note, the JSON document itself is stored, and it can be retrieved from it). @@ -146,6 +143,10 @@ Useful for generic `not_analyzed` fields that should ignore long text. |`position_offset_gap` |Position increment gap between field instances with the same field name. Defaults to 0. + +|`index_name` |deprecated[1.3]The name of the field that will be stored in the index. +Defaults to the property/field name. + |======================================================================= The `string` type also support custom indexing parameters associated @@ -223,9 +224,6 @@ numbered type: |`type` |The type of the number. Can be `float`, `double`, `integer`, `long`, `short`, `byte`. Required. -|`index_name` |The name of the field that will be stored in the index. -Defaults to the property/field name. - |`store` |Set to `true` to store actual field in the index, `false` to not store it. Defaults to `false` (note, the JSON document itself is stored, and it can be retrieved from it). @@ -256,6 +254,9 @@ defaults to `true` or to the parent `object` type setting. |`coerce` |Try convert strings to numbers and truncate fractions for integers. Defaults to `true`. +|`index_name` |deprecated[1.3]The name of the field that will be stored in the index. +Defaults to the property/field name. + |======================================================================= [float] @@ -330,9 +331,6 @@ date type: [cols="<,<",options="header",] |======================================================================= |Attribute |Description -|`index_name` |The name of the field that will be stored in the index. -Defaults to the property/field name. - |`format` |The <>. Defaults to `dateOptionalTime`. @@ -363,6 +361,9 @@ defaults to `true` or to the parent `object` type setting. |`ignore_malformed` |Ignored a malformed number. Defaults to `false`. +|`index_name` |deprecated[1.3]The name of the field that will be stored in the index. +Defaults to the property/field name. + |======================================================================= [float] @@ -396,9 +397,6 @@ boolean type: [cols="<,<",options="header",] |======================================================================= |Attribute |Description -|`index_name` |The name of the field that will be stored in the index. -Defaults to the property/field name. - |`store` |Set to `true` to store actual field in the index, `false` to not store it. Defaults to `false` (note, the JSON document itself is stored, and it can be retrieved from it). @@ -413,6 +411,10 @@ in `_source`, have `include_in_all` enabled, or `store` be set to |`null_value` |When there is a (JSON) null value for the field, use the `null_value` as the field value. Defaults to not adding the field at all. + +|`index_name` |deprecated[1.3]The name of the field that will be stored in the index. +Defaults to the property/field name. + |======================================================================= [float] @@ -441,11 +443,6 @@ binary type: [horizontal] -`index_name`:: - - The name of the field that will be stored in the index. Defaults to the - property/field name. - `store`:: Set to `true` to store actual field in the index, `false` to not store it. @@ -465,6 +462,12 @@ binary type: Compression will only be applied to stored binary fields that are greater than this size. Defaults to `-1` +`index_name`:: + + deprecated[1.3] The name of the field that will be stored in the index. Defaults to the + property/field name. + + NOTE: Enabling compression on stored binary fields only makes sense on large and highly-compressible values. Otherwise per-field compression is usually not worth doing as the space savings do not compensate for the overhead of the diff --git a/docs/reference/mapping/types/ip-type.asciidoc b/docs/reference/mapping/types/ip-type.asciidoc index a3f2556eb1b77..4ae7a80d3d16c 100644 --- a/docs/reference/mapping/types/ip-type.asciidoc +++ b/docs/reference/mapping/types/ip-type.asciidoc @@ -10,9 +10,6 @@ type: [cols="<,<",options="header",] |======================================================================= |Attribute |Description -|`index_name` |The name of the field that will be stored in the index. -Defaults to the property/field name. - |`store` |Set to `true` to store actual field in the index, `false` to not store it. Defaults to `false` (note, the JSON document itself is stored, and it can be retrieved from it). @@ -21,7 +18,7 @@ and it can be retrieved from it). `store` should be set to `true`, since if it's not indexed and not stored, there is nothing to do with it. -|`precision_step` |The precision step (influences the number of terms +|`precision_step` |The precision step (influences the number of terms generated for each number value). Defaults to `16`. |`boost` |The boost value. Defaults to `1.0`. @@ -32,5 +29,9 @@ all. |`include_in_all` |Should the field be included in the `_all` field (if enabled). Defaults to `true` or to the parent `object` type setting. + +|`index_name` |deprecated[1.3]. The name of the field that will be stored +in the index. Defaults to the property/field name. + |=======================================================================