diff --git a/docs/java-api/admin/indices/put-mapping.asciidoc b/docs/java-api/admin/indices/put-mapping.asciidoc index d63a498d994..4c14310f6dc 100644 --- a/docs/java-api/admin/indices/put-mapping.asciidoc +++ b/docs/java-api/admin/indices/put-mapping.asciidoc @@ -9,7 +9,7 @@ You can add mappings at index creation time: include-tagged::{client-tests}/IndicesDocumentationIT.java[index-with-mapping] -------------------------------------------------- <1> <> called `twitter` -<2> Add a `_doc` type with a field called `message` that has the datatype `text`. +<2> Add a `_doc` type with a field called `message` that has the data type `text`. There are several variants of the above `addMapping` method, some taking an `XContentBuilder` or a `Map` with the mapping definition as arguments. Make sure diff --git a/docs/plugins/mapper.asciidoc b/docs/plugins/mapper.asciidoc index 4026a45c59e..41a9830fd0e 100644 --- a/docs/plugins/mapper.asciidoc +++ b/docs/plugins/mapper.asciidoc @@ -1,7 +1,7 @@ [[mapper]] == Mapper Plugins -Mapper plugins allow new field datatypes to be added to Elasticsearch. +Mapper plugins allow new field data types to be added to Elasticsearch. [float] === Core mapper plugins diff --git a/docs/reference/analysis/tokenfilters/delimited-payload-tokenfilter.asciidoc b/docs/reference/analysis/tokenfilters/delimited-payload-tokenfilter.asciidoc index 7a08982ff0c..0bcc1ca12c3 100644 --- a/docs/reference/analysis/tokenfilters/delimited-payload-tokenfilter.asciidoc +++ b/docs/reference/analysis/tokenfilters/delimited-payload-tokenfilter.asciidoc @@ -144,7 +144,7 @@ Character used to separate tokens from payloads. Defaults to `|`. + -- (Optional, string) -Datatype for the stored payload. Valid values are: +Data type for the stored payload. Valid values are: `float`::: (Default) Float diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index 6c243f7d559..5cd77764b03 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -467,7 +467,7 @@ Contains statistics about <> in selected nodes. ===== `field_types`:: (array of objects) -Contains statistics about <> used in selected +Contains statistics about <> used in selected nodes. + .Properties of `field_types` objects @@ -475,15 +475,15 @@ nodes. ====== `name`:: (string) -Field datatype used in selected nodes. +Field data type used in selected nodes. `count`:: (integer) -Number of fields mapped to the field datatype in selected nodes. +Number of fields mapped to the field data type in selected nodes. `index_count`:: (integer) -Number of indices containing a mapping of the field datatype in selected nodes. +Number of indices containing a mapping of the field data type in selected nodes. ====== ===== diff --git a/docs/reference/data-streams/change-mappings-and-settings.asciidoc b/docs/reference/data-streams/change-mappings-and-settings.asciidoc index 1c35d5603cf..e0da33322d8 100644 --- a/docs/reference/data-streams/change-mappings-and-settings.asciidoc +++ b/docs/reference/data-streams/change-mappings-and-settings.asciidoc @@ -245,7 +245,7 @@ PUT /logs/_mapping ==== Except for supported mapping parameters, we don't recommend you change the -mapping or field datatype of existing fields, even in a data stream's matching +mapping or field data type of existing fields, even in a data stream's matching index template or its backing indices. Changing the mapping of an existing field could invalidate any data that’s already indexed. @@ -378,7 +378,7 @@ new data stream and reindex your data into it. See === Use reindex to change mappings or settings You can use a reindex to change the mappings or settings of a data stream. This -is often required to change the datatype of an existing field or update static +is often required to change the data type of an existing field or update static index settings for backing indices. To reindex a data stream, first create or update an index template so that it @@ -447,8 +447,8 @@ uses the `logs_data_stream` template as its basis, with the following changes: * The `index_patterns` wildcard pattern matches any index or data stream starting with `new_logs`. -* The `@timestamp` field mapping uses the `date_nanos` field datatype rather - than the `date` datatype. +* The `@timestamp` field mapping uses the `date_nanos` field data type rather + than the `date` data type. * The template includes `sort.field` and `sort.order` index settings, which were not in the original `logs_data_stream` template. @@ -475,7 +475,7 @@ PUT /_index_template/new_logs_data_stream } } ---- -<1> Changes the `@timestamp` field mapping to the `date_nanos` field datatype. +<1> Changes the `@timestamp` field mapping to the `date_nanos` field data type. <2> Adds the `sort.field` index setting. <3> Adds the `sort.order` index setting. ==== diff --git a/docs/reference/data-streams/data-streams-overview.asciidoc b/docs/reference/data-streams/data-streams-overview.asciidoc index f4cf8020cf0..4a66946b9ab 100644 --- a/docs/reference/data-streams/data-streams-overview.asciidoc +++ b/docs/reference/data-streams/data-streams-overview.asciidoc @@ -17,7 +17,7 @@ the stream's backing indices. It contains: * A name or wildcard (`*`) pattern for the data stream. * The data stream's _timestamp field_. This field must be mapped as a - <> or <> field datatype and must be + <> or <> field data type and must be included in every document indexed to the data stream. * The mappings and settings applied to each backing index when it's created. diff --git a/docs/reference/eql/functions.asciidoc b/docs/reference/eql/functions.asciidoc index e1947ebe980..32845a3876a 100644 --- a/docs/reference/eql/functions.asciidoc +++ b/docs/reference/eql/functions.asciidoc @@ -74,7 +74,7 @@ Addend to add. If `null`, the function returns `null`. Two addends are required. No more than two addends can be provided. + If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. *Returns:* integer, float, or `null` ==== @@ -131,7 +131,7 @@ Source string. Empty strings return an empty string (`""`), regardless of the `` or `` parameters. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -147,7 +147,7 @@ Text to the left of the substring to extract. This text should include whitespace. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -163,7 +163,7 @@ Text to the right of the substring to extract. This text should include whitespace. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -224,7 +224,7 @@ https://en.wikipedia.org/wiki/IPv6[IPv6] addresses. If `null`, the function returns `null`. + If using a field as the argument, this parameter supports only the <> -field datatype. +field data type. ``:: (Required{multi-arg}, string or `null`) @@ -279,7 +279,7 @@ concat([, ]) Value to concatenate. If any of the arguments are `null`, the function returns `null`. + If using a field as the argument, this parameter does not support the -<> field datatype. +<> field data type. *Returns:* string or `null` ==== @@ -376,7 +376,7 @@ divide(, ) Dividend to divide. If `null`, the function returns `null`. + If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. ``:: (Required, integer or float or `null`) @@ -384,7 +384,7 @@ Divisor to divide by. If `null`, the function returns `null`. This value cannot be zero (`0`). + If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. *Returns:* integer, float, or null ==== @@ -434,7 +434,7 @@ endsWith(, ) Source string. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -449,7 +449,7 @@ field datatypes: Substring to search for. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -515,7 +515,7 @@ indexOf(, [, ]) Source string. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -536,7 +536,7 @@ If the `` is positive, empty strings (`""`) return the ``. Otherwise, empty strings return `0`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -557,7 +557,7 @@ If this argument is `null` or higher than the length of the `` string, the function returns `null`. If using a field as the argument, this parameter supports only the following -<> field datatypes: +<> field data types: * `long` * `integer` @@ -605,7 +605,7 @@ String for which to return the character length. If `null`, the function returns `null`. Empty strings return `0`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -658,7 +658,7 @@ match(, [, ...]) Source string. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -728,7 +728,7 @@ Dividend to divide. If `null`, the function returns `null`. Floating point numbers return `0`. + If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. ``:: (Required, integer or float or `null`) @@ -736,7 +736,7 @@ Divisor to divide by. If `null`, the function returns `null`. Floating point numbers return `0`. This value cannot be zero (`0`). + If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. *Returns:* integer, float, or `null` ==== @@ -788,7 +788,7 @@ Factor to multiply. If `null`, the function returns `null`. Two factors are required. No more than two factors can be provided. If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. -- *Returns:* integer, float, or `null` @@ -864,7 +864,7 @@ Strings that begin with `0x` are auto-detected as hexadecimal and use a default ignored. Empty strings (`""`) are not supported. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -935,7 +935,7 @@ startsWith(, ) Source string. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -950,7 +950,7 @@ field datatypes: Substring to search for. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -994,7 +994,7 @@ string() Value to convert to a string. If `null`, the function returns `null`. + If using a field as the argument, this parameter does not support the -<> field datatype. +<> field data type. *Returns:* string or `null` ==== @@ -1040,7 +1040,7 @@ stringContains(, ) Source string to search. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -1052,7 +1052,7 @@ field datatypes: Substring to search for. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> @@ -1159,14 +1159,14 @@ subtract(, ) Minuend to subtract from. + If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. ``:: (Optional, integer or float or `null`) Subtrahend to subtract. If `null`, the function returns `null`. + If using a field as the argument, this parameter supports only -<> field datatypes. +<> field data types. *Returns:* integer, float, or `null` ==== @@ -1218,7 +1218,7 @@ wildcard(, [, ...]) Source string. If `null`, the function returns `null`. If using a field as the argument, this parameter supports only the following -field datatypes: +field data types: * <> * <> diff --git a/docs/reference/eql/requirements.asciidoc b/docs/reference/eql/requirements.asciidoc index f3e7f312a5f..3f3e5813158 100644 --- a/docs/reference/eql/requirements.asciidoc +++ b/docs/reference/eql/requirements.asciidoc @@ -36,7 +36,7 @@ mapped as a <> field. [NOTE] ==== -You cannot use a <> field datatype or the sub-fields of a +You cannot use a <> field data type or the sub-fields of a `nested` field dataype as the timestamp or event category field. See <>. ==== diff --git a/docs/reference/ilm/index-rollover.asciidoc b/docs/reference/ilm/index-rollover.asciidoc index beaee4ec1d0..ae19252c0ab 100644 --- a/docs/reference/ilm/index-rollover.asciidoc +++ b/docs/reference/ilm/index-rollover.asciidoc @@ -20,7 +20,7 @@ Each data stream requires an <> that contains: * A name or wildcard (`*`) pattern for the data stream. * The data stream's timestamp field. This field must be mapped as a - <> or <> field datatype and must be + <> or <> field data type and must be included in every document indexed to the data stream. * The mappings and settings applied to each backing index when it's created. diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index 136d5e9d11b..0037ea03185 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -76,7 +76,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] fields, this mapping can include: * Field name -* <> +* <> * <> For existing fields, see <>. diff --git a/docs/reference/ingest/processors/kv.asciidoc b/docs/reference/ingest/processors/kv.asciidoc index e2db150275d..18181d3036a 100644 --- a/docs/reference/ingest/processors/kv.asciidoc +++ b/docs/reference/ingest/processors/kv.asciidoc @@ -16,7 +16,7 @@ For example, if you have a log message which contains `ip=1.2.3.4 error=REFUSED` -------------------------------------------------- // NOTCONSOLE -TIP: Using the KV Processor can result in field names that you cannot control. Consider using the <> datatype instead, which maps an entire object as a single field and allows for simple searches over its contents. +TIP: Using the KV Processor can result in field names that you cannot control. Consider using the <> data type instead, which maps an entire object as a single field and allows for simple searches over its contents. [[kv-options]] .KV Options diff --git a/docs/reference/intro.asciidoc b/docs/reference/intro.asciidoc index 6e9fc6999c2..5ce480a330a 100644 --- a/docs/reference/intro.asciidoc +++ b/docs/reference/intro.asciidoc @@ -62,7 +62,7 @@ that might occur in a document. When dynamic mapping is enabled, {es} automatically detects and adds new fields to the index. This default behavior makes it easy to index and explore your data--just start indexing documents and {es} will detect and map booleans, floating point and -integer values, dates, and strings to the appropriate {es} datatypes. +integer values, dates, and strings to the appropriate {es} data types. Ultimately, however, you know more about your data and how you want to use it than {es} can. You can define rules to control dynamic mapping and explicitly diff --git a/docs/reference/mapping.asciidoc b/docs/reference/mapping.asciidoc index 7c7f34ae6cd..5d411639683 100644 --- a/docs/reference/mapping.asciidoc +++ b/docs/reference/mapping.asciidoc @@ -32,7 +32,7 @@ For more details, please see <>. [float] [[field-datatypes]] -== Field datatypes +== Field data types Each field has a data `type` which can be: @@ -51,7 +51,7 @@ the <>, the <> analyzer, and the <>. -This is the purpose of _multi-fields_. Most datatypes support multi-fields +This is the purpose of _multi-fields_. Most data types support multi-fields via the <> parameter. [[mapping-limit-settings]] @@ -86,7 +86,7 @@ limits the maximum number of <> in a query + [TIP] ==== -If your field mappings contain a large, arbitrary set of keys, consider using the <> datatype. +If your field mappings contain a large, arbitrary set of keys, consider using the <> data type. ==== `index.mapping.depth.limit`:: diff --git a/docs/reference/mapping/dynamic-mapping.asciidoc b/docs/reference/mapping/dynamic-mapping.asciidoc index 8daae6f2ac0..e62f243b669 100644 --- a/docs/reference/mapping/dynamic-mapping.asciidoc +++ b/docs/reference/mapping/dynamic-mapping.asciidoc @@ -14,7 +14,7 @@ PUT data/_doc/1 <1> -------------------------------------------------- <1> Creates the `data` index, the `_doc` mapping type, and a field - called `count` with datatype `long`. + called `count` with data type `long`. The automatic detection and addition of new fields is called _dynamic mapping_. The dynamic mapping rules can be customised to suit your diff --git a/docs/reference/mapping/dynamic/field-mapping.asciidoc b/docs/reference/mapping/dynamic/field-mapping.asciidoc index c27c81c4428..06b907ad832 100644 --- a/docs/reference/mapping/dynamic/field-mapping.asciidoc +++ b/docs/reference/mapping/dynamic/field-mapping.asciidoc @@ -8,10 +8,10 @@ setting the <> parameter to `false` (to ignore new fields) or an exception if an unknown field is encountered). Assuming `dynamic` field mapping is enabled, some simple rules are used to -determine which datatype the field should have: +determine which data type the field should have: [horizontal] -*JSON datatype*:: *Elasticsearch datatype* +*JSON data type*:: *Elasticsearch data type* `null`:: No field is added. `true` or `false`:: <> field @@ -25,8 +25,8 @@ string:: Either a <> field (if the value passes <>) or a <> field, with a <> sub-field. -These are the only <> that are dynamically -detected. All other datatypes must be mapped explicitly. +These are the only <> that are dynamically +detected. All other data types must be mapped explicitly. Besides the options listed below, dynamic field mapping rules can be further customised with <>. @@ -105,7 +105,7 @@ PUT my_index/_doc/1 [[numeric-detection]] ==== Numeric detection -While JSON has support for native floating point and integer datatypes, some +While JSON has support for native floating point and integer data types, some applications or languages may sometimes render numbers as strings. Usually the correct solution is to map these fields explicitly, but numeric detection (which is disabled by default) can be enabled to do this automatically: diff --git a/docs/reference/mapping/dynamic/templates.asciidoc b/docs/reference/mapping/dynamic/templates.asciidoc index 381fdc7bd6b..ee3ac209e83 100644 --- a/docs/reference/mapping/dynamic/templates.asciidoc +++ b/docs/reference/mapping/dynamic/templates.asciidoc @@ -4,11 +4,11 @@ Dynamic templates allow you to define custom mappings that can be applied to dynamically added fields based on: -* the <> detected by Elasticsearch, with <>. +* the <> detected by Elasticsearch, with <>. * the name of the field, with <> or <>. * the full dotted path to the field, with <>. -The original field name `{name}` and the detected datatype +The original field name `{name}` and the detected data type `{dynamic_type}` <> can be used in the mapping specification as placeholders. @@ -60,12 +60,12 @@ reordered or deleted after they were initially added. [[match-mapping-type]] ==== `match_mapping_type` -The `match_mapping_type` is the datatype detected by the JSON parser. Since +The `match_mapping_type` is the data type detected by the JSON parser. Since JSON doesn't distinguish a `long` from an `integer` or a `double` from -a `float`, it will always choose the wider datatype, i.e. `long` for integers +a `float`, it will always choose the wider data type, i.e. `long` for integers and `double` for floating-point numbers. -The following datatypes may be automatically detected: +The following data types may be automatically detected: - `boolean` when `true` or `false` are encountered. - `date` when <> is enabled and a string matching @@ -75,7 +75,7 @@ The following datatypes may be automatically detected: - `object` for objects, also called hashes. - `string` for character strings. -`*` may also be used in order to match all datatypes. +`*` may also be used in order to match all data types. For example, if we wanted to map all integer fields as `integer` instead of `long`, and all `string` fields as both `text` and `keyword`, we diff --git a/docs/reference/mapping/params.asciidoc b/docs/reference/mapping/params.asciidoc index f4a65aa111d..f8a039cce24 100644 --- a/docs/reference/mapping/params.asciidoc +++ b/docs/reference/mapping/params.asciidoc @@ -5,7 +5,7 @@ The following pages provide detailed explanations of the various mapping parameters that are used by <>: -The following mapping parameters are common to some or all field datatypes: +The following mapping parameters are common to some or all field data types: * <> * <> diff --git a/docs/reference/mapping/params/coerce.asciidoc b/docs/reference/mapping/params/coerce.asciidoc index a8176336a2a..bb04e65be3c 100644 --- a/docs/reference/mapping/params/coerce.asciidoc +++ b/docs/reference/mapping/params/coerce.asciidoc @@ -7,7 +7,7 @@ be rendered as a string, e.g. `"5"`. Alternatively, a number that should be an integer might instead be rendered as a floating point, e.g. `5.0`, or even `"5.0"`. -Coercion attempts to clean up dirty values to fit the datatype of a field. +Coercion attempts to clean up dirty values to fit the data type of a field. For instance: * Strings will be coerced to numbers. diff --git a/docs/reference/mapping/params/ignore-malformed.asciidoc b/docs/reference/mapping/params/ignore-malformed.asciidoc index ab0869bd558..2ce2eceb14c 100644 --- a/docs/reference/mapping/params/ignore-malformed.asciidoc +++ b/docs/reference/mapping/params/ignore-malformed.asciidoc @@ -5,7 +5,7 @@ Sometimes you don't have much control over the data that you receive. One user may send a `login` field that is a <>, and another sends a `login` field that is an email address. -Trying to index the wrong datatype into a field throws an exception by +Trying to index the wrong data type into a field throws an exception by default, and rejects the whole document. The `ignore_malformed` parameter, if set to `true`, allows the exception to be ignored. The malformed field is not indexed, but other fields in the document are processed normally. @@ -100,15 +100,15 @@ have malformed fields by using `exists`,`term` or `terms` queries on the special [[json-object-limits]] ==== Limits for JSON Objects -You can't use `ignore_malformed` with the following datatypes: +You can't use `ignore_malformed` with the following data types: -* <> -* <> -* <> +* <> +* <> +* <> You also can't use `ignore_malformed` to ignore JSON objects submitted to fields -of the wrong datatype. A JSON object is any data surrounded by curly brackets -`"{}"` and includes data mapped to the nested, object, and range datatypes. +of the wrong data type. A JSON object is any data surrounded by curly brackets +`"{}"` and includes data mapped to the nested, object, and range data types. If you submit a JSON object to an unsupported field, {es} will return an error and reject the entire document regardless of the `ignore_malformed` setting. diff --git a/docs/reference/mapping/params/index-options.asciidoc b/docs/reference/mapping/params/index-options.asciidoc index 8dc48b46e5b..29c876ae00f 100644 --- a/docs/reference/mapping/params/index-options.asciidoc +++ b/docs/reference/mapping/params/index-options.asciidoc @@ -7,7 +7,7 @@ inverted index for search and highlighting purposes. [WARNING] ==== The `index_options` parameter is intended for use with <> fields -only. Avoid using `index_options` with other field datatypes. +only. Avoid using `index_options` with other field data types. ==== It accepts the following values: diff --git a/docs/reference/mapping/params/null-value.asciidoc b/docs/reference/mapping/params/null-value.asciidoc index 46a13ec1ef2..13a6e268f41 100644 --- a/docs/reference/mapping/params/null-value.asciidoc +++ b/docs/reference/mapping/params/null-value.asciidoc @@ -46,7 +46,7 @@ GET my_index/_search <2> An empty array does not contain an explicit `null`, and so won't be replaced with the `null_value`. <3> A query for `NULL` returns document 1, but not document 2. -IMPORTANT: The `null_value` needs to be the same datatype as the field. For +IMPORTANT: The `null_value` needs to be the same data type as the field. For instance, a `long` field cannot have a string `null_value`. NOTE: The `null_value` only influences how data is indexed, it doesn't modify diff --git a/docs/reference/mapping/params/properties.asciidoc b/docs/reference/mapping/params/properties.asciidoc index 44084839ddd..91aa7d3865e 100644 --- a/docs/reference/mapping/params/properties.asciidoc +++ b/docs/reference/mapping/params/properties.asciidoc @@ -3,7 +3,7 @@ Type mappings, <> and <> contain sub-fields, called `properties`. These properties may be of any -<>, including `object` and `nested`. Properties can +<>, including `object` and `nested`. Properties can be added: * explicitly by defining them when <>. diff --git a/docs/reference/mapping/types.asciidoc b/docs/reference/mapping/types.asciidoc index 86ab9dfacdc..bf4c262b81c 100644 --- a/docs/reference/mapping/types.asciidoc +++ b/docs/reference/mapping/types.asciidoc @@ -1,11 +1,12 @@ [[mapping-types]] -== Field datatypes +== Field data types -Elasticsearch supports a number of different datatypes for the fields in a +Elasticsearch supports a number of different data types for the fields in a document: [float] -=== Core datatypes +[[_core_datatypes]] +=== Core data types string:: <>, <> and <> <>:: `long`, `integer`, `short`, `byte`, `double`, `float`, `half_float`, `scaled_float` @@ -16,21 +17,21 @@ string:: <>, <> and <>:: `integer_range`, `float_range`, `long_range`, `double_range`, `date_range`, `ip_range` [float] -=== Complex datatypes +=== Complex data types <>:: `object` for single JSON objects <>:: `nested` for arrays of JSON objects [float] -=== Geo datatypes +=== Geo data types <>:: `geo_point` for lat/lon points <>:: `geo_shape` for complex shapes like polygons [float] -=== Specialised datatypes +=== Specialised data types <>:: `ip` for IPv4 and IPv6 addresses -<>:: +<>:: `completion` to provide auto-complete suggestions <>:: `token_count` to count the number of tokens in a string @@ -64,9 +65,9 @@ string:: <>, <> and <>. +same data type. See <>. [float] === Multi-fields @@ -79,7 +80,7 @@ the <>, the <> analyzer, and the <>. -This is the purpose of _multi-fields_. Most datatypes support multi-fields +This is the purpose of _multi-fields_. Most data types support multi-fields via the <> parameter. include::types/alias.asciidoc[] diff --git a/docs/reference/mapping/types/alias.asciidoc b/docs/reference/mapping/types/alias.asciidoc index 2e789bfa75a..7af33740fa3 100644 --- a/docs/reference/mapping/types/alias.asciidoc +++ b/docs/reference/mapping/types/alias.asciidoc @@ -1,5 +1,5 @@ [[alias]] -=== Alias datatype +=== Alias data type ++++ Alias ++++ diff --git a/docs/reference/mapping/types/array.asciidoc b/docs/reference/mapping/types/array.asciidoc index 822076b0565..90f87eb0710 100644 --- a/docs/reference/mapping/types/array.asciidoc +++ b/docs/reference/mapping/types/array.asciidoc @@ -1,9 +1,9 @@ [[array]] === Arrays -In Elasticsearch, there is no dedicated `array` datatype. Any field can contain +In Elasticsearch, there is no dedicated `array` data type. Any field can contain zero or more values by default, however, all values in the array must be of the -same datatype. For instance: +same data type. For instance: * an array of strings: [ `"one"`, `"two"` ] * an array of integers: [ `1`, `2` ] @@ -16,19 +16,19 @@ same datatype. For instance: Arrays of objects do not work as you would expect: you cannot query each object independently of the other objects in the array. If you need to be -able to do this then you should use the <> datatype instead -of the <> datatype. +able to do this then you should use the <> data type instead +of the <> data type. This is explained in more detail in <>. ==================================================== When adding a field dynamically, the first value in the array determines the -field `type`. All subsequent values must be of the same datatype or it must +field `type`. All subsequent values must be of the same data type or it must at least be possible to <> subsequent values to the same -datatype. +data type. -Arrays with a mixture of datatypes are _not_ supported: [ `10`, `"some string"` ] +Arrays with a mixture of data types are _not_ supported: [ `10`, `"some string"` ] An array may contain `null` values, which are either replaced by the configured <> or skipped entirely. An empty array @@ -92,7 +92,7 @@ big block of text, Lucene tokenizes the text into individual terms, and adds each term to the inverted index separately. This means that even a simple text field must be able to support multiple -values by default. When other datatypes were added, such as numbers and +values by default. When other data types were added, such as numbers and dates, they used the same data structure as strings, and so got multi-values for free. diff --git a/docs/reference/mapping/types/binary.asciidoc b/docs/reference/mapping/types/binary.asciidoc index 535438d8bdd..17b6fc89ca5 100644 --- a/docs/reference/mapping/types/binary.asciidoc +++ b/docs/reference/mapping/types/binary.asciidoc @@ -1,5 +1,5 @@ [[binary]] -=== Binary datatype +=== Binary data type ++++ Binary ++++ diff --git a/docs/reference/mapping/types/boolean.asciidoc b/docs/reference/mapping/types/boolean.asciidoc index ab8011a4c56..b3f260109c2 100644 --- a/docs/reference/mapping/types/boolean.asciidoc +++ b/docs/reference/mapping/types/boolean.asciidoc @@ -1,5 +1,5 @@ [[boolean]] -=== Boolean datatype +=== Boolean data type ++++ Boolean ++++ diff --git a/docs/reference/mapping/types/constant-keyword.asciidoc b/docs/reference/mapping/types/constant-keyword.asciidoc index d9cf204dc6d..a806735f75c 100644 --- a/docs/reference/mapping/types/constant-keyword.asciidoc +++ b/docs/reference/mapping/types/constant-keyword.asciidoc @@ -2,7 +2,7 @@ [testenv="basic"] [[constant-keyword]] -=== Constant keyword datatype +=== Constant keyword data type ++++ Constant keyword ++++ diff --git a/docs/reference/mapping/types/date.asciidoc b/docs/reference/mapping/types/date.asciidoc index 4a9474dcfeb..41af9196001 100644 --- a/docs/reference/mapping/types/date.asciidoc +++ b/docs/reference/mapping/types/date.asciidoc @@ -1,10 +1,10 @@ [[date]] -=== Date datatype +=== Date data type ++++ Date ++++ -JSON doesn't have a date datatype, so dates in Elasticsearch can either be: +JSON doesn't have a date data type, so dates in Elasticsearch can either be: * strings containing formatted dates, e.g. `"2015-01-01"` or `"2015/01/01 12:10:30"`. * a long number representing _milliseconds-since-the-epoch_. diff --git a/docs/reference/mapping/types/date_nanos.asciidoc b/docs/reference/mapping/types/date_nanos.asciidoc index 6816c6f0037..bfc9cb0935b 100644 --- a/docs/reference/mapping/types/date_nanos.asciidoc +++ b/docs/reference/mapping/types/date_nanos.asciidoc @@ -1,11 +1,11 @@ [[date_nanos]] -=== Date nanoseconds datatype +=== Date nanoseconds data type ++++ Date nanoseconds ++++ -This datatype is an addition to the `date` datatype. However there is an -important distinction between the two. The existing `date` datatype stores +This data type is an addition to the `date` data type. However there is an +important distinction between the two. The existing `date` data type stores dates in millisecond resolution. The `date_nanos` data type stores dates in nanosecond resolution, which limits its range of dates from roughly 1970 to 2262, as dates are still stored as a long representing nanoseconds diff --git a/docs/reference/mapping/types/dense-vector.asciidoc b/docs/reference/mapping/types/dense-vector.asciidoc index df3ae312fa3..dc678413552 100644 --- a/docs/reference/mapping/types/dense-vector.asciidoc +++ b/docs/reference/mapping/types/dense-vector.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="basic"] [[dense-vector]] -=== Dense vector datatype +=== Dense vector data type ++++ Dense vector ++++ diff --git a/docs/reference/mapping/types/flattened.asciidoc b/docs/reference/mapping/types/flattened.asciidoc index c50d5fe2451..02dbe0a376a 100644 --- a/docs/reference/mapping/types/flattened.asciidoc +++ b/docs/reference/mapping/types/flattened.asciidoc @@ -2,7 +2,7 @@ [testenv="basic"] [[flattened]] -=== Flattened datatype +=== Flattened data type ++++ Flattened ++++ diff --git a/docs/reference/mapping/types/geo-point.asciidoc b/docs/reference/mapping/types/geo-point.asciidoc index f109deb0ab3..0ef77f57d8c 100644 --- a/docs/reference/mapping/types/geo-point.asciidoc +++ b/docs/reference/mapping/types/geo-point.asciidoc @@ -1,5 +1,5 @@ [[geo-point]] -=== Geo-point datatype +=== Geo-point data type ++++ Geo-point ++++ diff --git a/docs/reference/mapping/types/geo-shape.asciidoc b/docs/reference/mapping/types/geo-shape.asciidoc index 274970e0668..46320bba254 100644 --- a/docs/reference/mapping/types/geo-shape.asciidoc +++ b/docs/reference/mapping/types/geo-shape.asciidoc @@ -1,10 +1,10 @@ [[geo-shape]] -=== Geo-shape datatype +=== Geo-shape data type ++++ Geo-shape ++++ -The `geo_shape` datatype facilitates the indexing of and searching +The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons. It should be used when either the data being indexed or the queries being executed contain shapes other than just points. diff --git a/docs/reference/mapping/types/histogram.asciidoc b/docs/reference/mapping/types/histogram.asciidoc index 95af2ebe475..b1c98834d12 100644 --- a/docs/reference/mapping/types/histogram.asciidoc +++ b/docs/reference/mapping/types/histogram.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="basic"] [[histogram]] -=== Histogram datatype +=== Histogram data type ++++ Histogram ++++ diff --git a/docs/reference/mapping/types/ip.asciidoc b/docs/reference/mapping/types/ip.asciidoc index 41a889915fb..4f994af17ac 100644 --- a/docs/reference/mapping/types/ip.asciidoc +++ b/docs/reference/mapping/types/ip.asciidoc @@ -1,5 +1,5 @@ [[ip]] -=== IP datatype +=== IP data type ++++ IP ++++ @@ -36,7 +36,7 @@ GET my_index/_search -------------------------------------------------- // TESTSETUP -NOTE: You can also store ip ranges in a single field using an <>. +NOTE: You can also store ip ranges in a single field using an <>. [[ip-params]] ==== Parameters for `ip` fields diff --git a/docs/reference/mapping/types/keyword.asciidoc b/docs/reference/mapping/types/keyword.asciidoc index e0ee14f99b0..f1199fea115 100644 --- a/docs/reference/mapping/types/keyword.asciidoc +++ b/docs/reference/mapping/types/keyword.asciidoc @@ -1,5 +1,5 @@ [[keyword]] -=== Keyword datatype +=== Keyword data type ++++ Keyword ++++ diff --git a/docs/reference/mapping/types/nested.asciidoc b/docs/reference/mapping/types/nested.asciidoc index 6ec31be812d..292f8511f46 100644 --- a/docs/reference/mapping/types/nested.asciidoc +++ b/docs/reference/mapping/types/nested.asciidoc @@ -1,15 +1,15 @@ [[nested]] -=== Nested datatype +=== Nested data type ++++ Nested ++++ -The `nested` type is a specialised version of the <> datatype +The `nested` type is a specialised version of the <> data type that allows arrays of objects to be indexed in a way that they can be queried independently of each other. -TIP: When ingesting key-value pairs with a large, arbitrary set of keys, you might consider modeling each key-value pair as its own nested document with `key` and `value` fields. Instead, consider using the <> datatype, which maps an entire object as a single field and allows for simple searches over its contents. -Nested documents and queries are typically expensive, so using the `flattened` datatype for this use case is a better option. +TIP: When ingesting key-value pairs with a large, arbitrary set of keys, you might consider modeling each key-value pair as its own nested document with `key` and `value` fields. Instead, consider using the <> data type, which maps an entire object as a single field and allows for simple searches over its contents. +Nested documents and queries are typically expensive, so using the `flattened` data type for this use case is a better option. [[nested-arrays-flattening-objects]] ==== How arrays of objects are flattened @@ -74,8 +74,8 @@ GET my_index/_search ==== Using `nested` fields for arrays of objects If you need to index arrays of objects and to maintain the independence of -each object in the array, use the `nested` datatype instead of the -<> datatype. +each object in the array, use the `nested` data type instead of the +<> data type. Internally, nested objects index each object in the array as a separate hidden document, meaning that each nested object can be @@ -198,7 +198,7 @@ nested object. Accepts `true` (default), `false` and `strict`. <>:: (Optional, object) The fields within the nested object, which can be of any -<>, including `nested`. New properties +<>, including `nested`. New properties may be added to an existing nested object. [[nested-include-in-parent-parm]] diff --git a/docs/reference/mapping/types/numeric.asciidoc b/docs/reference/mapping/types/numeric.asciidoc index e99869c7fe2..b51456015a3 100644 --- a/docs/reference/mapping/types/numeric.asciidoc +++ b/docs/reference/mapping/types/numeric.asciidoc @@ -1,5 +1,5 @@ [[number]] -=== Numeric datatypes +=== Numeric data types ++++ Numeric ++++ @@ -84,7 +84,7 @@ to help make a decision. .Mapping numeric identifiers ==== // tag::map-ids-as-keyword[] -Not all numeric data should be mapped as a <> field datatype. +Not all numeric data should be mapped as a <> field data type. {es} optimizes numeric fields, such as `integer` or `long`, for <> queries. However, <> fields are better for <> and other @@ -101,7 +101,7 @@ Consider mapping a numeric identifier as a `keyword` if: often faster than `term` searches on numeric fields. If you're unsure which to use, you can use a <> to map -the data as both a `keyword` _and_ a numeric datatype. +the data as both a `keyword` _and_ a numeric data type. // end::map-ids-as-keyword[] ==== diff --git a/docs/reference/mapping/types/object.asciidoc b/docs/reference/mapping/types/object.asciidoc index c865e8df6dd..6528d88ece5 100644 --- a/docs/reference/mapping/types/object.asciidoc +++ b/docs/reference/mapping/types/object.asciidoc @@ -1,5 +1,5 @@ [[object]] -=== Object datatype +=== Object data type ++++ Object ++++ @@ -93,7 +93,7 @@ The following parameters are accepted by `object` fields: <>:: The fields within the object, which can be of any - <>, including `object`. New properties + <>, including `object`. New properties may be added to an existing object. IMPORTANT: If you need to index arrays of objects instead of single objects, diff --git a/docs/reference/mapping/types/parent-join.asciidoc b/docs/reference/mapping/types/parent-join.asciidoc index 88e0c6dac4d..176df843d2c 100644 --- a/docs/reference/mapping/types/parent-join.asciidoc +++ b/docs/reference/mapping/types/parent-join.asciidoc @@ -1,10 +1,10 @@ [[parent-join]] -=== Join datatype +=== Join data type ++++ Join ++++ -The `join` datatype is a special field that creates +The `join` data type is a special field that creates parent/child relation within documents of the same index. The `relations` section defines a set of possible relations within the documents, each relation being a parent name and a child name. diff --git a/docs/reference/mapping/types/point.asciidoc b/docs/reference/mapping/types/point.asciidoc index 1a78a121b41..d26d2e83126 100644 --- a/docs/reference/mapping/types/point.asciidoc +++ b/docs/reference/mapping/types/point.asciidoc @@ -1,12 +1,12 @@ [[point]] [role="xpack"] [testenv="basic"] -=== Point datatype +=== Point data type ++++ Point ++++ -The `point` datatype facilitates the indexing of and searching +The `point` data type facilitates the indexing of and searching arbitrary `x, y` pairs that fall in a 2-dimensional planar coordinate system. diff --git a/docs/reference/mapping/types/range.asciidoc b/docs/reference/mapping/types/range.asciidoc index cc4900bbb5a..16c2dd8a112 100644 --- a/docs/reference/mapping/types/range.asciidoc +++ b/docs/reference/mapping/types/range.asciidoc @@ -1,5 +1,5 @@ [[range]] -=== Range datatypes +=== Range data types ++++ Range ++++ diff --git a/docs/reference/mapping/types/rank-feature.asciidoc b/docs/reference/mapping/types/rank-feature.asciidoc index c7cc176e997..b473e0c968d 100644 --- a/docs/reference/mapping/types/rank-feature.asciidoc +++ b/docs/reference/mapping/types/rank-feature.asciidoc @@ -1,5 +1,5 @@ [[rank-feature]] -=== Rank feature datatype +=== Rank feature data type ++++ Rank feature ++++ diff --git a/docs/reference/mapping/types/rank-features.asciidoc b/docs/reference/mapping/types/rank-features.asciidoc index 38d7dc8297e..e522b17baf1 100644 --- a/docs/reference/mapping/types/rank-features.asciidoc +++ b/docs/reference/mapping/types/rank-features.asciidoc @@ -1,5 +1,5 @@ [[rank-features]] -=== Rank features datatype +=== Rank features data type ++++ Rank features ++++ @@ -8,7 +8,7 @@ A `rank_features` field can index numeric feature vectors, so that they can later be used to boost documents in queries with a <> query. -It is analogous to the <> datatype but is better suited +It is analogous to the <> data type but is better suited when the list of features is sparse so that it wouldn't be reasonable to add one field to the mappings for each of them. diff --git a/docs/reference/mapping/types/search-as-you-type.asciidoc b/docs/reference/mapping/types/search-as-you-type.asciidoc index 12c4833e2d2..86109fb8867 100644 --- a/docs/reference/mapping/types/search-as-you-type.asciidoc +++ b/docs/reference/mapping/types/search-as-you-type.asciidoc @@ -1,5 +1,5 @@ [[search-as-you-type]] -=== Search-as-you-type datatype +=== Search-as-you-type data type ++++ Search-as-you-type ++++ @@ -181,7 +181,7 @@ More subfields enables more specific queries but increases index size. The following parameters are accepted in a mapping for the `search_as_you_type` field due to its nature as a text-like field, and behave similarly to their -behavior when configuring a field of the <> datatype. Unless +behavior when configuring a field of the <> data type. Unless otherwise noted, these options configure the root fields subfields in the same way. diff --git a/docs/reference/mapping/types/shape.asciidoc b/docs/reference/mapping/types/shape.asciidoc index abe5f2dc060..049e10228db 100644 --- a/docs/reference/mapping/types/shape.asciidoc +++ b/docs/reference/mapping/types/shape.asciidoc @@ -1,12 +1,12 @@ [[shape]] [role="xpack"] [testenv="basic"] -=== Shape datatype +=== Shape data type ++++ Shape ++++ -The `shape` datatype facilitates the indexing of and searching +The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as rectangles and polygons. It can be used to index and query geometries whose coordinates fall in a 2-dimensional planar coordinate system. diff --git a/docs/reference/mapping/types/sparse-vector.asciidoc b/docs/reference/mapping/types/sparse-vector.asciidoc index 5cb4e4b37fc..3f4bd8617f7 100644 --- a/docs/reference/mapping/types/sparse-vector.asciidoc +++ b/docs/reference/mapping/types/sparse-vector.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="basic"] [[sparse-vector]] -=== Sparse vector datatype +=== Sparse vector data type ++++ Sparse vector ++++ diff --git a/docs/reference/mapping/types/text.asciidoc b/docs/reference/mapping/types/text.asciidoc index 343135e2182..b4afd6882f4 100644 --- a/docs/reference/mapping/types/text.asciidoc +++ b/docs/reference/mapping/types/text.asciidoc @@ -1,5 +1,5 @@ [[text]] -=== Text datatype +=== Text data type ++++ Text ++++ diff --git a/docs/reference/mapping/types/token-count.asciidoc b/docs/reference/mapping/types/token-count.asciidoc index 613a960b0c6..ebaaa125430 100644 --- a/docs/reference/mapping/types/token-count.asciidoc +++ b/docs/reference/mapping/types/token-count.asciidoc @@ -1,5 +1,5 @@ [[token-count]] -=== Token count datatype +=== Token count data type ++++ Token count ++++ diff --git a/docs/reference/mapping/types/wildcard.asciidoc b/docs/reference/mapping/types/wildcard.asciidoc index 2686b1552fa..346f341c5fb 100644 --- a/docs/reference/mapping/types/wildcard.asciidoc +++ b/docs/reference/mapping/types/wildcard.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="basic"] [[wildcard]] -=== Wildcard datatype +=== Wildcard data type ++++ Wildcard ++++ diff --git a/docs/reference/ml/anomaly-detection/functions/geo.asciidoc b/docs/reference/ml/anomaly-detection/functions/geo.asciidoc index 59b42172c8b..d42b9ea12f4 100644 --- a/docs/reference/ml/anomaly-detection/functions/geo.asciidoc +++ b/docs/reference/ml/anomaly-detection/functions/geo.asciidoc @@ -71,7 +71,7 @@ For example, JSON data might contain the following transaction coordinates: // NOTCONSOLE In {es}, location data is likely to be stored in `geo_point` fields. For more -information, see {ref}/geo-point.html[Geo-point datatype]. This data type is +information, see {ref}/geo-point.html[Geo-point data type]. This data type is supported natively in {ml-features}. Specifically, {dfeed} when pulling data from a `geo_point` field, will transform the data into the appropriate `lat,lon` string format before sending to the {anomaly-job}. diff --git a/docs/reference/query-dsl/range-query.asciidoc b/docs/reference/query-dsl/range-query.asciidoc index a1906b76973..9868db5919f 100644 --- a/docs/reference/query-dsl/range-query.asciidoc +++ b/docs/reference/query-dsl/range-query.asciidoc @@ -142,7 +142,7 @@ Range queries on <> or <> files will not be ex [[ranges-on-dates]] ===== Using the `range` query with `date` fields -When the `` parameter is a <> field datatype, you can use +When the `` parameter is a <> field data type, you can use <> with the following parameters: * `gt` diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index c56aa7231f6..6954e9261bb 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -572,7 +572,7 @@ tag::mappings[] specified, this mapping can include: * Field names -* <> +* <> * <> See <>. diff --git a/docs/reference/search/search-fields.asciidoc b/docs/reference/search/search-fields.asciidoc index 1c8b60b4c22..f0d31e86594 100644 --- a/docs/reference/search/search-fields.asciidoc +++ b/docs/reference/search/search-fields.asciidoc @@ -175,7 +175,7 @@ GET /_search format for the field's returned doc values. <> support a <>. <> support a https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html[DecimalFormat - pattern]. Other field datatypes do not support the `format` parameter. + pattern]. Other field data types do not support the `format` parameter. ==== TIP: You cannot use the `docvalue_fields` parameter to retrieve doc values for diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 0f38a29c3d1..822d4d27723 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -300,7 +300,7 @@ For <>, you can specify a date <