Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
1eebe84
First steps in docs for runtime fields.
Sep 14, 2020
e1c0427
Adding new page for runtime fields.
Sep 14, 2020
47bb110
Adding page for runtime fields.
Sep 15, 2020
0c97b92
Adding more to the runtime fields topic.
Sep 17, 2020
ee8a16f
Adding parameters and retrieval options for runtime fields.
Sep 18, 2020
f56bde0
Adding TESTSETUP for index creation.
Sep 18, 2020
bb82284
Incorporating review feedback.
Sep 21, 2020
b2cbf0a
Incorporating reviewer feedback.
Sep 22, 2020
d119cbd
Adding examples for runtime fields.
Sep 23, 2020
a287895
Adding more context and simplifying the example.
Sep 24, 2020
ce0fcdd
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Sep 28, 2020
2b533f7
Changing timestamp to @timestamp throughout.
Sep 28, 2020
d2d8551
Removing duplicate @timestamp field.
Sep 28, 2020
282a777
Expanding example to hopefully fix CI builds.
Sep 28, 2020
50a30f6
Adding skip test for result.
Sep 28, 2020
eb4c6c7
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Sep 28, 2020
f8a3d50
Adding missing callout.
Sep 28, 2020
796a10f
Merge branch 'docs__add-runtime-fields' of github.com:lockewritesdocs…
Sep 28, 2020
301abd1
Adding TESTRESPONSEs, which are currently broken.
Sep 28, 2020
62a5393
Fixing TESTRESPONSEs.
Sep 29, 2020
36c9244
Incorporating review feedback.
Sep 29, 2020
804f10f
Several clarifications, better test cases, and other changes.
Sep 30, 2020
875713c
Adding missing callout in example.
Oct 1, 2020
54d529a
Adding substitutions to TESTRESPONSE for shorter results shown.
Oct 1, 2020
7c1a7e0
Shuffling some information and adding link to script-fields.
Oct 26, 2020
d3f3e4b
Fixing typo.
Oct 26, 2020
3fe1541
Updates for API redesign -- will break builds.
Oct 30, 2020
2d158de
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Nov 19, 2020
6d495f0
Updating examples and including info about overriding fields.
Nov 23, 2020
e00f80f
Updating examples.
Nov 24, 2020
c631ce9
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Nov 24, 2020
8824bea
Adding info for using runtime fields in the search request.
Nov 24, 2020
282c261
Merge branch 'docs__add-runtime-fields' of github.com:lockewritesdocs…
Nov 24, 2020
72cf354
Adding that queries against runtime fields are expensive.
Nov 25, 2020
35d7b6a
Incorporating feedback from reviewers.
Nov 30, 2020
4cd5b20
Minor changes from reviews.
Dec 1, 2020
a2be37b
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Dec 1, 2020
99b2720
Adding alias for test case.
Dec 1, 2020
43dd29d
Adding aliases to PUT example.
Dec 1, 2020
994b1c2
Fixing test cases, for real this time.
Dec 1, 2020
38194b2
Updating use cases and introducing overlay throughout.
Dec 1, 2020
70a82e8
Edits, adding 'shadowing', and explaining shadowing better.
Dec 2, 2020
c27ce4c
Streamlining tests and other changes.
Dec 3, 2020
d9a9271
Fix formatting in example for test.
Dec 3, 2020
4d5452d
Apply suggestions from code review
Dec 7, 2020
8175917
Incorporating reviewer feedback 7 Dec
Dec 7, 2020
4e7b0b8
Merge branch 'master' into docs__add-runtime-fields
elasticmachine Dec 8, 2020
b732ae2
Shifting structure of mapping page to fix cross links.
Dec 8, 2020
1ea874f
Merge branch 'docs__add-runtime-fields' of github.com:lockewritesdocs…
Dec 8, 2020
8870aab
Revisions for shadowing, overview, and other sections.
Dec 8, 2020
1475e9d
Removing dot notation section and incorporating review changes.
Dec 9, 2020
06241b7
Adding updated example for shadowing.
Dec 9, 2020
c1b61ee
Streamlining shadowing example and TESTRESPONSEs.
Dec 9, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 25 additions & 55 deletions docs/reference/mapping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ are stored and indexed. For instance, use mappings to define:
* custom rules to control the mapping for
<<dynamic-mapping,dynamically added fields>>.

A mapping definition has:
A mapping definition includes metadata fields and fields:

<<mapping-fields,Metadata fields>>::

Expand All @@ -30,68 +30,34 @@ document. Each field has its own <<mapping-types, data type>>.
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name.
For more details, please see <<removal-of-types>>.

[[mapping-limit-settings]]
[discrete]
=== Settings to prevent mappings explosion

Defining too many fields in an index can lead to a
mapping explosion, which can cause out of memory errors and difficult
situations to recover from.
[[mapping-limit-settings]]
== Settings to prevent mapping explosion
Defining too many fields in an index can lead to a mapping explosion, which can
cause out of memory errors and difficult situations to recover from.

Consider a situation where every new document inserted
introduces new fields, such as with <<dynamic-mapping,dynamic mapping>>.
Each new field is added to the index mapping, which can become a
problem as the mapping grows.

Use the following settings to limit the number of field mappings (created manually or dynamically) and prevent documents from causing a mapping explosion:

