-
Notifications
You must be signed in to change notification settings - Fork 25.5k
Add documentation for pattern_text mapping type #135856
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add documentation for pattern_text mapping type #135856
Conversation
Pinging @elastic/es-storage-engine (Team:StorageEngine) |
Pinging @elastic/core-docs (Team:Docs) |
ℹ️ Important: Docs version tagging👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version. We use applies_to tags to mark version-specific features and changes. Expand for a quick overviewWhen to use applies_to tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory) What NOT to do:❌ Don't remove or replace information that applies to an older version 🤔 Need help?
|
* [`match_only_text`](#match-only-text-field-type), a space-optimized variant of `text` that disables scoring and performs slower on queries that need positions. It is best suited for indexing log messages. | ||
* [`pattern_text`](#pattern-text-field-type), a variant of `text` with improved space efficiency when storing log messages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could use some clarification--which is better for log messages, match_only_text
or pattern_text
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, I think someone from the docs team should also take a look at this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just noticed a few things, docs wise, as I drove by, reviewing the URL preview . Let me know if anything is unclear :)
* [`text`](#text-field-type), the traditional field type for full-text content such as the body of an email or the description of a product. | ||
* [`match_only_text`](#match-only-text-field-type), a space-optimized variant of `text` that disables scoring and performs slower on queries that need positions. It is best suited for indexing log messages. | ||
* [`pattern_text`](#pattern-text-field-type), a variant of `text` with improved space efficiency when storing log messages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should consider splitting these pages up for readability, if you're game go ahead, otherwise could create an issue to do this in a follow-up. We'd need to ensure redirects are set up in /docs/redirects.yml
.
- Text family overview
text
field typematch_only_text
pattern_text
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Thanks for jumping on the page splitting @parkertimmins! I think you need something like the following redirect pattern in https://github.com/elastic/elasticsearch/blob/main/docs/redirects.yml to fix the error:
Beware the syntax can be kinda finicky :) Note: You need these because the link failures are X-links from the |
|
||
* [`text`](/reference/elasticsearch/mapping-reference/text.md), the traditional field type for full-text content such as the body of an email or the description of a product. | ||
* [`match_only_text`](/reference/elasticsearch/mapping-reference/match-only-text.md), a space-optimized variant of `text` that disables scoring and performs slower on queries that need positions. It is best suited for indexing log messages. | ||
* [`pattern_text`](/reference/elasticsearch/mapping-reference/pattern-text.md), a variant of `text` which is optimized for log messages which contain sequences that are shared between many messages. By compressing these shared sequences, `pattern_text` provides improved space efficiency relative to `match_only_text`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jordan-powers and @martijnvg What do ya'll think of this blurb? I'm having trouble coming up with a description that is succinct and described the difference between pattern_text and match_only_text.
Add docs for the
pattern_text
mapping type.Fixes #135030