Skip to content

Commit

Permalink
Add documentation for constant_keyword field type (#7235) (#7242)
Browse files Browse the repository at this point in the history
  • Loading branch information
opensearch-trigger-bot[bot] authored May 23, 2024
1 parent bf69003 commit 493f9dd
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
41 changes: 41 additions & 0 deletions _field-types/supported-field-types/constant-keyword.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
layout: default
title: Constant keyword
nav_order: 71
has_children: false
parent: String field types
grand_parent: Supported field types
---

# Constant keyword field type

A constant keyword field uses the same value for all documents in the index.

When a search request spans multiple indexes, you can filter on a constant keyword field to match documents from indexes with the given constant value but not from indexes with a different value.

## Example

The following query creates a mapping with a constant keyword field:

```json
PUT romcom_movies
{
"mappings" : {
"properties" : {
"genre" : {
"value" : "Romantic comedy"
}
}
}
}
```
{% 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 field value for all documents in the index.

1 change: 1 addition & 0 deletions _field-types/supported-field-types/string.md
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.
[`constant_keyword`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/constant-keyword/) | Similar to `keyword` but uses a single value for all documents.

0 comments on commit 493f9dd

Please sign in to comment.