-
Notifications
You must be signed in to change notification settings - Fork 25k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Add docs for runtime fields (#62653)
* First steps in docs for runtime fields. * Adding new page for runtime fields. * Adding page for runtime fields. * Adding more to the runtime fields topic. * Adding parameters and retrieval options for runtime fields. * Adding TESTSETUP for index creation. * Incorporating review feedback. * Incorporating reviewer feedback. * Adding examples for runtime fields. * Adding more context and simplifying the example. * Changing timestamp to @timestamp throughout. * Removing duplicate @timestamp field. * Expanding example to hopefully fix CI builds. * Adding skip test for result. * Adding missing callout. * Adding TESTRESPONSEs, which are currently broken. * Fixing TESTRESPONSEs. * Incorporating review feedback. * Several clarifications, better test cases, and other changes. * Adding missing callout in example. * Adding substitutions to TESTRESPONSE for shorter results shown. * Shuffling some information and adding link to script-fields. * Fixing typo. * Updates for API redesign -- will break builds. * Updating examples and including info about overriding fields. * Updating examples. * Adding info for using runtime fields in the search request. * Adding that queries against runtime fields are expensive. * Incorporating feedback from reviewers. * Minor changes from reviews. * Adding alias for test case. * Adding aliases to PUT example. * Fixing test cases, for real this time. * Updating use cases and introducing overlay throughout. * Edits, adding 'shadowing', and explaining shadowing better. * Streamlining tests and other changes. * Fix formatting in example for test. * Apply suggestions from code review * Incorporating reviewer feedback 7 Dec * Shifting structure of mapping page to fix cross links. * Revisions for shadowing, overview, and other sections. * Removing dot notation section and incorporating review changes. * Adding updated example for shadowing. * Streamlining shadowing example and TESTRESPONSEs.
- Loading branch information
Adam Locke
authored
Dec 9, 2020
1 parent
ddf1f4c
commit bce1081
Showing
6 changed files
with
742 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
Oops, something went wrong.