honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reorganised docs for mapping safeguard settings

This commit is contained in:
Clinton Gormley 2016-09-22 14:57:05 +02:00
parent ab2e067ef5
commit e3b7b4f032
3 changed files with 25 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/reference/mapping.asciidoc
View File

@ -64,6 +64,29 @@ the <<analysis-standard-analyzer,`standard` analyzer>>, the
This is the purpose of _multi-fields_. Most datatypes support multi-fields This is the purpose of _multi-fields_. Most datatypes support multi-fields
via the <<multi-fields>> parameter. via the <<multi-fields>> parameter.
[[mapping-limit-settings]]
[float]
=== Settings to prevent mappings explosion
The following settings allow you to limit the number of field mappings that
can be created manually or dynamically, in order to prevent bad documents from
causing a mapping explosion:
`index.mapping.total_fields.limit`::
The maximum number of fields in an index. The default value is `1000`.
`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. The default is `20`.
`index.mapping.nested_fields.limit`::
The maximum number of `nested` fields in an index, defaults to `50`.
Indexing 1 document with 100 nested fields actually indexes 101 documents
as each nested document is indexed as a separate hidden document.
[float] [float]
== Dynamic mapping == Dynamic mapping

14
docs/reference/mapping/dynamic/field-mapping.asciidoc
View File

@ -30,20 +30,6 @@ detected. All other datatypes must be mapped explicitly.
Besides the options listed below, dynamic field mapping rules can be further Besides the options listed below, dynamic field mapping rules can be further
customised with <<dynamic-templates,`dynamic_templates`>>. customised with <<dynamic-templates,`dynamic_templates`>>.
[[mapping-limit-settings]]
==== Settings to prevent mappings explosion
Two settings allow to control mapping explosion, in order to prevent adversary
documents to create huge mappings through dynamic mappings for instance:
`index.mapping.total_fields.limit`::
The maximum number of fields in an index. The default value is `1000`.
`index.mapping.depth.limit`::
The maximum depth for a field, which is measured as the number of nested
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. The default is `20`.
[[date-detection]] [[date-detection]]
==== Date detection ==== Date detection

4
docs/reference/mapping/types/nested.asciidoc
View File

@ -205,5 +205,5 @@ phase. Instead, highlighting needs to be performed via
Indexing a document with 100 nested fields actually indexes 101 documents as each nested Indexing a document with 100 nested fields actually indexes 101 documents as each nested
document is indexed as a separate document. To safeguard against ill-defined mappings document is indexed as a separate document. To safeguard against ill-defined mappings
the number of nested fields that can be defined per index has been limited to 50. This the number of nested fields that can be defined per index has been limited to 50. See
default limit can be changed with the index setting `index.mapping.nested_fields.limit`. <<mapping-limit-settings>>.