28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
|
---
|
||
|
|
layout: default
|
||
|
|
title: split_string
|
||
|
|
parent: Processors
|
||
|
|
grand_parent: Configuring Data Prepper
|
||
|
|
nav_order: 45
|
||
|
|
---
|
||
|
|
|
||
|
|
# split_string
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
Splits a field into an array using a delimiter character. `split_string` is part of [mutate string](https://github.com/opensearch-project/data-prepper/tree/main/data-prepper-plugins/mutate-string-processors#mutate-string-processors) processors.
|
||
|
|
|
||
|
|
Option | Required | Type | Description
|
||
|
|
:--- | :--- | :--- | :---
|
||
|
|
entries | Yes | List | List of entries. Valid values are `source`, `delimiter`, and `delimiter_regex`.
|
||
|
|
source | N/A | N/A | The key to split.
|
||
|
|
delimiter | No | N/A | The separator character responsible for the split. Cannot be defined at the same time as `delimiter_regex`. At least `delimiter` or `delimiter_regex` must be defined.
|
||
|
|
delimiter_regex | No | N/A | The regex string responsible for the split. Cannot be defined at the same time as `delimiter`. At least `delimiter` or `delimiter_regex` must be defined.
|
||
|
|
|
||
|
|
<!---## Configuration
|
||
|
|
|
||
|
|
Content will be added to this section.
|
||
|
|
|
||
|
|
## Metrics
|
||
|
|
|
||
|
|
Content will be added to this section.--->
|