Skip to content
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.

Sign up for GitHub

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

Add documentation for constant_keyword field type #7235

Merged
merged 7 commits into from
May 23, 2024
Merged

Add documentation for constant_keyword field type #7235

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
606e0aa
Add documentation for `constant_keyword` field type
msfroh May 23, 2024
c578319
Fix nav_order and bad copy/pasted table entry
msfroh May 23, 2024
62ab9f3
Doc review
kolchfa-aws May 23, 2024
0fa1911
Apply suggestions from code review
kolchfa-aws May 23, 2024
8a8c3df
Update _field-types/supported-field-types/string.md
kolchfa-aws May 23, 2024
85c7643
Update _field-types/supported-field-types/constant-keyword.md
kolchfa-aws May 23, 2024
c3e667d
Merge branch 'main' into constant_keyword
kolchfa-aws May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions _field-types/supported-field-types/constant-keyword.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: default
title: Constant Keyword
nav_order: 46
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh -- I probably need to change the nav_order. This was copied from keyword.md.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@msfroh Thanks so much for providing this PR! Yes, nav_order is the order the page appears in the left navigation. And redirect_from is only needed when a page has moved from another location so not needed for new pages.

has_children: false
parent: String field types
grand_parent: Supported field types
redirect_from:
- /opensearch/supported-field-types/constant-keyword/
- /field-types/constant-keyword/
---

# Constant keyword field type

A constant keyword field uses the same value for documents in the index.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"documents in the index" => "all documents in an index"?

kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved

When a search request spans multiple indices, you can filter on a constant keyword field to match documents from indices with the given constant value,

Check failure on line 17 in _field-types/supported-field-types/constant-keyword.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.

Raw Output:
{"message": "[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.", "location": {"path": "_field-types/supported-field-types/constant-keyword.md", "range": {"start": {"line": 17, "column": 38}}}, "severity": "ERROR"}

Check failure on line 17 in _field-types/supported-field-types/constant-keyword.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.

Raw Output:
{"message": "[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.", "location": {"path": "_field-types/supported-field-types/constant-keyword.md", "range": {"start": {"line": 17, "column": 114}}}, "severity": "ERROR"}
but not indices with a different value.

Check failure on line 18 in _field-types/supported-field-types/constant-keyword.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.

Raw Output:
{"message": "[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.", "location": {"path": "_field-types/supported-field-types/constant-keyword.md", "range": {"start": {"line": 18, "column": 9}}}, "severity": "ERROR"}

## Example

The following query creates a mapping with a constant keyword field.
kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved

```json
PUT romcom_movies
{
"mappings" : {
"properties" : {
"genre" : {
"value" : "Romantic comedy"
}
Copy link

Choose a reason for hiding this comment

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

This example does not work. The "type" field is missing. It must look something like this:

... "genre" : { "type": "constant_keyword", "value" : "Romantic comedy" } ...

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you, @mrpi! Corrected the example in #7256

}
}
}
```
{% include copy-curl.html %}

## Parameters

The following table lists the parameters accepted by constant keyword field types. All values are required.

Parameter | Description
:--- | :---
`value` | The string value for the field for all documents in the index.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"string value for the field" => "field string value"?

kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved

1 change: 1 addition & 0 deletions _field-types/supported-field-types/string.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ Field data type | Description
[`text`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/text/) | A string that is analyzed. Useful for full-text search.
[`match_only_text`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/match-only-text/) | A space-optimized version of a `text` field.
[`token_count`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/token-count/) | Counts the number of tokens in a string.
[`token_count`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/constant-keyword/) | Similar to `keyword`, but uses a single value for all documents.
Loading