`index.mapping.total_fields.limit`::
The maximum number of fields in an index. Field and object mappings, as well as
field aliases count towards this limit. The default value is `1000`.
+
[IMPORTANT]
====
The limit is in place to prevent mappings and searches from becoming too
large. Higher values can lead to performance degradations and memory issues,
especially in clusters with a high load or few resources.

If you increase this setting, we recommend you also increase the
<<search-settings,`indices.query.bool.max_clause_count`>> setting, which
limits the maximum number of <<query-dsl-bool-query,boolean clauses>> in a query.
====
+
[TIP]
====
If your field mappings contain a large, arbitrary set of keys, consider using the <<flattened,flattened>> data type.
====

`index.mapping.depth.limit`::
The maximum depth for a field, which is measured as the number of inner
objects. For instance, if all fields are defined at the root object level,
then the depth is `1`. If there is one object mapping, then the depth is
`2`, etc. Default is `20`.

// tag::nested-fields-limit[]
`index.mapping.nested_fields.limit`::
The maximum number of distinct `nested` mappings in an index. The `nested` type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting
limits the number of unique `nested` types per index. Default is `50`.
// end::nested-fields-limit[]

// tag::nested-objects-limit[]
`index.mapping.nested_objects.limit`::
The maximum number of nested JSON objects that a single document can contain across all
`nested` types. This limit helps to prevent out of memory errors when a document contains too many nested
objects. Default is `10000`.
// end::nested-objects-limit[]

`index.mapping.field_name_length.limit`::
Setting for the maximum length of a field name. This setting isn't really something that addresses
mappings explosion but might still be useful if you want to limit the field length.
It usually shouldn't be necessary to set this setting. The default is okay
unless a user starts to add a huge number of fields with really long names. Default is
`Long.MAX_VALUE` (no limit).
Use the <<mapping-settings-limit,mapping limit settings>> to limit the number
of field mappings (created manually or dynamically) and prevent documents from
causing a mapping explosion.

[discrete]
[[runtime-fields]]
== Runtime fields
Typically, you index data into {es} to promote faster search. However, indexing
can be slow and requires more disk space, and you have to reindex your data to
add fields to existing documents.

<<runtime,Runtime fields>> are not indexed, which saves disk space and makes
data ingest faster. You can add runtime fields to existing documents without
reindexing your data and calculate field values dynamically at search time.

[discrete]
[[dynamic-mapping-intro]]
== Dynamic mapping

Fields and mapping types do not need to be defined before being used. Thanks
Expand All @@ -114,7 +80,7 @@ You can create field mappings when you <<create-mapping,create an index>> and

[discrete]
[[create-mapping]]
== Create an index with an explicit mapping
=== Create an index with an explicit mapping

You can use the <<indices-create-index,create index>> API to create a new index
with an explicit mapping.
Expand Down Expand Up @@ -255,8 +221,12 @@ The API returns the following response:

include::mapping/removal_of_types.asciidoc[]

include::mapping/mapping-settings-limit.asciidoc[]

include::mapping/types.asciidoc[]

include::mapping/runtime.asciidoc[]

include::mapping/fields.asciidoc[]

include::mapping/params.asciidoc[]
Expand Down
49 changes: 49 additions & 0 deletions docs/reference/mapping/mapping-settings-limit.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
[[mapping-settings-limit]]
== Mapping limit settings
Use the following settings to limit the number of field mappings (created manually or dynamically) and prevent documents from causing a mapping explosion:

`index.mapping.total_fields.limit`::
The maximum number of fields in an index. Field and object mappings, as well as
field aliases count towards this limit. The default value is `1000`.
+
[IMPORTANT]
====
The limit is in place to prevent mappings and searches from becoming too
large. Higher values can lead to performance degradations and memory issues,
especially in clusters with a high load or few resources.

If you increase this setting, we recommend you also increase the
<<search-settings,`indices.query.bool.max_clause_count`>> setting, which
limits the maximum number of <<query-dsl-bool-query,boolean clauses>> in a query.
====
+
[TIP]
====
If your field mappings contain a large, arbitrary set of keys, consider using the <<flattened,flattened>> data type.
====

`index.mapping.depth.limit`::
The maximum depth for a field, which is measured as the number of inner
objects. For instance, if all fields are defined at the root object level,
then the depth is `1`. If there is one object mapping, then the depth is
`2`, etc. Default is `20`.

// tag::nested-fields-limit[]
`index.mapping.nested_fields.limit`::
The maximum number of distinct `nested` mappings in an index. The `nested` type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting
limits the number of unique `nested` types per index. Default is `50`.
// end::nested-fields-limit[]

// tag::nested-objects-limit[]
`index.mapping.nested_objects.limit`::
The maximum number of nested JSON objects that a single document can contain across all
`nested` types. This limit helps to prevent out of memory errors when a document contains too many nested
objects. Default is `10000`.
// end::nested-objects-limit[]

`index.mapping.field_name_length.limit`::
Setting for the maximum length of a field name. This setting isn't really something that addresses
mappings explosion but might still be useful if you want to limit the field length.
It usually shouldn't be necessary to set this setting. The default is okay
unless a user starts to add a huge number of fields with really long names. Default is
`Long.MAX_VALUE` (no limit).
Loading