Skip to content

Conversation

@jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 12, 2020

Rewrites the search_as_you_type field datatype's
max_shingle_size mapping parameter to improve clarity
and better communicate trade-offs regarding index size.

Relates to elastic/kibana#55161.

Closes #51774

@jrodewig jrodewig added >docs General docs changes :Search Foundations/Mapping Index mappings, including merging and defining field types labels Mar 12, 2020
@jrodewig jrodewig requested review from cjcenizal and sebelga March 12, 2020 13:44
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search (:Search/Mapping)

Rewrites the `search_as_you_type` field datatype's `max_shingle_size`
mapping parameter to improve clarity and better communicate trade-offs
regarding index size.

Relates to [elastic/kibana#55161][0].

[0]: elastic/kibana#55161 (comment)
Copy link
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making this change! I had one small request.

A subfield is created for each integer between `2` and this value. For example,
a value of `3` creates two subfields: `my_field._2gram` and `my_field._3gram`

More subfields enable more specific queries but increase index size.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea whether the correct grammar is "more subfields enable" or "more subfields enables", but the UI copy is already shipped, so for consistency can we change on "more subfields enables"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be plural ("enable") as "subfields" is also plural, but I can change this for consistency. Don't think it'll prevent anyone from understanding.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I raised elastic/kibana#60088 to get this fixed in UI copy. I'll update here once that's in.

Thanks again @cjcenizal!

@jrodewig jrodewig merged commit febe7af into elastic:master Mar 13, 2020
@jrodewig jrodewig deleted the docs__clarify_max_shingle_size branch March 13, 2020 08:07
jrodewig added a commit that referenced this pull request Mar 13, 2020
Rewrites the `search_as_you_type` field datatype's `max_shingle_size`
mapping parameter to improve clarity and better communicate trade-offs
regarding index size.

Relates to [elastic/kibana#55161][0].

Closes #51774.

[0]: elastic/kibana#55161 (comment)
jrodewig added a commit that referenced this pull request Mar 13, 2020
Rewrites the `search_as_you_type` field datatype's `max_shingle_size`
mapping parameter to improve clarity and better communicate trade-offs
regarding index size.

Relates to [elastic/kibana#55161][0].

Closes #51774.

[0]: elastic/kibana#55161 (comment)
@jrodewig
Copy link
Contributor Author

Backport commits

master febe7af
7.x 1e31031
7.6 0e495a3

Copy link
Contributor

@sebelga sebelga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for making the update

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes :Search Foundations/Mapping Index mappings, including merging and defining field types v7.6.3 v7.7.1 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation for "max_shingle_size" parameter

5 participants