You're viewing version 2.9 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Uppercase
The uppercase
processor converts all the text in a specific field to uppercase letters. The following is the syntax for the uppercase
processor:
{
"uppercase": {
"field": "field_name"
}
}
Configuration parameters
The following table lists the required and optional parameters for the uppercase
processor.
Name | Required | Description |
---|---|---|
field | Required | The name of the field to which the data should be appended. Supports template snippets. |
description | Optional | A brief description of the processor. |
if | Optional | A condition for running this processor. |
ignore_failure | Optional | If set to true , failures are ignored. Default is false . |
ignore_missing | Optional | Specifies whether the processor should ignore documents that do not have the specified field. Default is false . |
on_failure | Optional | A list of processors to run if the processor fails. |
tag | Optional | An identifier tag for the processor. Useful for debugging to distinguish between processors of the same type. |
target_field | Optional | The name of the field in which to store the parsed data. Default is field . By default, field is updated in place. |
Using the processor
Follow these steps to use the processor in a pipeline.
Step 1: Create a pipeline.
The following query creates a pipeline, named uppercase
, that converts the text in the field
field to uppercase:
PUT _ingest/pipeline/uppercase
{
"processors": [
{
"uppercase": {
"field": "name"
}
}
]
}
Step 2 (Optional): Test the pipeline.
It is recommended that you test your pipeline before you ingest documents.
To test the pipeline, run the following query:
POST _ingest/pipeline/uppercase/_simulate
{
"docs": [
{
"_index": "testindex1",
"_id": "1",
"_source": {
"name": "John"
}
}
]
}
Response
The following example response confirms that the pipeline is working as expected:
{
"docs": [
{
"doc": {
"_index": "testindex1",
"_id": "1",
"_source": {
"name": "JOHN"
},
"_ingest": {
"timestamp": "2023-08-28T19:54:42.289624792Z"
}
}
}
]
}
Step 3: Ingest a document.
The following query ingests a document into an index named testindex1
:
PUT testindex1/_doc/1?pipeline=uppercase
{
"name": "John"
}
Step 4 (Optional): Retrieve the document.
To retrieve the document, run the following query:
GET testindex1/_doc/1