Skip to content

Commit

Permalink
Close content gap for enabled mapping parameter (#8548)
Browse files Browse the repository at this point in the history
* Close content gap for enabled mapping parameters

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _field-types/mapping-parameters/enabled.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _field-types/mapping-parameters/enabled.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

---------

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
  • Loading branch information
vagimeli and natebower authored Oct 23, 2024
1 parent ae8e763 commit 91b0439
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions _field-types/mapping-parameters/enabled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: default
title: enabled
parent: Mapping parameters
grand_parent: Mapping and field types
nav_order: 40
has_children: false
has_toc: false
---

# Enabled

The `enabled` parameter allows you to control whether OpenSearch parses the contents of a field. This parameter can be applied to the top-level mapping definition and to object fields.

The `enabled` parameter accepts the following values.

Parameter | Description
:--- | :---
`true` | The field is parsed and indexed. Default is `true`.
`false` | The field is not parsed or indexed but is still retrievable from the `_source` field. When `enabled` is set to `false`, OpenSearch stores the field's value in the `_source` field but does not index or parse its contents. This can be useful for fields that you want to store but do not need to search, sort, or aggregate on.

---

## Example: Using the `enabled` parameter

In the following example request, the `session_data` field is disabled. OpenSearch stores its contents in the `_source` field but does not index or parse them:

```json
PUT my-index-002
{
"mappings": {
"properties": {
"user_id": {
"type": "keyword"
},
"last_updated": {
"type": "date"
},
"session_data": {
"type": "object",
"enabled": false
}
}
}
}
```
{% include copy-curl.html %}

0 comments on commit 91b0439

Please sign in to comment.