-
Notifications
You must be signed in to change notification settings - Fork 480
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
Close content gap for doc_values mapping parameter #8547
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Melissa Vagi <[email protected]>
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
@dhwanilpatel @bharath-techie @mgodwan We're trying to closing content gaps for the doc_value mapping parameter. Will one of you provide technical review of the content and example? Thank you. |
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
|
||
# Doc_values | ||
|
||
OpenSearch indexes most fields by default for searching. While the inverted index allows quick term-to-document lookups, doc values enable efficient document-to-term access for sorting, aggregations, and scripting. |
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.
Is this specific to keyword or any string related fields where doc values is supported ?
For numeric fields , this does not apply as inverted index / term lookups etc are not relevant.
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.
Hi @bharath-techie: Will you please make any necessary changes for technical accuracy? This isn't a topic I'm familiar with so I need some guidance from the SME. Greatly appreciated. Please also see the editor's comment below.
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.
@vagimeli Please see my comments and changes and tag me for approval when addressed. Thanks!
|
||
# Doc_values | ||
|
||
OpenSearch indexes most fields by default for searching. While the inverted index allows quick term-to-document lookups, doc values enable efficient document-to-term access for sorting, aggregations, and scripting. |
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.
"By default, OpenSearch indexes most fields so that they can be searched"? What inverted index (hasn't been mentioned)? Should "doc values" be "the doc_values
parameter"? Should "access" be "lookups" (as in the first instance)?
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.
@bowenlan-amzn Will you provide insight to the above questions? I have little to no guidance on the feature and need developer input. Thank you.
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.
doc values is fine to me.
access can be changed to lookup.
|
||
Parameter | Description | ||
:--- | :--- | ||
`true` | Enables doc values for the field. Default is `true`. |
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.
Code font?
Parameter | Description | ||
:--- | :--- | ||
`true` | Enables doc values for the field. Default is `true`. | ||
`false` | Disables doc values for the field. |
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.
Code font?
`true` | Enables doc values for the field. Default is `true`. | ||
`false` | Disables doc values for the field. | ||
|
||
The `doc_values` parameter is not supported for text fields. |
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.
"for use in/by"?
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Description
Closes content gap.
Issues Resolved
#4293
Version
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.