From 8e32c9ed079e473d207a89816fff21d79b45b14e Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Wed, 5 Feb 2014 14:45:59 +0100 Subject: [PATCH] [DOCS] Deprecated the path setting in favour of copy_to Relates to #4729 --- .../mapping/types/core-types.asciidoc | 50 ++++++++++--------- .../mapping/types/object-type.asciidoc | 17 ++++--- docs/reference/migration/migrate_1_0.asciidoc | 2 + 3 files changed, 39 insertions(+), 30 deletions(-) diff --git a/docs/reference/mapping/types/core-types.asciidoc b/docs/reference/mapping/types/core-types.asciidoc index 2ba47392b0b9b..6ac805db55aae 100644 --- a/docs/reference/mapping/types/core-types.asciidoc +++ b/docs/reference/mapping/types/core-types.asciidoc @@ -615,6 +615,7 @@ The following Similarities are configured out-of-box: details. +[[copy-to]] [float] ===== Copy to field @@ -681,9 +682,35 @@ processed as an analyzed string and this version is accessible under the field n `name`, this is the main field and is in fact just like any other field. The second time its get processed as a not analyzed string and is accessible under the name `name.raw`. +[float] +==== Include in All + +The `include_in_all` setting is ignored on any field that is defined in +the `fields` options. Setting the `include_in_all` only makes sense on +the main field, since the raw field value to copied to the `_all` field, +the tokens aren't copied. + +[float] +==== Updating a field + +In the essence a field can't be updated. However multi fields can be +added to existing fields. This allows for example to have a different +`index_analyzer` configuration in addition to the already configured +`index_analyzer` configuration specified in the main and other multi fields. + +Also the new multi field will only be applied on document that have been +added after the multi field has been added and in fact the new multi field +doesn't exist in existing documents. + +Another important note is that new multi fields will be merged into the +list of existing multi fields, so when adding new multi fields for a field +previous added multi fields don't need to be specified. + [float] ==== Accessing Fields +deprecated[1.0.0,Use <> instead] + The multi fields defined in the `fields` are prefixed with the name of the main field and can be accessed by their full path using the navigation notation: `name.raw`, or using the typed navigation notation @@ -723,26 +750,3 @@ fields under the same name. In the example below the content of both fields } -------------------------------------------------- -[float] -==== Include in All - -The `include_in_all` setting is ignored on any field that is defined in -the `fields` options. Setting the `include_in_all` only makes sense on -the main field, since the raw field value to copied to the `_all` field, -the tokens aren't copied. - -[float] -==== Updating a field - -In the essence a field can't be updated. However multi fields can be -added to existing fields. This allows for example to have a different -`index_analyzer` configuration in addition to the already configured -`index_analyzer` configuration specified in the main and other multi fields. - -Also the new multi field will only be applied on document that have been -added after the multi field has been added and in fact the new multi field -doesn't exist in existing documents. - -Another important note is that new multi fields will be merged into the -list of existing multi fields, so when adding new multi fields for a field -previous added multi fields don't need to be specified. \ No newline at end of file diff --git a/docs/reference/mapping/types/object-type.asciidoc b/docs/reference/mapping/types/object-type.asciidoc index 1fb801a95cb56..ce28239eee529 100644 --- a/docs/reference/mapping/types/object-type.asciidoc +++ b/docs/reference/mapping/types/object-type.asciidoc @@ -168,9 +168,19 @@ For example: In the above, `name` and its content will not be indexed at all. + +[float] +==== include_in_all + +`include_in_all` can be set on the `object` type level. When set, it +propagates down to all the inner mapping defined within the `object` +that do no explicitly set it. + [float] ==== path +deprecated[1.0.0,Use <> instead] + In the <> section, a field can have a `index_name` associated with it in order to control the name of the field that will be stored within the index. When @@ -232,10 +242,3 @@ including the type can be used such as `person.name.last1`, in this case, both the actual indexed name will be resolved to match against the index, and an automatic query filter will be added to only match `person` types. - -[float] -==== include_in_all - -`include_in_all` can be set on the `object` type level. When set, it -propagates down to all the inner mapping defined within the `object` -that do no explicitly set it. diff --git a/docs/reference/migration/migrate_1_0.asciidoc b/docs/reference/migration/migrate_1_0.asciidoc index 7a42d0f40d14a..0cdb266050f4b 100644 --- a/docs/reference/migration/migrate_1_0.asciidoc +++ b/docs/reference/migration/migrate_1_0.asciidoc @@ -353,4 +353,6 @@ in the query string. been removed. You can use the <> instead. +* The `path` parameter in mappings has been deprecated. Use the + <> parameter instead.